On_settingsChanged

TrueConf7/5/26About 8 min

On_settingsChanged

Description

The notification about the changes in TrueConf VideoSDK settings

EventHandler<string> On_settingsChanged

Response example

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

Response Parameters

NameDescription
aecEnableThe flag indicating if echo cancellation is enabled
agcEnableThe flag indicating if automatic gain control is enabled
appShowUserNameLabelsThe flag indicating if users’ display names will be shown in the video layout
audioCapturerLevelThe audio capture level. It is a read-only property if automatic gain control is enabled
audioPlayLevelAudio playback level
autoAcceptAccept calls and invitations automatically
autoAcceptPodiumFromOwnerThe flag indicating if a TrueConf VideoSDK user can automatically accept podium invitations in a role-based conference
autoAllowPartToTakePodiumThe flag indicating if participants can automatically take the podium (without having to ask for the permission) in a role-based conference where TrueConf VideoSDK is the owner
bestQualityForHttpServerImagesFlag for receiving images from the HTTP server with enhanced quality
cameraRemoteControlAccessThe response to the request for the remote control of the TrueConf VideoSDK camera. The following values are possible:
• 0 - Allow for all automatically
• 1 - Ask permission every time
• 2 - Always forbidden
changeUserAuthPinAfterConfChange a user’s PIN for authorization after each conference session
defaultMultiConfMatrixDefault 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 place 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
defaultP2PMatrixDefault layout for video calls. Local setting. 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
defaultOutputSelfVideoRotateAnglethe default turn angle of the self-view video (specified in degrees). The following values are possible: 0, 90, 180, 270
disableSelfViewOnBlindThe flag for setting self-view hiding when muting the video capture device
displayNameAlignThe location of display names in video windows. The following values are possible:
• 1 - Above
• 2 - Below
enableAutologinThe flag indicating if TrueConf VideoSDK should be automatically authorized when connecting to the server if authorization has been done previously
forbidDirectConnectionProhibit direct connection in a video call
highlightActiveSpeakersSpotlight active speakers in the layout
inputBandWidthIncoming bandwidth limit in kbps. Acceptable values range from 32 to 20480
languageThe UI language of TrueConf VideoSDK. The following values are possible:
• "ru" - Russian locale
• "pl" - Polish locale
• "en" - English locale
• "es" - Spanish locale
• "pt" - Portuguese locale
• "ko" - Korean locale
outputBandWidthLimitation of the outgoing bandwidth in kbit/s. Acceptable values range from 32 to 20480
qrCodeRecognitionThe 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
recordThe settings allowing recording of the content shared from TrueConf VideoSDK 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
rejectCallsNotFromABThe flag indicating if it is necessary to block the calls from users who are not in the TrueConf VideoSDK address book
restoreWindowWhenCallDisplay the TrueConf VideoSDK window in full size and show it over other windows during a conference
selfViewMirrorThe flag indicating if the self-view can be mirrored. Available only on the side of TrueConf VideoSDK
showCurrentUserWidgetThe flag indicating if it is necessary to display information about the current user in the TrueConf VideoSDK window
showIncomingRequestWidgetThe flag indicating if it is necessary to display the incoming request widget in the TrueConf VideoSDK window
showInfoConnectThe flag indicating if it is necessary to display the information widget for connecting in the TrueConf VideoSDK window
showInfoWidgetsThe flag indicating if it is necessary to display all information widget in the TrueConf VideoSDK window
showLogoThe flag indicating if it is necessary to display the logo in the TrueConf VideoSDK window
showTimeThe flag indicating if it is necessary to display date and time in the TrueConf VideoSDK window
showUpcomingMeetingsThe flag indicating if it is necessary to display information about upcoming meetings in the TrueConf VideoSDK window
switchToActiveSpeakerMove the active speaker to the spotlighted window in the layout
hideNonVideoParticipantsHiding video slots from participants who are not sending video
alwaysDisplaySelfViewThe flag for positioning self-view over the video layout in all types of conferences
allowHIDControlA flag indicating the status of functionality for working with HID devices

See also

Last Updated: