Bölüm 19

userdata – İstemci Ayarları

Userdata parametreleri, userdata- API çağrısına join önekli parametreler ekleyerek istemci tarafı ayarlarını kullanıcı bazında geçersiz kılmanıza olanak tanır. Bu, sunucu yapılandırmasını değiştirmeden tek tek katılımcılar için BigBlueButton deneyimini özelleştirmenizi sağlar.

Kullanılabilir userdata parametrelerinin listesi, resmî BigBlueButton dokümantasyonunda yalnızca kısmen ele alınmıştır. Birçok parametre settings.yml kaynak kodu analizinden türetilmiştir ve sürümler arasında haber verilmeksizin değişebilir. undocumented

Userdata Parametreleri Nasıl Çalışır

Userdata parametreleri, join isteğinde URL sorgu parametreleri olarak geçirilir. Yalnızca o tek kullanıcı oturumu için settings.yml içindeki varsayılan değerleri geçersiz kılarlar. Parametre adları her zaman ayar anahtarını izleyen userdata- önekiyle başlar. 

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 parametreleri sorgu dizesinin parçası olduğundan, checksum hesaplamasına dahil edilirler. Bu nedenle checksum değerini hesaplamadan önce eklediğinizden emin olun; sonra değil.

Ses ve Medya Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_auto_join_audio Boolean — Kullanıcı toplantıya girdiğinde ses köprüsüne otomatik olarak katıl.
userdata-bbb_listen_only_mode Boolean — Kullanıcı için listen-only modunu etkinleştirin veya devre dışı bırakın.
userdata-bbb_force_listen_only Boolean — Kullanıcıyı zorunlu olarak listen-only moduna alın. Bu moderatörler için geçerli değildir.
userdata-bbb_skip_check_audio Boolean — Katılırken ses testi iletişim kutusunu atlayın.
userdata-bbb_skip_echotest_if_previous_device Boolean — Önceki oturumla aynı ses aygıtı algılanırsa yankı testini atlayın.

Webcam Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_auto_share_webcam Boolean — Kullanıcı katıldığında web kamerası paylaşımını otomatik olarak başlatın.
userdata-bbb_mirror_own_webcam Boolean — Kullanıcının kendi web kamerası önizlemesini yatay olarak aynalayın.

Yerleşim ve Görüntüleme Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_auto_swap_layout Boolean — Bir sunum paylaşıldığında yerleşimi otomatik olarak değiştirin.
userdata-bbb_default_layout String — Kullanıcı için varsayılan yerleşimi ayarlayın. Kullanılabilir değerler istemci yapılandırmasına bağlıdır. undocumented
userdata-bbb_hide_presentation Boolean — Sunum alanını kullanıcıdan gizleyin.
userdata-bbb_prefer_dark_theme Boolean — Kullanıcı arayüzü için koyu temayı etkinleştirin.

Özelleştirme ve Markalama Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_custom_style String — Bu kullanıcı için CSS istemcisine uygulanan satır içi BigBlueButton kuralları (URL-encoded).
userdata-bbb_custom_style_url URL — Özel stil için istemci tarafından yüklenen harici bir CSS dosyasının URL'si. HTTPS üzerinden sunulmalıdır.

userdata-bbb_custom_style parametresi, cross-site scripting URL'leri istemci tarafında oluşturulursa join için istismar edilebilir. Parametre değerlerini kontrol ettiğiniz sunucu tarafında her zaman join URL'leri oluşturun.

Kullanıcı Arayüzü Öğesi Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_hide_notifications Boolean — İstemci arayüzündeki bildirim açılır pencerelerini gizleyin.
userdata-bbb_hide_controls Boolean — Kullanıcıdan UI kontrol öğelerini (araç çubuğu düğmeleri) gizleyin.
userdata-bbb_shortcuts String — Kullanıcı için özel klavye kısayolları tanımlayın.

Kayıt ve Haricî Denetim Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_outside_toggle_recording Boolean — Harici bir uygulamanın toplantı kaydını açıp kapatmasına izin verin.
userdata-bbb_outside_toggle_self_voice Boolean — Harici bir uygulamanın kullanıcının sesini açıp kapatmasına izin verin.

Beyaz Tahta Parametreleri

Parametre Tür Varsayılan Açıklama
userdata-bbb_initial_selected_tool String — Kullanıcı beyaz tahtayı açtığında başlangıçta seçili olacak beyaz tahta aracını ayarlayın. Kabul edilen değerler istemci yapılandırmasına göre belirlenir. undocumented

Pratik Örnekler

Aşağıda tipik kullanım senaryoları için userdata parametrelerinin yaygın kombinasyonları yer almaktadır.

Kiosk Modu

Kullanıcı etkileşiminin gerekmediği konferans odası ekranları veya dijital tabelalar için idealdir: 

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

Kiracıya Özel Markalama

Kiracı veya müşteri başına özel bir CSS stil sayfası uygulayın: 

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

Erişilebilir Hızlı Katılım

Basitleştirilmiş ve erişilebilir bir deneyime ihtiyaç duyan kullanıcılar için katılım sürecini kolaylaştırın: 

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

Önemli Notlar

  • Userdata parametreleri yalnızca ilgili kullanıcının mevcut oturumunu etkiler. Sunucunun varsayılanlarını değiştirmezler.
  • Tüm parametreler her BigBlueButton sürümünde mevcut değildir. Yayınlamadan önce hedef sürümünüzde test edin.
  • CSSuserdata-bbb_custom_style_url aracılığıyla yüklenen , HTTPS üzerinden sunulmalıdır.

getJoinUrl uç noktası kullanıldığında, belirli userdata parametreleri güvenlik önlemi olarak izleyiciler (rol VIEWER) için engellenir. Engelleme listesi, getJoinUrlUserdataBlocklist içindeki bigbluebutton.properties özelliği aracılığıyla sunucu tarafında yapılandırılır. Bu, izleyicilerin önceden imzalanmış join URL'leri üzerinden güvenlik açısından kritik istemci ayarlarını geçersiz kılmasını önler. undocumented

Sıkça Sorulan Sorular

Hayır. Userdata parametreleri yalnızca join çağrısı tarafından başlatılan tek oturuma uygulanır. Kullanıcı ayrılır ve tekrar katılırsa, parametreler yeni join URL'sine yeniden dahil edilmelidir.

Hayır. Userdata parametreleri yalnızca join uç noktası için tasarlanmıştır. Bir kullanıcı toplantıya katıldığında istemci tarafından işlenirler ve create çağrısı üzerinde hiçbir etkileri yoktur.

Evet. URL sorgu dizesinin parçası oldukları için checksum hesaplamasına dahil edilirler. checksum hesaplanmadan önce tüm userdata parametrelerini sorgu dizesine eklemelisiniz.

Hayır. userdata-bbb_force_listen_only parametresi yalnızca izleyiciler için geçerlidir. Moderatörler bu ayardan bağımsız olarak listen-only moduna zorlanmaz.

Resmî dokümantasyon yalnızca bir alt kümeyi kapsar. En eksiksiz ve güncel liste, istemci kaynak kodu içindeki settings.ymlBigBlueButton dosyasında bulunur. Yeni parametreler sık sık dokümantasyon güncellemesi olmadan eklenir.