API sürümü: 4.x en güncel 3.x

BigBlueButton 3.x için API dokümantasyonunu görüntülüyorsunuz. Güncel sürüm: BigBlueButton 4.x. Yükseltme mi planlıyorsunuz? Geçiş kılavuzu, API çağrılarınızda yapmanız gereken tüm değişiklikleri listeler.

Bölüm 12 GET

publishRecordings – Yayımla/Yayından Kaldır

publishRecordings uç noktası, bir veya daha fazla kaydın görünürlüğünü değiştirir. Kayıtları oynatma URL'leri üzerinden erişilebilir hâle getirmek için yayımlayabilir veya dosyaları sunucuda tutarken izleyicilerden gizlemek için yayından kaldırabilirsiniz.

Uç Nokta

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings?<parameter>&checksum=replace-with-checksum

Bu uç nokta yalnızca GET isteklerini destekler. POST istekleri kabul edilmez.

Parametreler

Parametre Tür Açıklama
recordID String Gerekli. Yayımlanacak veya yayından kaldırılacak kayıt kimliklerinin virgülle ayrılmış listesi. Tek bir istekte bir veya daha fazla kimlik belirtebilirsiniz.
publish Boolean Gerekli. Kayıtları yayımlamak (erişilebilir hale getirmek) için true, yayından kaldırmak (izleyicilerden gizlemek) için false olarak ayarlayın.

Örnek İstek

Tek Bir Kaydı Yayımla

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id
  &publish=true
    &checksum=replace-with-checksum

Birden Fazla Kaydı Yayından Kaldır

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id-1,replace-with-recording-id-2
  &publish=false
    &checksum=replace-with-checksum

Örnek Yanıt

Başarılı

<response>
  <returncode>SUCCESS</returncode>
  <published>true</published>
</response>

Hata — Kayıt Bulunamadı

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find recordings</message>
</response>

Hata Yanıtları

messageKey Açıklama
checksumError checksum geçersiz. Doğru paylaşılan gizli anahtarı kullandığınızı ve checksum algoritmasının sunucu yapılandırmasıyla eşleştiğini doğrulayın.
missingParamRecordID Gerekli recordID parametresi sağlanmadı.
missingParamPublish Gerekli publish parametresi sağlanmadı.
notFound Belirtilen kayıt kimliklerinden hiçbiriyle eşleşen bir kayıt bulunamadı.

İpuçları

Kayıtlarınızın görünürlüğünü değiştirmeden önce mevcut yayımlanma durumunu almak için getRecordings uç noktasını kullanın. Yanıttaki published alanı, her kaydın şu anda görünür olup olmadığını gösterir.

  • Yayımlanmış bir kayda oynatma URL'si üzerinden erişilebilir. Yayımlanmamış bir kayıt sunucuda kalır.
  • Bu işlem tamamen geri alınabilir — kayıtlar istenildiği kadar yayımlanıp yayından kaldırılabilir.
  • Tek bir istekte kayıt kimliklerinin virgülle ayrılmış listesini göndererek birden fazla kaydı toplu olarak işleyebilirsiniz.
  • Bir kaydı yalnızca gizlemek yerine kalıcı olarak kaldırmak istiyorsanız, deleteRecordings uç noktasını kullanın.

BigBlueButton ile bbbserver.de arasındaki farklılık
bbbserver Integration-API'de bir kaydı yayından kaldırırsanız, API'de unpublished olarak gösterilir ve harici hizmetler kaydı buna göre işler. Ancak oynatma bağlantısı biliniyorsa kaydın kendisi yine de açılabilir.

Birden fazla kayıt kimliği gönderdiğinizde ve bunlardan en az biri geçerliyse, çağrı SUCCESS döndürür. Yalnızca sağlanan kimliklerin hiçbiri mevcut bir kayıtla eşleşmezse sunucu FAILED ve notFound hatasını döndürür.

Sıkça Sorulan Sorular

Bir kaydı yayından kaldırmak, kaydı izleyicilerden gizler ancak kayıt dosyalarını sunucuda tutar. Kaydı istediğiniz zaman yeniden yayımlayabilirsiniz. Bir kaydı silmek, onu deleted durumuna geçirir: kayıt artık oynatılamaz ve API aracılığıyla geri yüklenemez.

Evet. recordID parametresine virgülle ayrılmış bir kayıt kimliği listesi verin. Belirtilen tüm kayıtlar tek bir istekte aynı yayımlanma durumuna ayarlanır.

Sağlanan kayıt kimliklerinden en az biri geçerliyse, çağrı SUCCESS döndürür ve değişikliği tüm geçerli kayıtlara uygular. Sunucu yalnızca kimliklerin hiçbiri mevcut bir kayıtla eşleşmezse FAILED ile notFound döndürür.

getRecordings uç noktasını kullanın ve yanıt XML'indeki published alanını inceleyin. Yayımlanmış kayıtlar için true, yayımlanmamış olanlar için false olarak ayarlanır.