userdata – Налаштування клієнта
Параметри userdata дозволяють перевизначати клієнтські налаштування для окремого користувача шляхом додавання параметрів із префіксом userdata- до виклику API join. Це дозволяє налаштувати роботу з BigBlueButton для окремих учасників без зміни конфігурації сервера.
Список доступних параметрів userdata лише частково охоплено офіційною документацією BigBlueButton. Багато параметрів виведено з аналізу вихідного коду settings.yml і вони можуть змінюватися між версіями без попередження. undocumented
Як працюють параметри userdata
Параметри userdata передаються як параметри рядка запиту URL у запиті join. Вони перевизначають типові значення з settings.yml лише для цієї окремої сесії користувача. Назви параметрів завжди починаються з префікса userdata-, за яким іде ключ налаштування.
GET https://api-guide.bbbserver.com/bigbluebutton/api/join?meetingID=replace-with-meeting-id&fullName=Max&role=VIEWER&userdata-bbb_auto_join_audio=true&userdata-bbb_skip_check_audio=true&checksum=replace-with-checksumОскільки параметри userdata є частиною рядка запиту, вони включаються в обчислення checksum. Обов’язково додавайте їх перед обчисленням checksum, а не після.
Параметри аудіо та медіа
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_auto_join_audio | Boolean | — | Автоматично підключати до аудіомосту, коли користувач входить до зустрічі. |
userdata-bbb_listen_only_mode | Boolean | — | Увімкнути або вимкнути режим listen-only для користувача. |
userdata-bbb_force_listen_only | Boolean | — | Примусово перевести користувача в режим listen-only. Це не стосується модераторів. |
userdata-bbb_skip_check_audio | Boolean | — | Пропустити діалог перевірки аудіо під час приєднання. |
userdata-bbb_skip_echotest_if_previous_device | Boolean | — | Пропустити echo test, якщо виявлено той самий аудіопристрій, що й у попередньому сеансі. |
Параметри вебкамери
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_auto_share_webcam | Boolean | — | Автоматично розпочинати трансляцію вебкамери, коли користувач приєднується. |
userdata-bbb_mirror_own_webcam | Boolean | — | Віддзеркалювати власний попередній перегляд вебкамери користувача по горизонталі. |
Параметри макета та відображення
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_auto_swap_layout | Boolean | — | Автоматично змінювати макет, коли демонструється презентація. |
userdata-bbb_default_layout | String | — | Встановити типовий макет для користувача. Доступні значення залежать від конфігурації клієнта. undocumented |
userdata-bbb_hide_presentation | Boolean | — | Приховати область презентації від користувача. |
userdata-bbb_prefer_dark_theme | Boolean | — | Активувати темну тему інтерфейсу користувача. |
Параметри кастомізації та брендування
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_custom_style | String | — | Вбудовані правила CSS (URL-кодовані), застосовані до клієнта BigBlueButton для цього користувача. |
userdata-bbb_custom_style_url | URL | — | URL-адреса зовнішнього файлу CSS, який завантажується клієнтом для власного стилю. Має роздаватися через HTTPS. |
Параметр userdata-bbb_custom_style може бути використаний для cross-site scripting, якщо URL-адреси join формуються на стороні клієнта. Завжди генеруйте URL-адреси join на сервері, де ви контролюєте значення параметрів.
Параметри елементів інтерфейсу
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_hide_notifications | Boolean | — | Приховати спливаючі сповіщення в інтерфейсі клієнта. |
userdata-bbb_hide_controls | Boolean | — | Приховати елементи керування UI (кнопки панелі інструментів) від користувача. |
userdata-bbb_shortcuts | String | — | Визначити користувацькі комбінації клавіш для користувача. |
Параметри запису та зовнішнього керування
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_outside_toggle_recording | Boolean | — | Дозволити зовнішньому застосунку вмикати та вимикати запис зустрічі. |
userdata-bbb_outside_toggle_self_voice | Boolean | — | Дозволити зовнішньому застосунку вмикати та вимикати аудіо користувача. |
Параметри білої дошки
| Параметр | Тип | За замовчуванням | Опис |
|---|---|---|---|
userdata-bbb_initial_selected_tool | String | — | Встановіть інструмент білої дошки, вибраний спочатку, коли користувач відкриває білу дошку. Допустимі значення визначаються конфігурацією клієнта. undocumented |
Практичні приклади
Нижче наведено поширені комбінації параметрів userdata для типових сценаріїв використання.
Режим кіоску
Ідеально для екранів у конференц-залах або цифрових вивісок, де не потрібна взаємодія з користувачем:
userdata-bbb_auto_join_audio=true&userdata-bbb_force_listen_only=true&userdata-bbb_hide_controls=trueБрендування для конкретного тенанта
Застосувати власну таблицю стилів CSS для кожного орендаря або клієнта:
userdata-bbb_custom_style_url=https://api-guide.bbbserver.com/tenant-a/bbb-style.cssДоступне швидке приєднання
Спростіть процес приєднання для користувачів, яким потрібен спрощений, доступний інтерфейс:
userdata-bbb_skip_check_audio=true&userdata-bbb_auto_join_audio=true&userdata-bbb_prefer_dark_theme=trueВажливі примітки
- Параметри userdata впливають лише на поточну сесію окремого користувача. Вони не змінюють стандартні налаштування сервера.
- Не всі параметри доступні в кожній версії BigBlueButton. Перевірте сумісність із вашою цільовою версією перед розгортанням.
- CSS, завантажений через
userdata-bbb_custom_style_url, має роздаватися через HTTPS.
Під час використання кінцевої точки getJoinUrl певні параметри userdata блокуються для глядачів (роль VIEWER) як захід безпеки. Список блокувань налаштовується на стороні сервера через властивість getJoinUrlUserdataBlocklist у bigbluebutton.properties. Це запобігає тому, щоб глядачі перевизначали критично важливі для безпеки клієнтські налаштування через попередньо підписані URL-адреси join. undocumented
Поширені запитання
userdata-bbb_force_listen_only застосовується лише до глядачів. Модератори не переводяться примусово в режим listen-only незалежно від цього налаштування.settings.yml у вихідному коді клієнта BigBlueButton. Нові параметри часто додаються без оновлення документації.