Base theme and other preconfigured themes

Theme configuration

The themeconfig.json file is the theme's primary configuration file. It is a JSON dictionary that specifies the background and layout of the splash screens used when joining a conference (such as the Welcome screen and PIN entry screens), specifies which image files are used, and controls some of the features and overlays that are used within a conference. It does not control any of the audio (sound) elements of the theme.

{
    "enable_dtmf_conference_control": true,
    "dtmf_conference_control_commands": {
        "*6": "toggle_self_mute",
        "*7": "toggle_lock",
        "*5": "toggle_guest_mute",
        "*4": "toggle_pres_in_mix",
        "*9": "toggle_multiscreen",
        "*8": "cycle_layout",
        "*3": "toggle_raise_hand",
        "*1": "cycle_personal_layout",
        "##": "end_conference"
    },
    "dtmf_allowed_layouts": ["1:7", "ac", "1:21", "2:21", "2x2", "3x3", "4x4", "5x5", "1:0", "1:33"],
    "disable_ai_indicator": false,
    "disable_streaming_indicator": false,
    "disable_watermark_icon": false,
    "disable_watermark_mute_icon": true,
    "disable_conference_locked_indicator": false,
    "ai_indicator_text": "AI",
    "streaming_indicator_text": "Streaming enabled",
    "public_streaming_indicator_text": "Public streaming enabled",
    "recording_indicator_text": "Recording",
    "transcribing_indicator_text": "Transcribing",
    "live_captions_on_indicator_text": "Live captions on",
    "live_captions_off_indicator_text": "Live captions off",
    "conference_locked_indicator_text": "Conference locked",
    "conference_unlocked_indicator_text": "Conference unlocked",
    "conference_locked_indicator_n_waiting_text": "{number_of_waiting_participants} waiting for host",
    "test_call_service_media_delay": 2,
    "test_call_service_disconnect_timeout": 10,
    "theme_version": 2
}

Each object in the themeconfig.json file is described in the following table.

All of the colors in these controls are specified using RGB hexadecimal notation (in the format 0xnnnnnn).

Name	Description	Value in Base theme
enable_dtmf_conference_control	Determines whether Host participants can use DTMF to control the conference (true) or not (false).	true
dtmf_conference_control_commands	If DTMF controls are enabled, this section specifies the DTMF digits used for each control. Current controls are: toggle_self_mute (*6): toggles the mute status of the participant toggle_lock (*7): toggles the locked/unlocked state of the conference toggle_guest_mute (*5): toggles the muted/unmuted status of all Guest participants toggle_pres_in_mix (*4): toggles whether the presentation stream is sent to that endpoint in the main video mix (replacing some of the other video participants), or as a separate stream toggle_multiscreen (*9): toggles multiscreen participant display cycle_layout (*8): cycles the conference layout through the set of available layouts as defined in dtmf_allowed_layouts toggle_raise_hand (*3): toggles the raised hand status of the participant in a VMR cycle_personal_layout (*1): cycles the personal layout (only received by that requesting endpoint) through the set of available layouts as defined in dtmf_allowed_layouts end_conference (##): terminates the conference When changing the DTMF controls, you must only edit the keypad digits inside the first pair of quotes on each line (i.e. *6, *7, ## etc). Editing anything else will disable DTMF commands. If you change the *6 control for self-mute, you should also change the associated watermark_mute_icon.png graphic to reference the revised command. Note that another DTMF control command, toggle_teams_large_gallery, could be made available for endpoints that are in an interop call to a Microsoft Teams conference. This command toggles between the current layout and Microsoft's Large Gallery view. However, it is not included in the base theme and must be manually added to your custom theme and assigned some appropriate DTMF digits (such as *2). Each control must be two DTMF digits long, and all the commands must be different. Note that with calls made via the Infinity Gateway, any DTMF signals are forwarded to the other party. The only exceptions to this are interop calls to Microsoft Teams and Google Meet where DTMF controls can be used to control aspects of the layout and toggle self mute (see Configuring Pexip Infinity as a Microsoft Teams gateway and Configuring Pexip Infinity as a Google Meet gateway for more information). See Using a DTMF keypad to control a conference for guidance on best practice.	"*6": "toggle_self_mute" "*7": "toggle_lock" "*5": "toggle_guest_mute" "*4": "toggle_pres_in_mix" "*9": "toggle_multiscreen" "*8": "cycle_layout" "*3": "toggle_raise_hand" "*1": "cycle_personal_layout" "##": "end_conference"
dtmf_allowed_layouts	The set of layouts that are cycled through on each press of the cycle_layout DTMF command (*8 by default), and by the cycle_personal_layout DTMF command (*1 by default). This can also include the names of any custom layouts. The order of the layout identifiers in the list determines the cycle sequence, starting with the layout next in the list after the current layout. However, if the initial (default) layout is not in the list then: The layout that is first in the list is used in the first instance. You cannot use DTMF to return to that initial layout during the conference.	["1:7", "ac", "1:21", "2:21", "2x2", "3x3", "4x4", "5x5", "1:0", "1:33"]
disable_ai_indicator	Determines whether the Google Meet AI indicator is disabled (true) or enabled (false).	false
disable_streaming_indicator	Determines whether the streaming indicator icon is disabled (true) or enabled (false).	false
disable_watermark_icon	Determines whether the watermark icon is overlaid onto the main speaker video (false) or is not used (true). See Video watermarking for more information.	false
disable_watermark_mute_icon	Determines whether the "Your mic has been muted" watermark icon is overlaid onto the stream sent to a participant when that participant has been muted (false) or is not used (true). See Video watermarking for more information.	true
disable_conference_locked_indicator	Determines whether the conference locked and conference unlocked indicators are disabled (true) or enabled (false).	false
ai_indicator_text	The text that is associated with the AI indicator and that is temporarily displayed when Google Meet AI features are enabled.	AI
streaming_indicator_text	The text that is associated with the streaming indicator and that is temporarily displayed when a conference is being streamed.	Streaming enabled
public_streaming_indicator_text	The text that is associated with the streaming indicator and that is temporarily displayed when Google Meet public streaming is enabled.	Public streaming enabled
recording_indicator_text	The text that is associated with the recording indicator and that is temporarily displayed when a conference is being recorded.	Recording
transcribing_indicator_text	The text that is associated with the conference transcribing indicator and that is temporarily displayed when a conference is being transcribed.	Transcribing
live_captions_on_indicator_text	The text that is associated with the live captions indicator and that is temporarily displayed when captions are enabled.	Live captions on
live_captions_off_indicator_text	The text that is associated with the live captions indicator and that is temporarily displayed when captions are disabled.	Live captions off
conference_locked_indicator_text	The text that is associated with the conference locked indicator and that is temporarily displayed when a conference is locked. This has a maximum limit of 20 characters.	Conference locked
conference_unlocked_indicator_text	The text that is associated with the conference unlocked indicator and that is temporarily displayed when a conference is unlocked.	Conference unlocked
conference_locked_indicator_n_waiting_text	The text that is associated with the conference locked indicator text, and shows the number of participants waiting in the lobby in Teams CVI calls.	{number_of_waiting_participants} waiting for host
test_call_service_media_delay	The number of seconds that media is delayed before being looped back to the caller when using a Test Call Service. (For more information, see Configuring the Test Call Service.)	2
test_call_service_disconnect_timeout	The number of seconds that a user can test their media before the disconnect message is played, when using a Test Call Service.	10
theme_version	Controls whether legacy (version "1") or new style (version "2") themes are used. If "theme_version": 2 is not present in a themeconfig.json file at the lowest level of the theme file hierarchy then it is assumed to be a legacy-style theme (see How do I know which files and configuration settings will be used in a particular VMR? for more information).	2

Endpoint data (vendordata.json)

The vendordata.json file contains information about videoconferencing endpoints from different manufacturers.

It is used to determine whether a specific endpoint is a single-screen or two-screen device (unless the endpoint explicitly signals to Pexip Infinity how many screens it has). This information is used when determining if presentation content could be sent as part of the layout mix when using Adaptive Composition or the Teams-like layout, and if multiscreen participant display is supported:

• Single screen endpoints:

  • Presentation content may be sent as part of the layout mix, or as a separate presentation stream.
  • Multiscreen participant display is not available.

• Dual screen endpoints:

  • Presentation content is always sent as a separate presentation stream.

  • Multiscreen participant display is available for the supported layouts.

    For H.323 endpoints, the vendordata.json file cannot identify the number of screens (single or dual) and the endpoint cannot explicitly signal how many screens it has, thus they cannot use multiscreen participant display by default. Multiscreen participant display can only be enabled by sending a *9 (toggle to multiscreen) DTMF command to the conference. See Using a DTMF keypad to control a conference and Determining if an endpoint has single or multiple screens for more information.

See Receiving the presentation stream as part of the layout mix (Adaptive Composition) and Multiscreen participant display for more information.

It is also used for Google Meet audio denoising interoperability to configure a list of endpoints that perform their own in-built denoising. See Configuring Pexip Infinity as a Google Meet gateway for more information.

The default vendordata.json file is shown below:

{
    "endpoints_by_display_count": {
        "1": [
            "Cisco-Board",
            "Cisco-DX",
            "Cisco-Desk",
            "Cisco-EX60",
            "Cisco-EX90",
            "Cisco-MX200",
            "Cisco-MX300",
            "Cisco-RoomKitMini",
            "Cisco-SX10",
            "TANDBERG/257",
            "Yealink VC200",
            "PolycomRealPresenceTrio",
            "PolycomStudioX30",
            "Polycom (HDX 4000",
            "Polycom (HDX 4500",
            "Polycom (HDX 6000"
        ],
        "2": []
    },
    "built_in_denoising": [
    ]
}

The JSON dictionary in the file contains:

• An endpoints_by_display_count object, which contains two further objects:

  • "1": this contains an array of names of single screen endpoints (the absence of a closing bracket for the HDX device names is deliberate).
  • "2": this contains an array of names of dual screen endpoints (this array is empty by default).
• A built_in_denoising object that contains an array (empty by default) of endpoints that perform their own built-in audio denoising. This information is currently used for Google Meet interoperability only.

The endpoint names used in the arrays are those that are contained in the user agent string used by the endpoint, and can be seen in the Vendor field when viewing participant status information.

Pexip intends to maintain and update this file as appropriate in future software versions, however you may amend the contents of the arrays and provide your own vendordata.json file as part of a custom theme upload and then apply that theme to your platform, VMRs or rules in the normal way to override the default behavior. Ensure that you do not break the syntax of the JSON file; when adding endpoints to the empty arrays follow the format of the existing "1" (single screen endpoints) object.

Audio files

The following table lists the default audio files and their content, which is contained within the Base theme:

Image files

Background image files (JPG)

Three full-size background JPG image files are used — two (which are just plain dark screens) for the Test Call Service and participant pinning, and one (headland) for all other cases. Other SVG images and text that are specified in other theme files is overlaid onto these screens according to any layout requirements that have been added to the themeconfig.json file, and the type and status of the call.

File name	Image size (width, height)	Content in Base theme	Notes
background.jpg	1920 x 1080 pixels JPG (RGB mode only)		The background image used by default on all splash screens except for those used by the Test Call Service.
background_test_call.jpg	1920 x 1080 pixels JPG (RGB mode only)		The background image (a dark screen) used by default on the Test Call Service splash screens.
background_reserved_slot.jpg	1920 x 1080 pixels JPG (RGB mode only)		The background image (a black screen) used by default on the reserved_slot splash screen when using participant pinning.

Splash screens

The following table lists the splash screens that you can configure within a theme, and when that screen is shown. It also identifies the screen key to use in a screens object if you want to override the default behavior, and any default icon image and text label elements used on that screen.

All of the screens used when joining a conference use background.jpg as the default background image. The Test Call Service uses background_test_call.jpg during the call.

Overlay SVG image files

All of the overlay vector images in the Base theme are listed below. All of the images shown in the table below are white, except for icon_inactive_page.svg, and are shown here against a gray background. The table also lists any splash screens on which the overlay images are used by default.

File name	Content in Base theme	Associated default splash screens
icon_active_page.svg		test_call_welcome test_call_in_progress test_call_complete (they are rendered as the progress dots along the bottom of the screen)
icon_inactive_page.svg		test_call_welcome test_call_in_progress test_call_complete (they are rendered as the progress dots along the bottom of the screen)
icon_pin_entry.svg		pin_welcome pin_entry
icon_pin_entry_digit.svg		pin_entry
icon_pin_invalid.svg		pin_invalid
icon_reserved_slot.svg		reserved_slot
icon_welcome.svg		pin_correct (also previously used on welcome screen)

The following SVG image files are also included by default in the Base theme but they all contain blank/empty images. In version 36 and earlier they contained images and appeared on various splash screens. From version 37 these SVG files are still referenced by the nominated splash screens for backwards compatibility, but as they are blank by default they do not affect each screen's appearance (the screen only shows the associated background image and any text label). However, if you customize any of these files to include graphical content it will appear on the associated screen.

• icon_waiting_for_host.svg (referenced by the waiting_for_host screen)
• icon_virtual_reception_welcome.svg (referenced by the virtual_reception_welcome screen)
• icon_virtual_reception_connecting.svg (referenced by the virtual_reception_connecting screen)
• icon_virtual_reception_conference_id_invalid.svg (referenced by the virtual_reception_conference_id_invalid screen)
• icon_virtual_reception_conference_id_entry.svg (referenced by the virtual_reception_conference_id_entry screen)
• icon_timeout.svg (referenced by the timeout screen)
• icon_other_participants_audio_only.svg (referenced by the other_participants_audio_only screen)
• icon_error_insufficient_video_licenses.svg (referenced by the error_insufficient_video_licenses screen)
• icon_error.svg (referenced by the error_capacity_exceeded, error_insufficient_licenses and error_invalid_license screens)
• icon_is_in_lobby.svg (referenced by the inlobby screen)
• icon_connecting.svg (referenced by the connecting and inlobby_status_unknown screens)
• icon_streaming_screen.svg (referenced by the streaming_in_progress and stream_waiting screens)

If you want to reinstate the previous graphical images on the splash screens, the SVG icon files used in the previous versions of the default theme (with the original image content) are available for download at theme-svg-files.zip and can be included in a custom theme. Full information on the previous appearance and use of these files and splash screens is contained in our version 36 documentation.

Overlay SVG image files used by the Test Call Service

These overlay SVG image files are used only by the Test Call Service:

File name	Content in Base theme	Associated default splash screens
icon_test_call_complete.svg		test_call_complete
icon_test_call_welcome.svg		test_call_welcome

Indicator graphics used within an ongoing conference

The following graphics may be used during a conference. The SVG indicators are rendered on top of a dark gray background (the color is 0x7f323232, where 7f is the alpha channel which makes the background slightly transparent). The gray background is not part of the actual SVG image itself and it cannot be customized. If you use your own customized SVG images, ensure that they look appropriate when displayed on sizes from 20x20px to 48x48px, and are recognizable when displayed as 12x12px for participants that use very low resolutions.

If you are using a theme to customize gateway calls only, then you only need to consider a subset of these images, as indicated in the table below.

File name	Content in Base theme	Notes	Used in gateway calls
icon_no_presentation.svg		Used to indicate that there is currently no presentation stream. It is used by default on the no_presentation splash screen.
icon_no_video.svg		Shown when a video stream is not available. It is used by default on the no_main_video and no_incoming_video splash screens. It should look appropriate when displayed at sizes up to 400 x 400 pixels.
Various icon_notch57tp_<item>.svg files	<various>	These icon images are used to support the in-conference indicators, such as participant counts, audio participants, recording indicators and locked status that are shown at the top-center of the layout. We recommend that you do not customize these elements as we cannot guarantee compatibility with future versions of Pexip Infinity.
presence_avatar_image.jpg		Shown next to the conference alias when using legacy Pexip apps, and as the contact avatar when using Skype for Business. When the image is used, the corners are cropped so that it can be displayed as a round image. It is a JPG image (RGB mode only) and should be 128 x 128 pixels.
no_powerpoint_live.jpg		Used in Microsoft Teams interop calls to indicate that a Teams client is performing PowerPoint Live sharing, or is using any other non-supported content share sources, such as Excel or Whiteboard.	Only applies to gateway calls into Microsoft Teams meetings.
raise_hand.png		Used in the Teams-like layout to indicate that a participant in the Teams conference has raised their hand. This image only applies to Teams integrations, and it should not be customized.	Only applies to gateway calls into Microsoft Teams meetings.
watermark_icon.png		Transparent image used for applying a watermark to the main speaker video in a conference. The default image is a white Pexip logo with 40% transparency and is shown here against a blue background. It is a PNG image and should be 200 pixels wide x 100 pixels high. See Video watermarking for more information.
watermark_footer_icon.png		A watermark that is only used in the 1 + 33 layout (it appears at the bottom of the layout). It is the same size as the standard watermark_icon.png file, but it has inverted colors (so that it shows up on the white background of the layout).
watermark_mute_icon.png		An overlay that is displayed to a participant when they have been administratively muted. It is shown under the conference indicators whenever the participant has been muted. It is a PNG image and should be 200 pixels wide x 100 pixels high. Note that: This overlay is disabled by default, and is controlled by the disable_watermark_mute_icon setting in the themeconfig.json file. It is not always appropriate in all call scenarios to state that the user can unmute themself in this way, such as when the user has dialed in over WebRTC, or for Guest participants in a VMR where all Guests have been muted.
‡ Only applies to gateway calls into Microsoft Teams meetings.