getSettings

Описание: получить список настроек.

Все настройки - глобальные, т.е. применимы ко всему приложению и не зависят от авторизированного пользователя.

Пример запроса:

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

Пример ответа:

{
    "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
}

Описание параметров:

• aecEnable - флаг эхоподавления

• agcEnable - флаг автоматической регулировки усиления

• appShowUserNameLabels - флаг отображения надписей на видеослоте

• audioCapturerLevel - уровень захвата звука. Недоступен для изменения, если включена автоматическая регулировка усиления

• audioPlayLevel - уровень воспроизведения звука

• autoAccept - флаг автоматического приема звонков и приглашений

• autoAcceptPodiumFromOwner - флаг приема приглашения на трибуну в видеоселекторе когда TrueConf Room приглашают на трибуну

• autoAllowPartToTakePodium - флаг автоматического выхода на трибуну в видеоселекторе для участников когда TrueConf Room является владельцем

• bestQualityForHttpServerImages - флаг получения картинок от http-сервера в улучшенном качестве

• cameraRemoteControlAccess - поведение при входящем запросе удаленного управления камерой TrueConf Room. Может быть:

  • 0 - разрешить автоматически всем

  • 1 - каждый раз спрашивать разрешение

  • 2 - всегда запрещено

• changeUserAuthPinAfterConf - флаг смены пина пользователя для авторизации после каждого сеанса связи

• defaultMultiConfMatrix - раскладка по умолчанию для групповой конференции. Может быть:

  • 0 - показывать только одно окно. При этом если в списке окон больше - будет показано первое

  • 1 - все окна одинаковые

  • 2 - одно окно большое (в левом верхнем углу), остальные маленькие вокруг него

  • 3 - одно окно большое (по центру сверху), остальные маленькие снизу

  • 4 - одно окно большое (в левом углу), остальные маленькие справа от него

  • 5 - одно окно большое (по центру сверху), остальные маленькие снизу, которые могут "наползать" на него в разумных пределах

  • 7 - одно окно большое (по центру сверху) и одно маленькое слева внизу поверх большого

• defaultP2PMatrix - раскладка по-умолчанию для видеозвонка. Может быть:

  • 0 - показывать только одно окно. При этом если в списке окон больше - будет показано первое

  • 1 - все окна одинаковые

  • 2 - одно окно большое (в левом верхнем углу), остальные маленькие вокруг него

  • 3 - одно окно большое (по центру сверху), остальные маленькие снизу

  • 4 - одно окно большое (в левом углу), остальные маленькие справа от него

  • 5 - одно окно большое (по центру сверху), остальные маленькие снизу, которые могут "наползать" на него в разумных пределах

  • 7 - одно окно большое (по центру сверху) и одно маленькое слева внизу поверх большого

• disableSleepModeWhenContent - флаг блокировки перехода в режим сна, если видеоисточник контент

• defaultOutputSelfVideoRotateAngle - угол поворота собственного видеопотока в градусах по-умолчанию. Допустимые значения: 0, 90, 180, 270

• disableSelfViewOnBlind - не отображать кадры в селфвью при программном отключении камеры

• displayNameAlign - расположение надписей в видеослоте. Может быть:

  • 1 - сверху слева

  • 2 - внизу слева

  • 3 - справа сверху

  • 4 - внизу справа

  • 5 - сверху по центру

  • 6 - внизу по центру

• enableAutoSwitchWhenContentSourceOff - флаг, указывающий на то, нужно ли менять текущее видеоустройство на предыдущее при потере источника сигнала в текущем видеоустройстве

• enableAirPlayPassword - флаг, указывающий на то, нужен ли для подключения по AirPlay ввод пароля

• enableAutologin - флаг, указывающий на то, нужно ли TrueConf Room автоматически авторизовываться при подключении к серверу если до этого уже была произведена авторизация

• forbidDirectConnection - запрет прямого соединения в видеозвонке

• framesInterval - размер отступов между видеослотами в общей раскладке

• highlightActiveSpeakers - подсвечивать активно говорящих участников в раскладке

• inputBandWidth - ограничение входящего канала в кбит/с. Допустимые значения находятся в диапазоне 32..20480

• language - язык интерфейса TrueConf Room. Может быть:

  • "ru" - русский

  • "pl" - польский

  • "en" - английский

  • "es" - испанский

  • "pt" - португальский

  • "ko" - корейский

• outputBandWidth - ограничение исходящего канала в кбит/с. Допустимые значения находятся в диапазоне 32..20480

• qrCodeRecognition - флаг распознавания QR кода с текущей камеры (в реальном времени) для автоматической обработки trueconf-ссылок

• record - настройка для разрешения записи медиа контента, передаваемого от TrueConf Room в видеозвонках и групповых конференциях. Может быть:

  • 0 - не разрешать записывать никому

  • 1 - всегда выдавать запрос

  • 2 - разрешено всем пользователям из адресной книги

  • 3 - всегда разрешено всем

• rejectCallsNotFromAB - флаг запрета входящих звонков от пользователей, которые не в адресной книге TrueConf Room

• restoreWindowWhenCall - разворачивать окно TrueConf Room и выводить его на передний план во время конференции

• selfViewMirror - флаг зеркального отображения своего видео. Применимо только на стороне TrueConf Room

• showCurrentUserWidget - флаг, указывающий на необходимость отображения информации о текущем пользователе в окне TrueConf Room

• showIncomingRequestWidget - флаг, указывающий на необходимость отображения виджета входящих запросов в окне TrueConf Room

• showInfoConnect - флаг, указывающий на необходимость отображения виджета информации для подключения в окне TrueConf Room

• showInfoWidgets - флаг, указывающий на необходимость отображения всех информационных виджетов в окне TrueConf Room

• showLogo - флаг, указывающий на необходимость отображения логотипа в окне TrueConf Room

• showTime - флаг, указывающий на необходимость отображения времени и даты в окне TrueConf Room

• showUpcomingMeetings - флаг, указывающий на необходимость отображения информации о предстоящих конференциях в окне TrueConf Room

• title - строка, содержащая наименование системы

• switchToActiveSpeaker - перенос в приоритетное окно в раскладке активно говорящего пользователя

• stickToDisplay - флаг, указывающий на закрепление главного окна TrueConf Room за текущим монитором

• requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

• hideNonVideoParticipants - сокрытие видеослотов от участников, которые не отсылают видео

• alwaysDisplaySelfView - флаг расположения селфвью поверх раскладки во всех типах конференций

• allowHIDControl - флаг, указывающий на состояние функционала работы с HID-устройствами

• audioDumpEnable - флаг, указывающий на необходимость записи дампов аудио

• useCustomVadFrameColor - флаг, который указывает на необходимость использования кастомного цвета рамки видеослота активноговорящих пользователей в раскладке. Если задан, цвет будет браться из настройки customVadFrameColor

• customVadFrameColor - кастомный цвет рамки видеослота активноговорящих пользователей в раскладке, который будет использоваться, если задана настройка useCustomVadFrameColor

• switchToSharedContent - настройка, которая автоматически задает изменение раскладки при старте показа контента (если до этого его не было) по логике, заданной в настройке sharedContentBehaviour

• sharedContentBehaviour - настройка, которая задает поведение раскладки при старте показа контента (если до этого его не было), если задана настройка switchToSharedContent. Доступные значения:

  • 0 - в большом окне приоритетной раскладки

  • 1 - одно окно, т.е. раскладка 0 - показывать только одно окно. При этом если в списке окон больше - будет показано первое

  • 2 - видеослот с контентом будет вынесен на отдельный монитор, идентификатор которого задан в настройке monitorIdForSharedContent. Если таких видеослотов с контентом несколько, на отдельном мониторе будет отображаться тот видеослот, контент которого пришел последним. Если используется перенос в приоритетное окно в раскладке активно говорящего пользователя, приоритет будет за контентом. Использование этого значения вместе с включенной настройкой switchToSharedContent блокирует возможность выполнения метода moveVideoSlotToMonitor и removeVideoSlotFromMonitor

• monitorIdForSharedContent - идентификатор монитора, на который будет вынесен видеослот с контентом

• moveActiveSpeakerToMonitor - флаг, указывающий на необходимость выноса на отдельный монитор окна с активноговорящим участником при включенном функционале переноса в приоритетное окно (switchToActiveSpeaker настройка) в раскладке активно говорящего пользователя. Монитор, куда будет выносится слот, задается настройкой monitorIdForActiveSpeaker. Если один и тот же идентификатор используется и для активноговорящего польователя, и для контента, приоритет будет за контентом

• monitorIdForActiveSpeaker - идентификатор монитора, на который будет вынесено видеоокно активноговорящего пользователя

См. также:

• setSettings
• removeVideoSlotFromMonitor
• moveVideoSlotToMonitor
• videoSlotMovedToMonitor
• settingsChanged