getSettings
7/5/26About 10 min
getSettings
Description
Get the list of settings
All settings are global which means that they apply to the entire application and do not depend on the authorized user
void getSettings()Response example
{
"method": "getSettings",
"requestId" : "1",
"settings": [
{
"name": "aecEnable",
"value": true
},
{
"name": "agcEnable",
"value": true
},
{
"name": "appShowUserNameLabels",
"value": true
},
{
"name": "audioCapturerLevel",
"value": 0.592157
},
{
"name": "audioPlayLevel",
"value": 1.0
},
{
"name": "autoAccept",
"value": false
},
{
"name": "autoAcceptPodiumFromOwner",
"value": false
},
{
"name": "autoAllowPartToTakePodium",
"value": false
},
{
"name": "bestQualityForHttpServerImages",
"value": false
},
{
"name": "cameraRemoteControlAccess",
"value": 1
},
{
"name": "changeUserAuthPinAfterConf",
"value": true
},
{
"name": "defaultMultiConfMatrix",
"value": 1
},
{
"name": "defaultOutputSelfVideoRotateAngle",
"value": 0
},
{
"name": "defaultP2PMatrix",
"value": 0
},
{
"name": "disableSelfViewOnBlind",
"value": true
},
{
"name": "displayNameAlign",
"value": 1
},
{
"name": "enableAutologin",
"value": true
},
{
"name": "forbidDirectConnection",
"value": false
},
{
"name": "highlightActiveSpeakers",
"value": false
},
{
"name": "inputBandWidth",
"value": 10240
},
{
"name": "language",
"value": "en"
},
{
"name": "outputBandWidth",
"value": 10240
},
{
"name": "qrCodeRecognition",
"value": false
},
{
"name": "record",
"value": 1
},
{
"name": "rejectCallsNotFromAB",
"value": false
},
{
"name": "restoreWindowWhenCall",
"value": false
},
{
"name": "selfViewMirror",
"value": true
},
{
"name": "showCurrentUserWidget",
"value": true
},
{
"name": "showIncomingRequestWidget",
"value": true
},
{
"name": "showInfoConnect",
"value": true
},
{
"name": "showInfoWidgets",
"value": true
},
{
"name": "showLogo",
"value": true
},
{
"name": "showTime",
"value": true
},
{
"name": "showUpcomingMeetings",
"value": true
},
{
"name": "title",
"value": ""
},
{
"name": "switchToActiveSpeaker",
"value": false
},
{
"name": "stickToDisplay",
"value": true
},
{
"name": "hideNonVideoParticipants",
"value": false
},
{
"name": "alwaysDisplaySelfView",
"value": false
},
{
"name": "allowHIDControl",
"value": false
}
],
"result": true
}Response Parameters
| Name | 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 VideoSDK 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 VideoSDK is the owner |
| bestQualityForHttpServerImages | The flag for receiving images from the HTTP server with enhanced quality |
| cameraRemoteControlAccess | The 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 |
| 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`. 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 |
| 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 - above • 2 - below |
| enableAutologin | The flag indicating if TrueConf VideoSDK should be automatically authorized when connecting to the server if authorization has been done perviously |
| forbidDirectConnection | Prohibit direct connection in a `video call` |
| highlightActiveSpeakers | Spotlight active speakers in the layout |
| inputBandWidth | Incoming bandwidth limit in kbps. Acceptable values range from 32 to 20480 |
| language | The 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 |
| outputBandWidth | Limitation of the outgoing bandwidth in kbit/s. Acceptable values range from 32 to 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 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 |
| rejectCallsNotFromAB | The flag indicating if it is necessary to block the calls from users who are not in the TrueConf VideoSDK address book |
| restoreWindowWhenCall | Display the TrueConf VideoSDK 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 VideoSDK |
| showCurrentUserWidget | The flag indicating if it is necessary to display information about the current user in the TrueConf VideoSDK window |
| showIncomingRequestWidget | The flag indicating if it is necessary to display the incoming request widget in the TrueConf VideoSDK window |
| showInfoConnect | The flag indicating if it is necessary to display the information widget for connecting in the TrueConf VideoSDK window |
| showInfoWidgets | The flag indicating if it is necessary to display all information widget in the TrueConf VideoSDK window |
| showLogo | The flag indicating if it is necessary to display the logo in the TrueConf VideoSDK window |
| showTime | The flag indicating if it is necessary to display date and time in the TrueConf VideoSDK window |
| showUpcomingMeetings | The flag indicating if it is necessary to display information about upcoming meetings in the TrueConf VideoSDK window |
| side | Party that has stopped a call |
| switchToActiveSpeaker | Move the active speaker to the spotlighted window in the layout |
| stickToDisplay | The flag indicating if the TrueConf VideoSDK main window should be pinned to the current display |
| hideNonVideoParticipants | Hiding video slots from participants who are not sending video |
| alwaysDisplaySelfView | The flag for positioning self-view over the video layout in all types of conferences |
| allowHIDControl | The flag indicating the status of functionality for working with HID devices |
| requestId | A unique request identifier |
| result | A flag indicating whether the request was successful |
See also