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": "disableSleepModeWhenContent",
            "value": true
        },
        {
            "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
        },
        {
            "name": "audioDumpEnable",
            "value": false
        },
        {
            "name": "framesInterval",
            "value": 0
        },
        {
            "name": "useCustomVadFrameColor",
            "value": true
        },
        {
            "name": "customVadFrameColor",
            "value": "#999999"
        },
        {
            "name": "switchToSharedContent",
            "value": false
        },
        {
            "name": "sharedContentBehaviour",
            "value": 2
        },
        {
            "name": "monitorIdForSharedContent",
            "value": "display\\sam0a7d\\3&50760dd&1&uid256"
        },
        {
            "name": "enableAirPlayPassword",
            "value": true
        }
        {
            "name": "enableAutoSwitchWhenContentSourceOff",
            "value": false
        },
        {
            "name": "moveActiveSpeakerToMonitor",
            "value": true
        },
        {
            "name": "monitorIdForActiveSpeaker",
            "value": "display\\sam0a7d\\3&50760dd&1&uid256"
        }
    ],
    "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 - flag for accepting podium invitations in a moderated role-based conference when TrueConf Room API invites you to the podium

• autoAllowPartToTakePodium - flag for automatic podium taking in a smart meeting for participants when TrueConf Room API is the owner

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

• cameraRemoteControlAccess - behavior upon an incoming remote camera control request TrueConf Room API. It can be:

  • 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 a video call. It can be:

  • 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 that prevents entering sleep mode 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

• enableAutoSwitchWhenContentSourceOff - a flag indicating whether to switch back to the previous video device when the signal source is lost in the current video device.

• enableAirPlayPassword - a flag indicating whether a password is required for AirPlay connection

• enableAutologin - a flag indicating whether to automatically log in when connecting to the server if authorization has already been performed previously.

• forbidDirectConnection — prohibit direct connection in a video call

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

• highlightActiveSpeakers — spotlight active speakers in the layout

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

• language - the interface language TrueConf Room API. Options include:

  • "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 - a setting to allow the recording of media content transmitted from TrueConf Room API during video calls and group conferences. It can be:

  • 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 - a flag to block incoming calls from users not in the address book TrueConf Room API

• restoreWindowWhenCall - expand the TrueConf Room API window and bring it to the foreground during a conference.

• selfViewMirror - a flag for mirroring your own video. Applicable only on the client-side. TrueConf Room API

• showCurrentUserWidget - a flag indicating the need to display information about the current user in the window TrueConf Room API

• showIncomingRequestWidget - a flag indicating the need to display the incoming requests widget in the window TrueConf Room API

• showInfoConnect - a flag indicating the need to display the connection information widget in the window TrueConf Room API

• showInfoWidgets - a flag indicating the need to display all information widgets in the window TrueConf Room API

• showLogo - a flag indicating whether the logo should be displayed in the window TrueConf Room API

• showTime - a flag indicating the need to display time and date in the window TrueConf Room API

• showUpcomingMeetings - a flag indicating the necessity to display information about upcoming conferences in the window TrueConf Room API

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

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

• stickToDisplay - a flag indicating that the main window of TrueConf Room API is pinned to the current monitor.

• requestId - a unique request identifier. You can find more details 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

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

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

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

• switchToSharedContent is a setting that automatically changes the video layout when content sharing starts (if it wasn't already active), following the logic specified in the sharedContentBehaviour setting.

• sharedContentBehaviour - a setting that defines the video layout behavior when content sharing starts (if it wasn't already active), provided the switchToSharedContent setting is configured. Available values:

  • 0 - in the large window of the priority layout

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

  • 2 - the video slot with content will be moved to a separate monitor, the identifier of which is specified in the monitorIdForSharedContent setting. If there are multiple video slots with content, the slot whose content arrived last will be displayed on the separate monitor. When using the prioritized window in the active speaker video layout, the content will take precedence. Using this value together with the enabled switchToSharedContent setting prevents the execution of the moveVideoSlotToMonitor and removeVideoSlotFromMonitor methods.

• monitorIdForSharedContent - the identifier of the monitor where the video slot with content will be displayed

• moveActiveSpeakerToMonitor - a flag indicating the necessity to move the active speaker's window to a separate monitor when the active speaker highlight function (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 the content, the content will take priority.

• monitorIdForActiveSpeaker - the ID of the monitor where the video window of the active speaker will be displayed

See also:

• setSettings
• removeVideoSlotFromMonitor
• moveVideoSlotToMonitor
• videoSlotMovedToMonitor
• settingsChanged