Rozdział 19

userdata – Ustawienia klienta

Parametry userdata pozwalają nadpisywać ustawienia po stronie klienta dla każdego użytkownika osobno poprzez dodanie parametrów z prefiksem userdata- do wywołania API join. Pozwala to dostosować środowisko BigBlueButton dla poszczególnych uczestników bez zmiany konfiguracji serwera.

Lista dostępnych parametrów userdata jest tylko częściowo opisana w oficjalnej dokumentacji BigBlueButton. Wiele parametrów wynika z analizy kodu źródłowego settings.yml i może zmieniać się między wersjami bez powiadomienia. undocumented

Jak działają parametry userdata

Parametry userdata są przekazywane jako parametry zapytania URL w żądaniu join. Nadpisują domyślne wartości z settings.yml tylko dla tej pojedynczej sesji użytkownika. Nazwy parametrów zawsze zaczynają się od prefiksu userdata-, po którym następuje klucz ustawienia. 

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

Ponieważ parametry userdata są częścią ciągu zapytania, są uwzględniane przy obliczaniu checksum. Upewnij się, że dodasz je przed obliczeniem checksum, a nie po.

Parametry audio i mediów

Parametr Typ Domyślnie Opis
userdata-bbb_auto_join_audio Boolean — Automatycznie dołącz do mostka audio, gdy użytkownik wejdzie na spotkanie.
userdata-bbb_listen_only_mode Boolean — Włącz lub wyłącz tryb listen-only dla użytkownika.
userdata-bbb_force_listen_only Boolean — Wymuś dla użytkownika tryb listen-only. Nie dotyczy to moderatorów.
userdata-bbb_skip_check_audio Boolean — Pomiń okno dialogowe testu audio podczas dołączania.
userdata-bbb_skip_echotest_if_previous_device Boolean — Pomiń test echa, jeśli zostanie wykryte to samo urządzenie audio co w poprzedniej sesji.

Parametry kamery internetowej

Parametr Typ Domyślnie Opis
userdata-bbb_auto_share_webcam Boolean — Automatycznie rozpocznij udostępnianie kamery internetowej, gdy użytkownik dołączy.
userdata-bbb_mirror_own_webcam Boolean — Odbij poziomo podgląd własnej kamery użytkownika.

Parametry układu i wyświetlania

Parametr Typ Domyślnie Opis
userdata-bbb_auto_swap_layout Boolean — Automatycznie przełącz układ, gdy udostępniana jest prezentacja.
userdata-bbb_default_layout String — Ustaw domyślny układ dla użytkownika. Dostępne wartości zależą od konfiguracji klienta. undocumented
userdata-bbb_hide_presentation Boolean — Ukryj obszar prezentacji przed użytkownikiem.
userdata-bbb_prefer_dark_theme Boolean — Włącz ciemny motyw interfejsu użytkownika.

Parametry dostosowania i brandingu

Parametr Typ Domyślnie Opis
userdata-bbb_custom_style String — Reguły CSS inline (zakodowane w URL) stosowane do klienta BigBlueButton dla tego użytkownika.
userdata-bbb_custom_style_url URL — URL do zewnętrznego pliku CSS ładowanego przez klienta dla niestandardowego stylowania. Musi być serwowany przez HTTPS.

Parametr userdata-bbb_custom_style może zostać wykorzystany do cross-site scripting, jeśli URL-e join są konstruowane po stronie klienta. Zawsze generuj URL-e join na serwerze, gdzie kontrolujesz wartości parametrów.

Parametry elementów interfejsu użytkownika

Parametr Typ Domyślnie Opis
userdata-bbb_hide_notifications Boolean — Ukryj wyskakujące powiadomienia w interfejsie klienta.
userdata-bbb_hide_controls Boolean — Ukryj elementy sterujące interfejsu użytkownika (przyciski paska narzędzi) przed użytkownikiem.
userdata-bbb_shortcuts String — Zdefiniuj niestandardowe skróty klawiaturowe dla użytkownika.

Parametry nagrywania i zewnętrznego sterowania

Parametr Typ Domyślnie Opis
userdata-bbb_outside_toggle_recording Boolean — Zezwól zewnętrznej aplikacji na włączanie i wyłączanie nagrywania spotkania.
userdata-bbb_outside_toggle_self_voice Boolean — Zezwól zewnętrznej aplikacji na włączanie i wyłączanie dźwięku użytkownika.

Parametry tablicy

Parametr Typ Domyślnie Opis
userdata-bbb_initial_selected_tool String — Ustaw narzędzie tablicy wybrane początkowo, gdy użytkownik otworzy tablicę. Akceptowane wartości są określane przez konfigurację klienta. undocumented

Praktyczne przykłady

Poniżej znajdują się typowe kombinacje parametrów userdata dla najczęstszych przypadków użycia.

Tryb kiosku

Idealny do ekranów w salach konferencyjnych lub oznakowania cyfrowego, gdzie nie jest wymagana żadna interakcja użytkownika: 

userdata-bbb_auto_join_audio=true&userdata-bbb_force_listen_only=true&userdata-bbb_hide_controls=true

Branding specyficzny dla tenantu

Zastosuj niestandardowy arkusz stylów CSS dla każdego tenanta lub klienta: 

userdata-bbb_custom_style_url=https://api-guide.bbbserver.com/tenant-a/bbb-style.css

Dostępne szybkie dołączanie

Uprość proces dołączania dla użytkowników, którzy potrzebują prostego i dostępnego sposobu korzystania: 

userdata-bbb_skip_check_audio=true&userdata-bbb_auto_join_audio=true&userdata-bbb_prefer_dark_theme=true

Ważne uwagi

  • Parametry userdata wpływają tylko na bieżącą sesję konkretnego użytkownika. Nie zmieniają domyślnych ustawień serwera.
  • Nie wszystkie parametry są dostępne w każdej wersji BigBlueButton. Przed wdrożeniem przetestuj je względem docelowej wersji.
  • CSS ładowany przez userdata-bbb_custom_style_url musi być serwowany przez HTTPS.

Podczas używania endpointu getJoinUrl niektóre parametry userdata są blokowane dla widzów (rola VIEWER) jako środek bezpieczeństwa. Lista blokowanych parametrów jest konfigurowana po stronie serwera przez właściwość getJoinUrlUserdataBlocklist w bigbluebutton.properties. Zapobiega to nadpisywaniu przez widzów krytycznych ustawień bezpieczeństwa klienta za pomocą wstępnie podpisanych URL-i join. undocumented

Najczęściej zadawane pytania

Nie. Parametry userdata są stosowane tylko do pojedynczej sesji zainicjowanej wywołaniem join. Jeśli użytkownik opuści spotkanie i dołączy ponownie, parametry muszą zostać ponownie uwzględnione w nowym URL-u join.

Nie. Parametry userdata są przeznaczone wyłącznie dla endpointu join. Są przetwarzane przez klienta, gdy użytkownik dołącza do spotkania, i nie mają żadnego wpływu na wywołanie create.

Tak. Ponieważ są częścią ciągu zapytania URL, są uwzględniane przy obliczaniu checksum. Musisz dodać wszystkie parametry userdata do ciągu zapytania przed obliczeniem checksum.

Nie. Parametr userdata-bbb_force_listen_only dotyczy wyłącznie widzów. Moderatorzy nie są zmuszani do trybu listen-only niezależnie od tego ustawienia.

Oficjalna dokumentacja obejmuje tylko część parametrów. Najpełniejszą i najbardziej aktualną listę można znaleźć w pliku settings.yml w kodzie źródłowym klienta BigBlueButton. Nowe parametry są często dodawane bez aktualizacji dokumentacji.