userdata – Klientindstillinger
Userdata-parametre giver dig mulighed for at tilsidesætte klient-side-indstillinger pr. bruger ved at tilføje parametre med præfikset userdata- til API-kaldet join. Dette gør det muligt at tilpasse BigBlueButton-oplevelsen for individuelle deltagere uden at ændre serverkonfigurationen.
Listen over tilgængelige userdata-parametre er kun delvist dækket af den officielle BigBlueButton-dokumentation. Mange parametre er afledt af kildekodeanalyse af settings.yml og kan ændre sig mellem versioner uden varsel. undocumented
Sådan fungerer userdata-parametre
Userdata-parametre sendes som URL-query-parametre i requesten join. De tilsidesætter standardværdierne fra settings.yml kun for denne ene brugersession. Parameternavnene starter altid med præfikset userdata- efterfulgt af indstillingsnøglen.
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-checksumFordi userdata-parametre er en del af query-strengen, indgår de i beregningen af checksum. Sørg for at tilføje dem før du beregner checksum, ikke bagefter.
Lyd- og medieparametre
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_auto_join_audio | Boolean | — | Deltag automatisk i lydbroen, når brugeren går ind i mødet. |
userdata-bbb_listen_only_mode | Boolean | — | Aktivér eller deaktiver listen-only-tilstand for brugeren. |
userdata-bbb_force_listen_only | Boolean | — | Tving brugeren ind i listen-only-tilstand. Dette gælder ikke for moderatorer. |
userdata-bbb_skip_check_audio | Boolean | — | Spring lyddialogen over ved tilslutning. |
userdata-bbb_skip_echotest_if_previous_device | Boolean | — | Spring ekkotesten over, hvis den samme lydenhed som i den forrige session registreres. |
Webcam-parametre
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_auto_share_webcam | Boolean | — | Start automatisk deling af webcam, når brugeren deltager. |
userdata-bbb_mirror_own_webcam | Boolean | — | Spejlvend brugerens eget webcam-preview vandret. |
Layout- og visningsparametre
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_auto_swap_layout | Boolean | — | Skift automatisk layoutet, når en præsentation deles. |
userdata-bbb_default_layout | String | — | Angiv standardlayoutet for brugeren. De tilgængelige værdier afhænger af klientkonfigurationen. undocumented |
userdata-bbb_hide_presentation | Boolean | — | Skjul præsentationsområdet for brugeren. |
userdata-bbb_prefer_dark_theme | Boolean | — | Aktivér det mørke tema for brugergrænsefladen. |
Tilpasnings- og brandingparametre
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_custom_style | String | — | Inline-CSS-regler (URL-encoded) anvendt på BigBlueButton-klienten for denne bruger. |
userdata-bbb_custom_style_url | URL | — | URL til en ekstern CSS-fil, som indlæses af klienten til brugerdefineret styling. Skal serveres over HTTPS. |
Parameteren userdata-bbb_custom_style kan udnyttes til cross-site scripting, hvis join-URL'er konstrueres på klientsiden. Generér altid join-URL'er på serversiden, hvor du kontrollerer parameterværdierne.
Parametre for UI-elementer
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_hide_notifications | Boolean | — | Skjul notifikations-pop op-vinduer i klientgrænsefladen. |
userdata-bbb_hide_controls | Boolean | — | Skjul UI-kontrolelementerne (værktøjslinjeknapperne) for brugeren. |
userdata-bbb_shortcuts | String | — | Definér brugerdefinerede tastaturgenveje for brugeren. |
Parametre for optagelse og ekstern styring
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_outside_toggle_recording | Boolean | — | Tillad en ekstern applikation at slå mødeoptagelsen til og fra. |
userdata-bbb_outside_toggle_self_voice | Boolean | — | Tillad en ekstern applikation at slå brugerens lyd til og fra. |
Whiteboard-parametre
| Parameter | Type | Standard | Beskrivelse |
|---|---|---|---|
userdata-bbb_initial_selected_tool | String | — | Angiv det oprindeligt valgte whiteboard-værktøj, når brugeren åbner whiteboardet. De accepterede værdier bestemmes af klientkonfigurationen. undocumented |
Praktiske eksempler
Nedenfor er almindelige kombinationer af userdata-parametre til typiske anvendelsestilfælde.
Kiosktilstand
Ideel til konferencerumsskærme eller digital skiltning, hvor der ikke kræves brugerinteraktion:
userdata-bbb_auto_join_audio=true&userdata-bbb_force_listen_only=true&userdata-bbb_hide_controls=trueLejer-specifik branding
Anvend et brugerdefineret CSS-stylesheet pr. tenant eller kunde:
userdata-bbb_custom_style_url=https://api-guide.bbbserver.com/tenant-a/bbb-style.cssTilgængelig hurtig tilslutning
Forenkl tilslutningsprocessen for brugere, der har brug for en forenklet og tilgængelig oplevelse:
userdata-bbb_skip_check_audio=true&userdata-bbb_auto_join_audio=true&userdata-bbb_prefer_dark_theme=trueVigtige bemærkninger
- Userdata-parametre påvirker kun den aktuelle session for den enkelte bruger. De ændrer ikke serverens standardindstillinger.
- Ikke alle parametre er tilgængelige i alle BigBlueButton-versioner. Test mod din målversion før deployment.
- CSS indlæst via
userdata-bbb_custom_style_urlskal serveres over HTTPS.
Når du bruger endpointet getJoinUrl, blokeres visse userdata-parametre for viewers (rolle VIEWER) som en sikkerhedsforanstaltning. Bloklisten konfigureres på serversiden via egenskaben getJoinUrlUserdataBlocklist i bigbluebutton.properties. Dette forhindrer viewers i at tilsidesætte sikkerhedskritiske klientindstillinger gennem præsignerede join-URL'er. undocumented
Ofte stillede spørgsmål
userdata-bbb_force_listen_only gælder kun for viewers. Moderatorer tvinges ikke ind i listen-only-tilstand uanset denne indstilling.settings.yml i kildekoden til BigBlueButton-klienten. Nye parametre tilføjes ofte uden opdateringer af dokumentationen.