insertDocument – Sunum Ekle

insertDocument uç noktası, mevcut sunucuyu kesintiye uğratmadan, hâlihazırda çalışmakta olan bir BigBlueButton toplantısına bir veya daha fazla sunum yüklemenize olanak tanır. Belgeler arka planda işlenir ve sunucunun istediği zaman geçiş yapabileceği ek sunumlar olarak kullanılabilir hâle gelir.

Uç Nokta

POST https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum
Content-Type: application/xml

URL Parametreleri

XML Gövdesi — Belge Öznitelikleri

İstek gövdesi, bir veya daha fazla XML öğesini saran bir <module name="presentation"> öğesi içeren bir <document> yapısı içermelidir. Her belge, URL ile veya satır içi Base64 içeriği olarak yüklenebilir.

Örnek İstek — URL Tabanlı Yükleme

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum" \
  --header "Content-Type: application/xml" \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<modules>
  <module name="presentation">
        <document url="https://api-guide.bbbserver.com/files/slides.pdf" filename="slides.pdf"
              downloadable="true" removable="true" current="true"/>
  </module>
</modules>'

Örnek İstek — Base64 Satır İçi Yükleme

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/insertDocument?meetingID=replace-with-meeting-id&checksum=replace-with-checksum" \
  --header "Content-Type: application/xml" \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<modules>
  <module name="presentation">
    <document name="inline-slides.pdf">
      JVBERi0xLjQK... (Base64-encoded content)
    </document>
  </module>
</modules>'

Örnek Yanıt

Başarılı bir çağrı aşağıdaki XML değerini döndürür:

<response>
  <returncode>SUCCESS</returncode>
</response>

create Sunum Yükleme ile Karşılaştırma

Sunumları toplantı oluşturulurken create uç noktasıyla da yükleyebilirsiniz. Aşağıdaki tablo iki yaklaşım arasındaki farkları vurgular:

İpuçları

• Normal sunum yüklemede desteklenen aynı dosya biçimleri burada da desteklenir (PDF, PPTX, DOCX, görseller vb.).
• Modül bloğu içine daha fazla belge öğesi ekleyerek tek bir istekte birden fazla belge ekleyebilirsiniz.
• URL tabanlı yüklemelerde, URL tanınabilir bir dosya uzantısı içermediğinde filename özniteliğini her zaman ayarlayın. Bu, BigBlueButton'nin doğru dosya türünü belirlemesine yardımcı olur.
• Büyük dosyalar için, istek yükünü küçük tutmak amacıyla Base64 satır içi yükleme yerine URL tabanlı yükleme önerilir.

Kullanım Senaryoları

• Canlı oturum sırasında bir LMS veya içerik yönetim sisteminden slaytları dinamik olarak sunun.
• Toplantı başladıktan sonra toplantıya ek materyal ekleyin.
• Gündemleri, toplantı notlarını veya raporları devam eden toplantılara ekleyen otomatik botlar oluşturun.
• Dış sistemlerin, sunucunun toplantıdan ayrılmasını gerektirmeden güncellenmiş içerik göndermesine izin verin.