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

Материал из База знаний VINTEO
 
(не показано 6 промежуточных версий этого же участника)
Строка 5: Строка 5:
 
! Parameter!! Description !! Type
 
! Parameter!! Description !! Type
 
|-
 
|-
−
| conference || Заполняет поле «Номер конференции» при старте веб-клиента || Строка
+
| conference || Fills in the "Conference number" field when starting the web client || String
 
|-
 
|-
−
| displayName || Заполняет поле «Отображаемое имя» при старте веб-клиента || Строка
+
| displayName || Fills in the "Display name" field when the web client starts || String
 
|-
 
|-
−
| pin || Зашифрованный пин-код для подключения в закрытую конференцию || Строка
+
| pin || Encrypted PIN code for joining a close conference || String
 
|-
 
|-
−
| call || Звонок в конференцию при запуске веб-клиента || Да/Нет
+
| call || Calling a conference when launching the web client || Yes/No
 
|-
 
|-
−
| lock || Блокирует для изменения поле номера конференции || Да/Нет
+
| lock || Locks the conference number field for editing || Yes/No
 
|-
 
|-
−
| nocontrols || Позволяет ограничивать доступ пользователя к различным компонентам приложения || Строка
+
| nocontrols || Allows you to restrict user access to various components of the application || String
 
|-
 
|-
−
| inputchannels || Список ID входящих аудиоканалов через запятую || Строка
+
| inputchannels || List of incoming audio channel IDs comma separated || String
 
|-
 
|-
−
| outputchannels || Список ID исходящих аудиоканалов через запятую || Строка
+
| outputchannels || List of outgoing audio channel IDs comma separated  || String
 
|-
 
|-
−
| number || Имя для авторизации || Строĸа
+
| number || Login name || String
 
|-
 
|-
−
| password || Пароль для авторизации encrypted https://www.base64encode.org/ || base64
+
| password || Password for authorization with encrypted https://www.base64encode.org/ || base64
 
|-
 
|-
−
| licence || Тип использованной лицензии в звонке || AUDIO AUDIOPLUSPRESENTATION
+
| licence || Type of license used in the call || AUDIO AUDIOPLUSPRESENTATION
 +
|-
 +
| autoShareSecondCam || Launches a presentation of the second camera when a call starts || Yes/No
 +
|-
 +
| isEnabledRemoteControlCamera || Allows the conference moderator to turn the user's camera on/off || Yes/No
 +
|-
 +
| isEnabledRemoteControlMicrophon || Allows the conference moderator to enable/disable the user's microphone ||Yes/No
 
|}
 
|}
  
−
Параметр nocontrols, в свою очередь, имеет несколько допустимых значений имен скрываемых компонентов приложения, указываемых через запятую.
+
The nocontrols parameter has several valid values ​​for the names of hidden application components separated by commas.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Параметр !! Описание
+
! Parameter !! Description
 
|-
 
|-
−
| chat || Чат и список участников конференции
+
| chat || Chat and list of conference participants
 
|-
 
|-
−
| channels || Настройки аудиоканалов
+
| channels || Audio channel settings
 
|-
 
|-
−
| clipboard || Кнопка копирования ссылки на конференцию
+
| clipboard || Button to copy conference link
 
|-
 
|-
−
| fullscreen || Иконка полноэкранного режима
+
| fullscreen || Fullscreen mode icon
 
|-
 
|-
−
| hangup || Кнопка завершения вызова
+
| hangup || End call button
 
|-
 
|-
−
| mic || Кнопка включения/выключения микрофона
+
| mic || Microphone on/off button
 
|-
 
|-
−
| logo || Логотип
+
| logo || Logo
 
|-
 
|-
−
| callinfo || Информация о звонке
+
| callinfo || Call information
 
|-
 
|-
−
| recording || Кнопка записи конференции
+
| recording || Conference recording button
 
|-
 
|-
−
| participantrequestwordindicator || Индикатор запроса слова
+
| participantrequestwordindicator || Word request indicator
 
|-
 
|-
−
| offerdesktop || Пропуск шага с предложением скачать desktop-версию приложения
+
| offerdesktop || Skipping the step with the offer to download the desktop version of the application
 
|-
 
|-
−
| offermobile || Пропуск шага с предожением скачать мобильную версию приложения
+
| offermobile || Skipping step with the offer to download mobile version of the application
 
|-
 
|-
−
| statistics || Статистика битрейта текущего звонка
+
| statistics || Current call bitrate statistics
 
|-
 
|-
−
| usermedia || Окно просмотра видео с веб-камеры пользователя
+
| usermedia || Window for viewing video from the user's webcam
 
|-
 
|-
−
| videocam || Кнопка включения/выключения камеры
+
| videocam || Camera on/off button
 
|-
 
|-
−
| screenshare || Презентация экрана
+
| screenshare || Screen sharing
 
|-
 
|-
−
| sharesecondcam || Презентация второй ĸамеры
+
| sharesecondcam || Presentation of the second camera
 
|-
 
|-
 
| dtmfdialpad || DTMF Dialpad
 
| dtmfdialpad || DTMF Dialpad
 
|-
 
|-
−
| sharefile || Презентация файла
+
| sharefile || File sharing
 +
|-
 +
| avatar || Using an avatar
 
|-
 
|-
−
| avatar || Использование аватара
+
| conferenceparticipants || List of participants
 
|-
 
|-
−
| conferenceparticipants || Список участников
+
| navigation || Navigation bar (on the left)
 
|-
 
|-
−
| navigation || Навигационная панель (слева)
+
| pip || PiP button on incoming video
 
|-
 
|-
−
| pip || Кнопка PiP на входящем видео
+
| lang || Interface language switch
 
|-
 
|-
−
| lang || Переключатель языка интерфейса
+
| all || Hides all the above components
 
|-
 
|-
−
| all || Скрывает все вышеперечисленные компоненты
+
| secondTabWarning || Disables the message that the application is already running in another tab
 
|}
 
|}
  
−
'''Примеры'''
+
'''Examples'''
  
−
Заполнить поля авторизации:
+
Fill in the authorization fields:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John
  
−
Заполнить поля авторизации с блоĸировĸой номера ĸонференции:
+
Fill in the authorization fields with conference number blocking:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&lock=true
  
−
Заполнить поля авторизации и запустить звоноĸ в ĸонференцию:
+
Fill in the authorization fields and start a conference call:
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
 
  https://[host_name_or_ip]/client?conference=1000&displayName=John&call=true
  
−
Заполнить поля авторизации и запустить звоноĸ в заĸрытую ĸонференцию:
+
Fill in the authorization fields and start a call to a closed conference:
 
  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-версию приложения:
+
Skip the step with the offer to download the desktop version of the application:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop
  
−
Пропустить шаг с предложением сĸачать desktop-версию приложения и сĸрыть чат, у пользователя, во время ĸонференции:
+
Skip the step with the offer to download the desktop version of the application and hide the chat from the user during the conference:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=offerdesktop,chat
  
−
Cĸрыть чат и ĸнопĸи вĸл\выĸл ĸамеры и миĸрофона:
+
Hide chat and buttons to turn on/off camera and microphone:
 
  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-версию приложения и сĸрыть все описанные ĸомпоненты:
+
Skip the step with the offer to download the desktop version of the application and hide all the described components:
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=all
 
  https://[host_name_or_ip]/client?conference=1000&nocontrols=all
  
−
Принудительно уĸазать аудиоĸаналы для звонĸа:
+
Force specify audio channels for call:
 
  https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2
 
  https://[host_name_or_ip]/client?conference=1000&inputchannels=0,1&outputchannels=0,2

Текущая версия на 15:36, 14 ноября 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 Fills in the "Conference number" field when starting the web client String
displayName Fills in the "Display name" field when the web client starts String
pin Encrypted PIN code for joining a close conference String
call Calling a conference when launching the web client Yes/No
lock Locks the conference number field for editing Yes/No
nocontrols Allows you to restrict user access to various components of the application String
inputchannels List of incoming audio channel IDs comma separated String
outputchannels List of outgoing audio channel IDs comma separated String
number Login name String
password Password for authorization with encrypted https://www.base64encode.org/ base64
licence Type of license used in the call AUDIO AUDIOPLUSPRESENTATION
autoShareSecondCam Launches a presentation of the second camera when a call starts Yes/No
isEnabledRemoteControlCamera Allows the conference moderator to turn the user's camera on/off Yes/No
isEnabledRemoteControlMicrophon Allows the conference moderator to enable/disable the user's microphone Yes/No

The nocontrols parameter has several valid values ​​for the names of hidden application components separated by commas.

Parameter Description
chat Chat and list of conference participants
channels Audio channel settings
clipboard Button to copy conference link
fullscreen Fullscreen mode icon
hangup End call button
mic Microphone on/off button
logo Logo
callinfo Call information
recording Conference recording button
participantrequestwordindicator Word request indicator
offerdesktop Skipping the step with the offer to download the desktop version of the application
offermobile Skipping step with the offer to download mobile version of the application
statistics Current call bitrate statistics
usermedia Window for viewing video from the user's webcam
videocam Camera on/off button
screenshare Screen sharing
sharesecondcam Presentation of the second camera
dtmfdialpad DTMF Dialpad
sharefile File sharing
avatar Using an avatar
conferenceparticipants List of participants
navigation Navigation bar (on the left)
pip PiP button on incoming video
lang Interface language switch
all Hides all the above components
secondTabWarning Disables the message that the application is already running in another tab

Examples

Fill in the authorization fields: 

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

Fill in the authorization fields with conference number blocking: 

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

Fill in the authorization fields and start a conference call: 

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

Fill in the authorization fields and start a call to a closed conference: 

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

Skip the step with the offer to download the desktop version of the application: 

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

Skip the step with the offer to download the desktop version of the application and hide the chat from the user during the conference: 

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

Hide chat and buttons to turn on/off camera and microphone: 

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

Skip the step with the offer to download the desktop version of the application and hide all the described components: 

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

Force specify audio channels for call: 

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=16000