Du ser API-dokumentationen til BigBlueButton 3.x. Den aktuelle version er BigBlueButton 4.x. Planlægger du en opgradering? Migreringsvejledningen viser alle de ændringer, dine API-kald kræver.
getRecordingTextTracks – Tekstspor
Endpointet getRecordingTextTracks returnerer en liste over alle undertekst- og caption-spor, der er knyttet til en bestemt optagelse. I modsætning til de fleste BigBlueButton API-endpoints returneres svaret i JSON-format i stedet for XML.
Endepunkt
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?<parameter>&checksum=replace-with-checksum Både GET- og POST-metoder understøttes. Ved brug af POST skal parametre sendes som application/x-www-form-urlencoded i request body.
Parametre
| Parameter | Type | Beskrivelse |
|---|---|---|
recordID | String | Påkrævet. Optagelses-ID'et for den optagelse, hvis tekstspor du vil hente. Kun ét enkelt optagelses-ID accepteres — kommaseparerede lister understøttes ikke. |
I modsætning til andre optagelses-endpoints accepterer getRecordingTextTracks kun én enkelt værdi for recordID. Hvis du sender flere kommaseparerede ID'er, vil det resultere i en fejl eller uventet adfærd.
Svarfelter
Hvert sporobjekt i svaret indeholder følgende attributter:
| Felt | Type | Beskrivelse |
|---|---|---|
href | String | Download-URL'en til tekstsporsfilen i WebVTT-format. URL'en indeholder et engangstoken, der udløber efter en time. |
kind | String | Typen af tekstspor, i overensstemmelse med specifikationen for HTML5-videoelementet. Mulige værdier: subtitles eller captions. |
label | String | Det viste navn, der vises i menuen til valg af undertekster i optagelsens afspilningsgrænseflade. |
lang | String | Sprog-tagget som defineret af RFC 5646 (f.eks. en-US, de-DE, pt-BR). |
source | String | Tekstsporets oprindelse. Kendte værdier: live (livetransskription under mødet), automatic (maskingenereret via talegenkendelse), upload (uploadet manuelt). |
Eksempel på anmodning
curl --request GET \
"https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?recordID=replace-with-recording-id&checksum=replace-with-checksum" Eksempelsvar
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"
}
]
}
} Fejl — Manglende post-ID
{
"response": {
"returncode": "FAILED",
"messageKey": "missingParamRecordID",
"message": "You must specify a recordID."
}
} Fejlsvar
| Beskednøgle | Beskrivelse |
|---|---|
checksumError | checksum er ugyldig eller matcher ikke request-parametrene. |
missingParamRecordID | Den påkrævede parameter recordID blev ikke angivet i requesten. |
noRecordings | Der blev ikke fundet nogen optagelse, der matcher det angivne optagelses-ID. |
Tips
Ligesom putRecordingTextTrack returnerer dette endepunkt JSON i stedet for XML. Sørg for, at din API-klient håndterer denne forskel, når svaret parses.
- Brug feltet
langtil at filtrere spor efter sprog, når du bygger en brugerflade til valg af undertekster for dine brugere. - Feltet
hrefindeholder et downloadlink tilWebVTT-filen. Linket indeholder et engangstoken, der er gyldigt i en time, så download filen med det samme i stedet for at gemme eller indlejre linket. - Kontrollér feltet
sourcefor at skelne mellem manuelt uploadede billedtekster og automatisk genererede, som kan variere i kvalitet. - For at tilføje eller opdatere tekstspor skal du bruge det tilhørende endpoint
putRecordingTextTrack.
Ofte stillede spørgsmål
getRecordingTextTracks blev tilføjet senere i udviklingen af BigBlueButton API'et og blev designet til at returnere JSON fra starten. Dette er en undtagelse fra den generelle regel om, at BigBlueButton API-svar bruger XML. Din klientkode skal håndtere denne formatforskel tilsvarende.getRecordingTextTracks kun ét enkelt recordID pr. request. For at hente spor for flere optagelser skal du sende separate API-kald for hver optagelse.WebVTT-format (Web Video Text Tracks), standardformatet for undertekster til HTML5-videoafspilning. Filen kan downloades direkte fra den URL, der er angivet i feltet href i svaret.kind i svaret angiver, hvilken type et givet spor er.live (genereret under mødet via livetransskription), automatic (maskingenereret via talegenkendelse) og upload (uploadet manuelt af en bruger).