setSettings

Description: configure TrueConf Room API 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" : "setSettings",
    "requestId" : "1",
    "settings" : {
         "audioPlayLevel" : 0.55,
         "enableAutologin" : true
    }
}

Response example:

{
    "method" : "setSettings",
    "requestId" : "1",
    "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 automatically accepting an invitation TrueConf Room API to the podium in a moderated role-based conference

• 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 — the default layout for point-to-point video calls. It is a local setting. The following options are possible:

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

• 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 - PRO flag indicating whether to display information about the current user in the window TrueConf Room API

• showIncomingRequestWidget - PRO is a flag that indicates the need to display the incoming requests widget in the window. TrueConf Room API

• showInfoConnect - PRO flag indicating the necessity to display the connection information widget in the window. TrueConf Room API

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

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

• showTime - PRO flag indicating whether the time and date should be displayed in the window TrueConf Room API

• showUpcomingMeetings - PRO flag indicating the need 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

See also:

• getSettings
• settingsChanged