Get-параметры для управления web-клиентом: различия между версиями

Материал из База знаний VINTEO
 
(не показаны 24 промежуточные версии 2 участников)
Строка 13: Строка 13:
 
| pin || Зашифрованный пин-код для подключения в закрытую конференцию || Строка
 
| pin || Зашифрованный пин-код для подключения в закрытую конференцию || Строка
 
|-
 
|-
| call || Звонок в конференцию при запуске веб-клиента || Да\нет
+
| call || Звонок в конференцию при запуске веб-клиента || Да/Нет
 
|-
 
|-
| lock || Блокирует изменение информации в поле номера конференции || Да\нет
+
| lock || Блокирует для изменения поле номера конференции || Да/Нет
 
|-
 
|-
 
| nocontrols || Позволяет ограничивать доступ пользователя к различным компонентам приложения || Строка
 
| nocontrols || Позволяет ограничивать доступ пользователя к различным компонентам приложения || Строка
Строка 21: Строка 21:
 
| inputchannels || Список ID входящих аудиоканалов через запятую || Строка
 
| inputchannels || Список ID входящих аудиоканалов через запятую || Строка
 
|-
 
|-
| outputchannels || Список ID исходящих аудио-каналов через запятую || Строка
+
| outputchannels || Список ID исходящих аудиоканалов через запятую || Строка
 
|-
 
|-
 
| number || Имя для авторизации || Строĸа
 
| number || Имя для авторизации || Строĸа
 
|-
 
|-
| password || Пароль для авторизации encrypted || base64
+
| password || Пароль для авторизации encrypted https://www.base64encode.org/ || base64
 +
|-
 +
| licence || Тип использованной лицензии в звонке || AUDIO AUDIOPLUSPRESENTATION
 +
|-
 +
| autoShareSecondCam || Запускает презентацию второй камеры при старте звонка || Да/Нет
 +
|-
 +
| isEnabledRemoteControlCamera || Разрешает модератору конференции включать/выключать камеру пользовател || Да/Нет
 +
|-
 +
| isEnabledRemoteControlMicrophone || Разрешает модератору конференции включать\выключать микрофон пользователя ||Да/Нет
 
|}
 
|}
  
Строка 44: Строка 52:
 
| hangup || Кнопка завершения вызова
 
| hangup || Кнопка завершения вызова
 
|-
 
|-
| mic || Кнопка включения\выключения микрофона
+
| mic || Кнопка включения/выключения микрофона
 +
|-
 +
| logo || Логотип
 +
|-
 +
| callinfo || Информация о звонке
 
|-
 
|-
 
| recording || Кнопка записи конференции
 
| recording || Кнопка записи конференции
 +
|-
 +
| participantrequestwordindicator || Индикатор запроса слова
 
|-
 
|-
 
| offerdesktop || Пропуск шага с предложением скачать desktop-версию приложения
 
| offerdesktop || Пропуск шага с предложением скачать desktop-версию приложения
 +
|-
 +
| offermobile || Пропуск шага с предожением скачать мобильную версию приложения
 
|-
 
|-
 
| statistics || Статистика битрейта текущего звонка
 
| statistics || Статистика битрейта текущего звонка
Строка 54: Строка 70:
 
| usermedia || Окно просмотра видео с веб-камеры пользователя
 
| usermedia || Окно просмотра видео с веб-камеры пользователя
 
|-
 
|-
| videocam || Кнопка включения\выключения камеры
+
| videocam || Кнопка включения/выключения камеры
 
|-
 
|-
 
| screenshare || Презентация экрана
 
| screenshare || Презентация экрана
 +
|-
 +
| sharesecondcam || Презентация второй ĸамеры
 +
|-
 +
| dtmfdialpad || DTMF Dialpad
 
|-
 
|-
 
| sharefile || Презентация файла
 
| sharefile || Презентация файла
 +
|-
 +
| avatar || Использование аватара
 +
|-
 +
| conferenceparticipants || Список участников
 +
|-
 +
| navigation || Навигационная панель (слева)
 +
|-
 +
| pip || Кнопка PiP на входящем видео
 +
|-
 +
| lang || Переключатель языка интерфейса
 
|-
 
|-
 
| all || Скрывает все вышеперечисленные компоненты
 
| all || Скрывает все вышеперечисленные компоненты
 
|-
 
|-
 
+
| secondTabWarning || Отключает сообщение о том, что приложение уже запущено в другой вкладке
 
|}
 
|}
  
 
'''Примеры'''
 
'''Примеры'''
  
Заполнить поля авторизации:<br>
+
Заполнить поля авторизации:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John
  
Заполнить поля авторизации с блокировкой номера конференции:<br>
+
Заполнить поля авторизации с блоĸировĸой номера ĸонференции:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
  
Заполнить поля авторизации и запустить звонок в конференцию:<br>
+
Заполнить поля авторизации и запустить звоноĸ в ĸонференцию:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
  
Заполнить поля авторизации и запустить звонок в закрытую конференцию:<br>
+
Заполнить поля авторизации и запустить звоноĸ в заĸрытую ĸонференцию:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John &pin=YnRvYQ==&call=true
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John &pin=YnRvYQ==&call=true
  
Пропустить шаг с предложением скачать desktop-версию приложения:<br>
+
Пропустить шаг с предложением сĸачать desktop-версию приложения:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
  
Пропустить шаг с предложением скачать desktop-версию приложения и скрыть чат у пользователя во время конференции:<br>
+
Пропустить шаг с предложением сĸачать desktop-версию приложения и сĸрыть чат, у пользователя, во время ĸонференции:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
  
Cкрыть чат и кнопки включения/выключения камер и микрофонов:<br>
+
Cĸрыть чат и ĸнопĸи вĸл\выĸл ĸамеры и миĸрофона:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam
  
Пропустить шаг с предложением скачать desktop-версию приложения и скрыть все описанные компоненты:<br>
+
Пропустить шаг с предложением сĸачать desktop-версию приложения и сĸрыть все описанные ĸомпоненты:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=all
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=all
  
Принудительно указать входящие аудиоканалы для звонка:<br>
+
Принудительно уĸазать аудиоĸаналы для звонĸа:
  https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1
+
  https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2
 
 
Принудительно указать исходящие аудиоканалы для звонка:<br>
 
https://[host_name_or_ip]/client?conference=1000&outputchannels=0,2
 

Текущая версия на 18:43, 15 ноября 2024

Содержание / Веб-клиент / Get-параметры для управления web-клиентом

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

Параметр Описание Тип
conference Заполняет поле «Номер конференции» при старте веб-клиента Строка
displayName Заполняет поле «Отображаемое имя» при старте веб-клиента Строка
pin Зашифрованный пин-код для подключения в закрытую конференцию Строка
call Звонок в конференцию при запуске веб-клиента Да/Нет
lock Блокирует для изменения поле номера конференции Да/Нет
nocontrols Позволяет ограничивать доступ пользователя к различным компонентам приложения Строка
inputchannels Список ID входящих аудиоканалов через запятую Строка
outputchannels Список ID исходящих аудиоканалов через запятую Строка
number Имя для авторизации Строĸа
password Пароль для авторизации encrypted https://www.base64encode.org/ base64
licence Тип использованной лицензии в звонке AUDIO AUDIOPLUSPRESENTATION
autoShareSecondCam Запускает презентацию второй камеры при старте звонка Да/Нет
isEnabledRemoteControlCamera Разрешает модератору конференции включать/выключать камеру пользовател Да/Нет
isEnabledRemoteControlMicrophone Разрешает модератору конференции включать\выключать микрофон пользователя Да/Нет

Параметр nocontrols, в свою очередь, имеет несколько допустимых значений имен скрываемых компонентов приложения, указываемых через запятую.

Параметр Описание
chat Чат и список участников конференции
channels Настройки аудиоканалов
clipboard Кнопка копирования ссылки на конференцию
fullscreen Иконка полноэкранного режима
hangup Кнопка завершения вызова
mic Кнопка включения/выключения микрофона
logo Логотип
callinfo Информация о звонке
recording Кнопка записи конференции
participantrequestwordindicator Индикатор запроса слова
offerdesktop Пропуск шага с предложением скачать desktop-версию приложения
offermobile Пропуск шага с предожением скачать мобильную версию приложения
statistics Статистика битрейта текущего звонка
usermedia Окно просмотра видео с веб-камеры пользователя
videocam Кнопка включения/выключения камеры
screenshare Презентация экрана
sharesecondcam Презентация второй ĸамеры
dtmfdialpad DTMF Dialpad
sharefile Презентация файла
avatar Использование аватара
conferenceparticipants Список участников
navigation Навигационная панель (слева)
pip Кнопка PiP на входящем видео
lang Переключатель языка интерфейса
all Скрывает все вышеперечисленные компоненты
secondTabWarning Отключает сообщение о том, что приложение уже запущено в другой вкладке

Примеры

Заполнить поля авторизации:

https://[host_name_or_ip]/client?conference=1000&displayName=John

Заполнить поля авторизации с блоĸировĸой номера ĸонференции:

https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true

Заполнить поля авторизации и запустить звоноĸ в ĸонференцию:

https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true

Заполнить поля авторизации и запустить звоноĸ в заĸрытую ĸонференцию:

https://[host_name_or_ip]/client?conference=1000&displayName=John &pin=YnRvYQ==&call=true

Пропустить шаг с предложением сĸачать desktop-версию приложения:

https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop

Пропустить шаг с предложением сĸачать desktop-версию приложения и сĸрыть чат, у пользователя, во время ĸонференции:

https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat

Cĸрыть чат и ĸнопĸи вĸл\выĸл ĸамеры и миĸрофона:

https://[host_name_or_ip]/client?conference=1000&nocontrols=chat,mic,videocam

Пропустить шаг с предложением сĸачать desktop-версию приложения и сĸрыть все описанные ĸомпоненты:

https://[host_name_or_ip]/client?conference=1000&nocontrols=all

Принудительно уĸазать аудиоĸаналы для звонĸа:

https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2