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.
getRecordingTextTracks – Metin İzleri
getRecordingTextTracks uç noktası, belirli bir kayda bağlı tüm altyazı ve caption izlerinin bir listesini döndürür. Çoğu BigBlueButton API uç noktasından farklı olarak, yanıt XML yerine JSON biçiminde döndürülür.
Uç Nokta
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?<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. Metin izlerini almak istediğiniz kaydın recording ID'si. Yalnızca tek bir recording ID kabul edilir — virgülle ayrılmış listeler desteklenmez. |
Diğer kayıt endpoint'lerinden farklı olarak, getRecordingTextTracks yalnızca tek bir recordID değeri kabul eder. Virgülle ayrılmış birden fazla ID göndermek hataya veya beklenmeyen davranışa yol açar.
Yanıt Alanları
Yanıttaki her track nesnesi aşağıdaki öznitelikleri içerir:
| Alan | Tür | Açıklama |
|---|---|---|
href | String | WebVTT biçimindeki metin izi dosyasının indirme URL'si. URL, bir saat sonra süresi dolan tek kullanımlık bir belirteç içerir. |
kind | String | HTML5 video öğesi spesifikasyonunu izleyen metin izinin türü. Olası değerler: subtitles veya captions. |
label | String | Kayıt oynatma arayüzündeki altyazı seçim menüsünde gösterilen görünen ad. |
lang | String | RFC 5646 tarafından tanımlanan dil etiketi (ör. en-US, de-DE, pt-BR). |
source | String | Metin izinin kaynağı. Bilinen değerler: live (toplantı sırasında canlı transkripsiyon), automatic (konuşma tanıma yoluyla makine tarafından oluşturulan), upload (manuel olarak yüklenen). |
Örnek İstek
curl --request GET \
"https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?recordID=replace-with-recording-id&checksum=replace-with-checksum" Örnek Yanıt
Başarılı
{
"response": {
"returncode": "SUCCESS",
"tracks": [
{
"href": "https://api-guide.bbbserver.com/bigbluebutton/textTrack/replace-with-token/replace-with-recording-id/subtitles_de-DE.vtt",
"kind": "subtitles",
"label": "Deutsch",
"lang": "de-DE",
"source": "upload"
},
{
"href": "https://api-guide.bbbserver.com/bigbluebutton/textTrack/replace-with-token/replace-with-recording-id/subtitles_en-US.vtt",
"kind": "subtitles",
"label": "English",
"lang": "en-US",
"source": "live"
}
]
}
} Hata — Kayıt Kimliği Eksik
{
"response": {
"returncode": "FAILED",
"messageKey": "missingParamRecordID",
"message": "You must specify a recordID."
}
} Hata Yanıtları
| Mesaj Anahtarı | Açıklama |
|---|---|
checksumError | checksum geçersiz veya istek parametreleriyle eşleşmiyor. |
missingParamRecordID | Gerekli recordID parametresi istekte sağlanmadı. |
noRecordings | Belirtilen recording ID ile eşleşen bir kayıt bulunamadı. |
İpuçları
putRecordingTextTrack gibi, bu uç nokta da yanıtı JSON biçiminde döndürür; XML biçiminde döndürmez. API istemcinizin yanıtı ayrıştırırken bu farkı dikkate aldığından emin olun.
- Kullanıcılarınız için bir altyazı seçim arayüzü oluştururken izleri dile göre filtrelemek için
langalanını kullanın. hrefalanı,WebVTTdosyasına bir indirme bağlantısı sağlar. Bağlantı, bir saat geçerli olan tek kullanımlık bir belirteç içerir; bu nedenle bağlantıyı saklamak veya bir yere gömmek yerine dosyayı hemen indirin.- Kalitesi değişebilecek şekilde, elle yüklenmiş caption'lar ile otomatik olarak oluşturulmuş olanları ayırt etmek için
sourcealanını kontrol edin. - Metin izleri eklemek veya güncellemek için eşlik eden
putRecordingTextTrackendpoint'ini kullanın.
Sıkça Sorulan Sorular
getRecordingTextTracks uç noktası, BigBlueButton API evriminin daha sonraki bir aşamasında eklenmiştir ve en baştan JSON döndürecek şekilde tasarlanmıştır. Bu, BigBlueButton API yanıtlarının XML kullandığı genel kuralın bir istisnasıdır. İstemci kodunuzun bu biçim farkını buna göre ele alması gerekir.getRecordingTextTracks istek başına yalnızca tek bir recordID kabul eder. Birden fazla kaydın izlerini almak için her kayıt için ayrı API çağrıları göndermelisiniz.HTML5 video oynatımı için standart altyazı biçimi olan WebVTT (Web Video Text Tracks) formatında sağlanır. Dosya, yanıttaki href alanında verilen URL'den doğrudan indirilebilir.kind alanı, belirli bir izin hangi türde olduğunu gösterir.live (toplantı sırasında canlı transkripsiyon yoluyla oluşturulan), automatic (konuşma tanıma yoluyla makine tarafından oluşturulan) ve upload (bir kullanıcı tarafından manuel olarak yüklenen).