Chapitre 19

userdata – Paramètres client

Les paramètres userdata vous permettent de remplacer les paramètres côté client pour chaque utilisateur en ajoutant des paramètres préfixés par userdata- à l’appel API join. Cela vous permet de personnaliser l’expérience BigBlueButton pour chaque participant sans modifier la configuration du serveur.

La liste des paramètres userdata disponibles n’est que partiellement couverte par la documentation officielle de BigBlueButton. De nombreux paramètres proviennent de l’analyse du code source de settings.yml et peuvent changer entre les versions sans préavis. undocumented

Fonctionnement des paramètres userdata

Les paramètres userdata sont transmis comme paramètres de requête URL dans la requête join. Ils remplacent les valeurs par défaut de settings.yml pour cette seule session utilisateur. Les noms de paramètres commencent toujours par le préfixe userdata- suivi de la clé du paramètre. 

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

Étant donné que les paramètres userdata font partie de la chaîne de requête, ils sont inclus dans le calcul du checksum. Assurez-vous de les ajouter avant de calculer le checksum, et non après.

Paramètres audio et multimédia

Paramètre Type Par défaut Description
userdata-bbb_auto_join_audio Boolean — Rejoindre automatiquement le pont audio lorsque l’utilisateur entre dans la réunion.
userdata-bbb_listen_only_mode Boolean — Activer ou désactiver le mode listen-only pour l’utilisateur.
userdata-bbb_force_listen_only Boolean — Forcer l’utilisateur en mode listen-only. Cela ne s’applique pas aux modérateurs.
userdata-bbb_skip_check_audio Boolean — Ignorer la boîte de dialogue de test audio lors de la connexion.
userdata-bbb_skip_echotest_if_previous_device Boolean — Ignorer le test d’écho si le même périphérique audio que lors de la session précédente est détecté.

Paramètres de webcam

Paramètre Type Par défaut Description
userdata-bbb_auto_share_webcam Boolean — Commencer automatiquement le partage de la webcam lorsque l’utilisateur rejoint la réunion.
userdata-bbb_mirror_own_webcam Boolean — Miroir horizontal de l’aperçu de la propre webcam de l’utilisateur.

Paramètres de mise en page et d’affichage

Paramètre Type Par défaut Description
userdata-bbb_auto_swap_layout Boolean — Basculer automatiquement la mise en page lorsqu’une présentation est partagée.
userdata-bbb_default_layout String — Définir la mise en page par défaut pour l’utilisateur. Les valeurs disponibles dépendent de la configuration du client. undocumented
userdata-bbb_hide_presentation Boolean — Masquer la zone de présentation pour l’utilisateur.
userdata-bbb_prefer_dark_theme Boolean — Activer le thème sombre pour l’interface utilisateur.

Paramètres de personnalisation et de marque

Paramètre Type Par défaut Description
userdata-bbb_custom_style String — Règles CSS en ligne (encodées URL) appliquées au client BigBlueButton pour cet utilisateur.
userdata-bbb_custom_style_url URL — URL vers un fichier CSS externe chargé par le client pour un style personnalisé. Doit être servi via HTTPS.

Le paramètre userdata-bbb_custom_style peut être exploité pour cross-site scripting si les URL join sont construites côté client. Générez toujours les URL join sur le serveur, où vous contrôlez les valeurs des paramètres.

Paramètres des éléments de l’interface utilisateur

Paramètre Type Par défaut Description
userdata-bbb_hide_notifications Boolean — Masquer les fenêtres contextuelles de notification dans l’interface du client.
userdata-bbb_hide_controls Boolean — Masquer les éléments de contrôle de l’interface (boutons de la barre d’outils) pour l’utilisateur.
userdata-bbb_shortcuts String — Définir des raccourcis clavier personnalisés pour l’utilisateur.

Paramètres d’enregistrement et de contrôle externe

Paramètre Type Par défaut Description
userdata-bbb_outside_toggle_recording Boolean — Autoriser une application externe à activer et désactiver l’enregistrement de la réunion.
userdata-bbb_outside_toggle_self_voice Boolean — Autoriser une application externe à activer et désactiver l’audio de l’utilisateur.

Paramètres du tableau blanc

Paramètre Type Par défaut Description
userdata-bbb_initial_selected_tool String — Définissez l’outil de tableau blanc sélectionné initialement lorsque l’utilisateur ouvre le tableau blanc. Les valeurs acceptées sont déterminées par la configuration du client. undocumented

Exemples pratiques

Vous trouverez ci-dessous des combinaisons courantes de paramètres userdata pour des cas d’usage typiques.

Mode kiosque

Idéal pour les écrans de salles de conférence ou l’affichage dynamique lorsqu’aucune interaction utilisateur n’est requise : 

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

Image de marque spécifique au locataire

Appliquer une feuille de style CSS personnalisée par locataire ou client : 

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

Rejoindre rapidement en mode accessible

Simplifiez le processus de connexion pour les utilisateurs ayant besoin d’une expérience simplifiée et accessible : 

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

Remarques importantes

  • Les paramètres userdata n’affectent que la session actuelle de l’utilisateur individuel. Ils ne modifient pas les valeurs par défaut du serveur.
  • Tous les paramètres ne sont pas disponibles dans chaque version de BigBlueButton. Testez avec votre version cible avant le déploiement.
  • CSS chargé via userdata-bbb_custom_style_url doit être servi via HTTPS.

Lors de l’utilisation du point de terminaison getJoinUrl, certains paramètres userdata sont bloqués pour les spectateurs (rôle VIEWER) comme mesure de sécurité. La liste de blocage est configurée côté serveur via la propriété getJoinUrlUserdataBlocklist dans bigbluebutton.properties. Cela empêche les spectateurs de remplacer des paramètres client critiques pour la sécurité via des URL join pré-signées. undocumented

Foire aux questions

Non. Les paramètres userdata s’appliquent uniquement à la session unique initiée par l’appel join. Si l’utilisateur quitte puis rejoint à nouveau, les paramètres doivent être inclus de nouveau dans la nouvelle URL join.

Non. Les paramètres userdata sont conçus uniquement pour le point de terminaison join. Ils sont traités par le client lorsqu’un utilisateur rejoint une réunion et n’ont aucun effet sur l’appel create.

Oui. Comme ils font partie de la chaîne de requête de l’URL, ils sont inclus dans le calcul du checksum. Vous devez ajouter tous les paramètres userdata à la chaîne de requête avant de calculer le checksum.

Non. Le paramètre userdata-bbb_force_listen_only ne s’applique qu’aux spectateurs. Les modérateurs ne sont pas forcés en mode listen-only, indépendamment de ce paramètre.

La documentation officielle n’en couvre qu’un sous-ensemble. La liste la plus complète et la plus à jour se trouve dans le fichier settings.yml au sein du code source du client BigBlueButton. De nouveaux paramètres sont fréquemment ajoutés sans mise à jour de la documentation.