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.

Request example:

{
    "method" : "getSettings",
    "requestId" : "1"
}

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": "switchToActiveSpeaker",
            "value": false
        },
        {
            "name": "stickToDisplay",
            "value": true
        },
        {
            "name": "hideNonVideoParticipants",
            "value": false
        },
        {
            "name": "alwaysDisplaySelfView",
            "value": false
        },
        {
            "name": "allowHIDControl",
            "value": false
        }
    ],
    "result": true
}

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 VideoSDK/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 VideoSDK/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 VideoSDK/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. 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 VideoSDK/Room should be automatically authorized when connecting to the server if authorization has been done previously

• 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..20480

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

  • "ru"— Russian locale

  • "pl" — Polish locale

  • "en" — English locale

  • "es" — Spanish locale

  • "pt" — Portuguese 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 VideoSDK/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 VideoSDK/Room address book

• restoreWindowWhenCall — display the VideoSDK/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 VideoSDK/Room

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

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

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

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

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

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

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

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

• stickToDisplay — the flag indicating if the VideoSDK/Room main window should be pinned to the current display.

• requestId - a unique request identifier. You can learn more about it here.

• 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

See also:

• setSettings
• settingsChanged