Bölüm 12 GET POST

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/POST https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings?<parameter>&checksum=replace-with-checksum

Hem GET hem de POST yöntemleri desteklenir. POST kullanırken, parametreleri istek gövdesinde application/x-www-form-urlencoded olarak gönderin.

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

cURL ile POST İsteği

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&publish=true&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ından kaldırılmış bir kayıt sunucuda kalır ancak izleyiciler tarafından erişilemez.
  • 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.

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, onu izleyicilerden gizler ancak kayıt dosyalarını sunucuda tutar. İstediğiniz zaman yeniden yayımlayabilirsiniz. Bir kaydı silmek ise dosyaları sunucudan kalıcı olarak kaldırır ve geri alınamaz.

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.

Bir kaydı yayından kaldırmak, oynatma URL'sini erişilemez hale getirir. O anda kaydı izlemekte olan kullanıcılar, oynatma istemcisinin bu değişikliği nasıl ele aldığına bağlı olarak bir kesinti yaşayabilir.