# getSettings
Описание: получить список настроек.
Все настройки - глобальные, т.е. применимы ко всему приложению и не зависят от авторизированного пользователя.
Пример запроса:
{ "method" : "getSettings", "requestId" : "1" }
Copied!
Пример ответа:
{ "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 }
Copied!
Описание параметров:
aecEnable
- флаг эхоподавленияagcEnable
- флаг автоматической регулировки усиленияappShowUserNameLabels
- флаг отображения надписей на видеослотеaudioCapturerLevel
- уровень захвата звука. Недоступен для изменения, если включена автоматическая регулировка усиленияaudioPlayLevel
- уровень воспроизведения звукаautoAccept
- флаг автоматического приема звонков и приглашенийautoAcceptPodiumFromOwner
- флаг приема приглашения на трибуну ввидеоселекторе
когда VideoSDK/Room приглашают на трибунуautoAllowPartToTakePodium
- флаг автоматического выхода на трибуну ввидеоселекторе
для участников когда VideoSDK/Room является владельцемbestQualityForHttpServerImages
- флаг получения картинок от http-сервера в улучшенном качествеcameraRemoteControlAccess
- поведение при входящем запросе удаленного управления камерой VideoSDK/Room. Может быть:0
- разрешить автоматически всем1
- каждый раз спрашивать разрешение2
- всегда запрещено
changeUserAuthPinAfterConf
- флаг смены пина пользователя для авторизации после каждого сеанса связиdefaultMultiConfMatrix
- раскладка по умолчанию для групповой конференции. Может быть:0
- показывать только одно окно. При этом если в списке окон больше - будет показано первое1
- все окна одинаковые2
- одно окно большое (в левом верхнем углу), остальные маленькие вокруг него3
- одно окно большое (по центру сверху), остальные маленькие снизу4
- одно окно большое (в левом углу), остальные маленькие справа от него5
- одно окно большое (по центру сверху), остальные маленькие снизу, которые могут "наползать" на него в разумных пределах7
- одно окно большое (по центру сверху) и одно маленькое слева внизу поверх большого
defaultP2PMatrix
- раскладка по-умолчанию длявидеозвонка
. Локальная настройка. Может быть:0
- показывать только одно окно. При этом если в списке окон больше - будет показано первое1
- все окна одинаковые2
- одно окно большое (в левом верхнем углу), остальные маленькие вокруг него3
- одно окно большое (по центру сверху), остальные маленькие снизу4
- одно окно большое (в левом углу), остальные маленькие справа от него5
- одно окно большое (по центру сверху), остальные маленькие снизу, которые могут "наползать" на него в разумных пределах7
- одно окно большое (по центру сверху) и одно маленькое слева внизу поверх большого
defaultOutputSelfVideoRotateAngle
- угол поворота собственного видеопотока в градусах по-умолчанию. Допустимые значения:0
,90
,180
,270
disableSelfViewOnBlind
- флаг установки сокрытия селфвью при мьюте устройства захвата видеоdisplayNameAlign
- расположение надписей в видеослоте. Может быть:1
- сверху2
- снизу
enableAutologin
- флаг, указывающий на то, нужно ли VideoSDK/Room автоматически авторизовываться при подключении к серверу если до этого уже была произведена авторизацияforbidDirectConnection
- запрет прямого соединения ввидеозвонке
highlightActiveSpeakers
- подсвечивать активно говорящих участников в раскладкеinputBandWidth
- ограничение входящего канала в кбит/с. Допустимые значения находятся в диапазоне32..20480
language
- язык интерфейса VideoSDK/Room. Может быть:"ru"
- русский"pl"
- польский"en"
- английский"es"
- испанский"pt"
- португальский
outputBandWidth
- ограничение исходящего канала в кбит/с. Допустимые значения находятся в диапазоне32..20480
qrCodeRecognition
- флаг распознавания QR кода с текущей камеры (в реальном времени) для автоматической обработкиtrueconf-ссылок
record
- настройка для разрешения записи медиа контента, передаваемого от VideoSDK/Room ввидеозвонках
игрупповых конференциях
. Может быть:0
- не разрешать записывать никому1
- всегда выдавать запрос2
- разрешено всем пользователям из адресной книги3
- всегда разрешено всем
rejectCallsNotFromAB
- флаг запрета входящих звонков от пользователей, которые не в адресной книге VideoSDK/RoomrestoreWindowWhenCall
- разворачивать окно VideoSDK/Room и выводить его на передний план во времяконференции
selfViewMirror
- флаг зеркального отображения своего видео. Применимо только на стороне VideoSDK/RoomshowCurrentUserWidget
- флаг, указывающий на необходимость отображения информации о текущем пользователе в окне VideoSDK/RoomshowIncomingRequestWidget
- флаг, указывающий на необходимость отображения виджета входящих запросов в окне VideoSDK/RoomshowInfoConnect
- флаг, указывающий на необходимость отображения виджета информации для подключения в окне VideoSDK/RoomshowInfoWidgets
- флаг, указывающий на необходимость отображения всех информационных виджетов в окне VideoSDK/RoomshowLogo
- флаг, указывающий на необходимость отображения логотипа в окне VideoSDK/RoomshowTime
- флаг, указывающий на необходимость отображения времени и даты в окне VideoSDK/RoomshowUpcomingMeetings
- флаг, указывающий на необходимость отображения информации о предстоящих конференциях в окне VideoSDK/RoomswitchToActiveSpeaker
- перенос в приоритетное окно в раскладке активно говорящего пользователяstickToDisplay
- флаг, указывающий на закрепление главного окна VideoSDK/Room за текущим мониторомrequestId
- уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесьhideNonVideoParticipants
- сокрытие видеослотов от участников, которые не отсылают видеоalwaysDisplaySelfView
- флаг расположения селфвью поверх раскладки во всех типах конференцийallowHIDControl
- флаг, указывающий на состояние функционала работы с HID-устройствами
См. также: