settingsChanged

Description: the notification about the changes in TrueConf Room settings.

Example:

{
    "name": "aecEnable",
    "value": true,
    "event": "settingsChanged",
    "method": "event"
}

Parameter description:

• aecEnable — the flag indicating if echo cancellation is enabled

• agcEnable— the flag indicating if automatic gain control is enabled

• appShowUserNameLabels — the flag indicating if users’ display names will be shown in the video layout

• audioCapturerLevel — the audio capture level. It is a read-only property if automatic gain control is enabled

• audioPlayLevel — Audio playback level

• autoAccept — Accept calls and invitations automatically

• autoAcceptPodiumFromOwner— the flag indicating if a TrueConf Room user can automatically accept podium invitations in a role-based conference

• autoAllowPartToTakePodium — the flag indicating if participants can automatically take the podium (without having to ask for the permission) in a role-based conference where TrueConf Room is the owner

• bestQualityForHttpServerImages — Flag for receiving images from the HTTP server with enhanced quality

• cameraRemoteControlAccess — the response to the request for the remote control of the TrueConf Room camera. The following values are possible:

  • 0 — Allow for all automatically

  • 1 — Ask permission every time

  • 2 — Always forbidden

• changeUserAuthPinAfterConf — change a user’s PIN for authorization after each conference session

• defaultMultiConfMatrix — Default layout for a group conference. It can be as follows:

  • 0 — Show only one window. If there are more windows in the list, the first one will be shown.

  • 1 — All windows are the same size.

  • 2 — One window is large (in the upper left corner), other smaller windows are placed around the large one.

  • 3 — One large window (in the center at the top), other smaller windows are placed at the bottom.

  • 4 — One window is large (in the left corner), other smaller windows are placed to the right of the large one.

  • 5 — One window is large (in the center at the top), other smaller windows are placed at the bottom and can overlap the larger one within reasonable limits.

  • 7 - one large window (centered at the top) and one small window in the bottom left corner overlaying the large one

• defaultP2PMatrix — Default layout for video calls. It can be as follows:

  • 0 — Show only one window. If there are more windows in the list, the first one will be shown.

  • 1 — All windows are the same size.

  • 2 — One window is large (in the upper left corner), other smaller windows are placed around the large one.

  • 3 — One large window (in the center at the top), other smaller windows are placed at the bottom.

  • 4 — One window is large (in the left corner), other smaller windows are placed to the right of the large one.

  • 5 — One window is large (in the center at the top), other smaller windows are placed at the bottom and can overlap the larger one within reasonable limits.

  • 7 - one large window (centered at the top) and one small window in the bottom left corner overlaying the large one

• disableSleepModeWhenContent - a flag to prevent sleep mode activation when the video source is content

• defaultOutputSelfVideoRotateAngle — the default turn angle of the self-view video (specified in degrees). The following values are possible: 0, 90, 180, 270.

• disableSelfViewOnBlind - flag for setting self-view hiding when muting the video capture device

• displayNameAlign — the location of display names in video windows. The following values are possible:

  • 1 - top left

  • 2 - bottom left

  • 3 - top right

  • 4 - bottom right

  • 5 - top center

  • 6 - bottom center

• isContinuousType — the flag indicating if the value of a property can change continuously

• enabled — Flag showing whether this feature is enabled

• enableAutologin — the flag indicating if TrueConf Room should be automatically authorized when connecting to the server if authorization has been done previously

• forbidDirectConnection — prohibit direct connection in a video call

• framesInterval - the padding size between video slots in the overall layout

• highlightActiveSpeakers — spotlight active speakers in the layout

• inputBandWidth - incoming bandwidth limit in kbps. Acceptable values range from 32..20480

• language — the UI language of TrueConf Room. The following values are possible:

  • "ru"— Russian locale

  • "pl" — Polish locale

  • "en" — English locale

  • "es" — Spanish locale

  • "pt" — Portuguese locale

  • "ko" — Korean locale

• outputBandWidth - limitation of the outgoing bandwidth in kbit/s. Acceptable values range from 32..20480

• qrCodeRecognition — the flag indicating if real-time QR code scanning is enabled for the current camera; this feature will be needed for automatic processing of trueconf links

• record — the settings allowing recording of the content shared from TrueConf Room during video calls and group conferences. The following values are possible:

  • 0 — do not allow recording to anyone

  • 1 — always request permission for recording

  • 2— allow recording to all contacts from the address book

  • 3 — allow recording to everyone

• rejectCallsNotFromAB — the flag indicating if it is necessary to block the calls from users who are not in the TrueConf Room address book

• restoreWindowWhenCall — display the TrueConf Room window in full size and show it over other windows during a conference

• selfViewMirror — the flag indicating if the self-view can be mirrored. Available only on the side of TrueConf Room

• showCurrentUserWidget — the flag indicating if it is necessary to display information about the current user in the TrueConf Room window

• showIncomingRequestWidget — the flag indicating if it is necessary to display the incoming request widget in the TrueConf Room window

• showInfoConnect — the flag indicating if it is necessary to display the information widget for connecting in the TrueConf Room window

• showInfoWidgets — the flag indicating if it is necessary to display all information widget in the TrueConf Room window

• showLogo — the flag indicating if it is necessary to display the logo in the TrueConf Room window

• showTime— the flag indicating if it is necessary to display date and time in the TrueConf Room window

• showUpcomingMeetings — the flag indicating if it is necessary to display information about upcoming meetings in the TrueConf Room window

• side — Party that has stopped a call. It can be as follows:

• switchToActiveSpeaker — move the active speaker to the spotlighted window in the layout

• hideNonVideoParticipants - hiding video slots from participants who are not sending video

• alwaysDisplaySelfView - flag for positioning self-view over the video layout in all types of conferences

• allowHIDControl - a flag indicating the status of functionality for working with HID devices

• audioDumpEnable - a flag indicating the need to record audio dumps

• useCustomVadFrameColor is a flag indicating the need to use a custom color for the video slot border of active speakers in the video layout. If set, the color will be taken from the customVadFrameColor setting.

• customVadFrameColor - custom frame color for the video slot of active speakers in the video layout, which will be used if the useCustomVadFrameColor setting is enabled.

• switchToSharedContent - a setting that automatically changes the video layout when content sharing starts (if it wasn't already active) based on the logic defined in the sharedContentBehaviour setting.

• sharedContentBehaviour - a setting that defines the video layout behavior when content sharing starts (if it was not previously active), provided the switchToSharedContent setting is enabled. Available values:

  • 0 - in the large window of the priority layout

  • 1 - single window, meaning layout 0 - show only one window. If there are more windows in the list, only the first one will be displayed.

  • 2 - The video slot with content will be displayed on a separate monitor, identified by the monitorIdForSharedContent setting. If there are multiple video slots with content, the one that was received last will be shown on the separate monitor. If transfer to a priority window in the active speaker’s video layout is used, content will take precedence. Using this value along with the enabled switchToSharedContent setting blocks the execution of the moveVideoSlotToMonitor and removeVideoSlotFromMonitor methods.

• peerId - identifier of the user who should be pinned

• moveActiveSpeakerToMonitor - a flag indicating the need to move the active speaker's window to a separate monitor when the switchToActiveSpeaker setting is enabled in the active speaker's video layout. The monitor to which the slot will be moved is specified by the monitorIdForActiveSpeaker setting. If the same identifier is used for both the active speaker and content, the content will be prioritized.

• switchToActiveSpeaker — move the active speaker to the spotlighted window in the layout

See also:

• getSettings
• setSettings
• removeVideoSlotFromMonitor
• moveVideoSlotToMonitor
• videoSlotMovedToMonitor