Estás viendo la documentación de la API de BigBlueButton 3.x. La versión actual es BigBlueButton 4.x. ¿Planeas una actualización? La guía de migración enumera todos los cambios que necesitan tus llamadas a la API.
getRecordingTextTracks – Pistas de texto
El endpoint getRecordingTextTracks devuelve una lista de todas las pistas de subtítulos y captions asociadas a una grabación específica. A diferencia de la mayoría de los endpoints de la API de BigBlueButton, la respuesta se devuelve en formato JSON en lugar de XML.
Endpoint
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?<parameter>&checksum=replace-with-checksum Se admiten los métodos GET y POST. Al usar POST, envía los parámetros como application/x-www-form-urlencoded en el cuerpo de la solicitud.
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
recordID | String | Obligatorio. El ID de la grabación de la cual quieres recuperar las pistas de texto. Solo se acepta un único ID de grabación; no se admiten listas separadas por comas. |
A diferencia de otros endpoints de grabación, getRecordingTextTracks solo acepta un único valor de recordID. Pasar varios IDs separados por comas dará lugar a un error o a un comportamiento inesperado.
Campos de respuesta
Cada objeto de pista en la respuesta contiene los siguientes atributos:
| Campo | Tipo | Descripción |
|---|---|---|
href | String | La URL de descarga del archivo de pista de texto en formato WebVTT. La URL contiene un token de un solo uso que caduca al cabo de una hora. |
kind | String | El tipo de pista de texto, siguiendo la especificación del elemento de vídeo HTML5. Valores posibles: subtitles o captions. |
label | String | El nombre para mostrar que aparece en el menú de selección de subtítulos de la interfaz de reproducción de la grabación. |
lang | String | La etiqueta de idioma según se define en RFC 5646 (p. ej., en-US, de-DE, pt-BR). |
source | String | El origen de la pista de texto. Valores conocidos: live (transcripción en directo durante la reunión), automatic (generada automáticamente mediante reconocimiento de voz), upload (cargada manualmente). |
Ejemplo de solicitud
curl --request GET \
"https://api-guide.bbbserver.com/bigbluebutton/api/getRecordingTextTracks?recordID=replace-with-recording-id&checksum=replace-with-checksum" Respuesta de ejemplo
Éxito
{
"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"
}
]
}
} Error — Falta el ID del registro
{
"response": {
"returncode": "FAILED",
"messageKey": "missingParamRecordID",
"message": "You must specify a recordID."
}
} Respuestas de error
| Clave del mensaje | Descripción |
|---|---|
checksumError | El checksum es inválido o no coincide con los parámetros de la solicitud. |
missingParamRecordID | El parámetro obligatorio recordID no se proporcionó en la solicitud. |
noRecordings | No se encontró ninguna grabación que coincida con el ID de grabación especificado. |
Consejos
Al igual que putRecordingTextTrack, este endpoint devuelve JSON en lugar de XML. Asegúrate de que tu cliente de API gestione esta diferencia al analizar la respuesta.
- Usa el campo
langpara filtrar pistas por idioma al crear una interfaz de selección de subtítulos para tus usuarios. - El campo
hrefproporciona un enlace de descarga al archivoWebVTT. El enlace contiene un token de un solo uso válido durante una hora, así que descarga el archivo de inmediato en lugar de almacenar o insertar el enlace. - Comprueba el campo
sourcepara distinguir entre subtítulos subidos manualmente y los generados automáticamente, cuya calidad puede variar. - Para añadir o actualizar pistas de texto, usa el endpoint complementario
putRecordingTextTrack.
Preguntas frecuentes
getRecordingTextTracks se añadió más tarde en la evolución de la API de BigBlueButton y fue diseñado para devolver JSON desde el principio. Esta es una excepción a la regla general de que las respuestas de la API de BigBlueButton usan XML. Tu código cliente debe gestionar esta diferencia de formato en consecuencia.getRecordingTextTracks solo acepta un único recordID por solicitud. Para recuperar pistas de varias grabaciones, debes enviar llamadas API separadas para cada grabación.WebVTT (Web Video Text Tracks), el formato estándar de subtítulos para la reproducción de vídeo HTML5. El archivo puede descargarse directamente desde la URL proporcionada en el campo href de la respuesta.kind en la respuesta indica qué tipo es una pista determinada.live (generada durante la reunión mediante transcripción en directo), automatic (generada automáticamente mediante reconocimiento de voz) y upload (cargada manualmente por un usuario).