Parameters of Get for web client control: различия между версиями

Материал из База знаний VINTEO
(Новая страница: «Get parameters allow at the stage of loading the web client to manage its functionality such as automatic filling of authorization fields, calling to a conference...»)
 
Строка 1: Строка 1:
 
Get parameters allow at the stage of loading the web client to manage its functionality such as automatic filling of authorization fields, calling to a conference at startup, as well as restricting user access to various components of the application, for example, hiding the chat or access to audio channel settings.
 
Get parameters allow at the stage of loading the web client to manage its functionality such as automatic filling of authorization fields, calling to a conference at startup, as well as restricting user access to various components of the application, for example, hiding the chat or access to audio channel settings.
 +
 +
{| class="wikitable"
 +
|-
 +
! Parameter!! Description !! Type
 +
|-
 +
| conference || Заполняет поле «Номер конференции» при старте веб-клиента || Строка
 +
|-
 +
| displayName || Заполняет поле «Отображаемое имя» при старте веб-клиента || Строка
 +
|-
 +
| pin || Зашифрованный пин-код для подключения в закрытую конференцию || Строка
 +
|-
 +
| call || Звонок в конференцию при запуске веб-клиента || Да/Нет
 +
|-
 +
| lock || Блокирует для изменения поле номера конференции || Да/Нет
 +
|-
 +
| nocontrols || Позволяет ограничивать доступ пользователя к различным компонентам приложения || Строка
 +
|-
 +
| inputchannels || Список ID входящих аудиоканалов через запятую || Строка
 +
|-
 +
| outputchannels || Список ID исходящих аудиоканалов через запятую || Строка
 +
|-
 +
| number || Имя для авторизации || Строĸа
 +
|-
 +
| password || Пароль для авторизации encrypted https://www.base64encode.org/ || base64
 +
|-
 +
| licence || Тип использованной лицензии в звонке || AUDIO AUDIOPLUSPRESENTATION
 +
|}
 +
 +
Параметр nocontrols, в свою очередь, имеет несколько допустимых значений имен скрываемых компонентов приложения, указываемых через запятую.
 +
 +
{| class="wikitable"
 +
|-
 +
! Параметр !! Описание
 +
|-
 +
| 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 || Скрывает все вышеперечисленные компоненты
 +
|}
 +
 +
'''Примеры'''
 +
 +
Заполнить поля авторизации:
 +
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

Версия 15:40, 15 августа 2024

Get parameters allow at the stage of loading the web client to manage its functionality such as automatic filling of authorization fields, calling to a conference at startup, as well as restricting user access to various components of the application, for example, hiding the chat or access to audio channel settings.

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

Параметр 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 Скрывает все вышеперечисленные компоненты

Примеры

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

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
Источник — https://wiki.vinteo.com/index.php?title=Parameters_of_Get_for_web_client_control&oldid=14787