Je bekijkt de API-documentatie voor BigBlueButton 3.x. De huidige versie is BigBlueButton 4.x. Plan je een upgrade? De migratiehandleiding vermeldt alle wijzigingen die je in je API-aanroepen moet aanbrengen.
getRecordingTextTracks – Tekstsporen
Het endpoint getRecordingTextTracks retourneert een lijst van alle ondertitel- en captiontracks die aan een specifieke opname zijn gekoppeld. In tegenstelling tot de meeste BigBlueButton-API-endpoints wordt de response geretourneerd in JSON-formaat in plaats van XML.
Endpoint
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?<parameter>&checksum=replace-with-checksum Zowel de methoden GET als POST worden ondersteund. Bij gebruik van POST stuur je parameters als application/x-www-form-urlencoded in de requestbody.
Parameters
| Parameter | Type | Beschrijving |
|---|---|---|
recordID | String | Vereist. De opname-ID van de opname waarvan je de teksttracks wilt ophalen. Er wordt slechts één opname-ID geaccepteerd — door komma's gescheiden lijsten worden niet ondersteund. |
In tegenstelling tot andere recording-endpoints accepteert getRecordingTextTracks alleen één enkele recordID-waarde. Het doorgeven van meerdere door komma's gescheiden ID's resulteert in een fout of onverwacht gedrag.
Responsvelden
Elk trackobject in de respons bevat de volgende attributen:
| Veld | Type | Beschrijving |
|---|---|---|
href | String | De download-URL voor het tekstspoorbestand in WebVTT-formaat. De URL bevat een token voor eenmalig gebruik dat na één uur verloopt. |
kind | String | Het type texttrack, volgens de specificatie van het HTML5-video-element. Mogelijke waarden: subtitles of captions. |
label | String | De weergegeven naam die wordt getoond in het ondertitelselectiemenu van de opname-afspeelinterface. |
lang | String | De taalcode zoals gedefinieerd door RFC 5646 (bijv. en-US, de-DE, pt-BR). |
source | String | De oorsprong van het tekstspoor. Bekende waarden: live (livetranscriptie tijdens de vergadering), automatic (automatisch gegenereerd via spraakherkenning), upload (handmatig geüpload). |
Voorbeeldverzoek
curl --request GET \
"https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?recordID=replace-with-recording-id&checksum=replace-with-checksum" Voorbeeldrespons
Succes
{
"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"
}
]
}
} Fout — Ontbrekende record-ID
{
"response": {
"returncode": "FAILED",
"messageKey": "missingParamRecordID",
"message": "You must specify a recordID."
}
} Foutresponses
| Berichtsleutel | Beschrijving |
|---|---|
checksumError | De checksum is ongeldig of komt niet overeen met de requestparameters. |
missingParamRecordID | De vereiste parameter recordID is niet opgegeven in de request. |
noRecordings | Er is geen opname gevonden die overeenkomt met de opgegeven opname-ID. |
Tips
Net als putRecordingTextTrack retourneert dit eindpunt JSON in plaats van XML. Zorg ervoor dat je API-client bij het parseren van het antwoord rekening houdt met dit verschil.
- Gebruik het veld
langom tracks op taal te filteren bij het bouwen van een UI voor ondertitelselectie voor je gebruikers. - Het veld
hrefbevat een downloadlink naar hetWebVTT-bestand. De link bevat een token voor eenmalig gebruik dat één uur geldig is. Download het bestand dus meteen in plaats van de link op te slaan of in te sluiten. - Controleer het veld
sourceom onderscheid te maken tussen handmatig geüploade captions en automatisch gegenereerde captions, die in kwaliteit kunnen verschillen. - Gebruik het bijbehorende endpoint
putRecordingTextTrackom teksttracks toe te voegen of bij te werken.
Veelgestelde vragen
getRecordingTextTracks is later toegevoegd in de evolutie van de BigBlueButton-API en is vanaf het begin ontworpen om JSON te retourneren. Dit is een uitzondering op de algemene regel dat responses van de BigBlueButton-API XML gebruiken. Je clientcode moet dit formaatverschil dienovereenkomstig afhandelen.getRecordingTextTracks slechts één enkele recordID per request. Om tracks voor meerdere opnames op te halen, moet je voor elke opname afzonderlijke API-calls versturen.WebVTT-formaat (Web Video Text Tracks), het standaard ondertitelingsformaat voor HTML5-videoweergave. Het bestand kan rechtstreeks worden gedownload via de URL in het veld href van de response.kind in de response geeft aan om welk type een bepaalde track gaat.live (tijdens de vergadering gegenereerd via livetranscriptie), automatic (automatisch gegenereerd via spraakherkenning) en upload (handmatig geüpload door een gebruiker).