Crear Text tracks

Puedes crear Text tracks para ofrecer subtítulos y/o subtítulos cerrados (captions) a tu audiencia. Ignite usa el formato WebVTT para todos los Text tracks. Ese formato lo usan YouTube, Vimeo y muchos más, y está ampliamente soportado por navegadores y reproductores. Puedes leer más sobre el formato WebVTT aquí .

language debe ser una configuración regional admitida que incluya una región, como en-US o de-DE. Una etiqueta de idioma sin región, como en, se rechaza con 400 { "error": "unsupported_language" }. type es subtitles o captions.

El video ya debe estar codificado. Un video inexistente, o un video cuyo status no es COMPLETE, devuelve 400.

Crear objeto Text track

Crear Text tracks se hace enviando una solicitud PUT al endpoint /videos/:videoId/texttracks con un archivo VTT adjunto o pasando el contenido VTT como cadena.

Opción 1: Pasar el contenido VTT como cadena

CURL


curl -X PUT https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"language": "en-US", "type": "captions", "content": "[VTT_CONTENT]"}'

JavaScript / Node.js


const data = {
"language": "en-US" | "de-DE" | "fr-FR" | "es-ES" | "it-IT" | "...",
"type": "subtitles" | "captions",
"content": "[VTT_CONTENT]"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks`, {
method: 'PUT',
body: JSON.stringify(data),
headers: {
  'Authorization': `Bearer YOUR_TOKEN`,
  'Content-Type': 'application/json'
}
});

PHP


$client = new GuzzleHttp\Client();
$data = [
  "language" => "en-US" | "de-DE" | "fr-FR" | "es-ES" | "it-IT" | "...",
  "type" => "subtitles" | "captions",
  "content" => "[VTT_CONTENT]"
];
$response = $client->request('PUT', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks', [
'body' => json_encode($data),
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN',
  'Content-Type' => 'application/json'
]
]);

Opción 2: Pasar un archivo VTT

El Content-Type tiene que ser multipart/form-data y no application/json. El archivo y el idioma tienen que enviarse como parte de los datos del formulario.

CURL


curl -X PUT https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks \
-H "Authorization: Bearer YOUR_TOKEN" \
-F "language=en-US" \
-F "type=captions" \
-F "file=@[PATH_TO_VTT_FILE]"

JavaScript / Node.js


const formData = new FormData();
formData.append('language', 'en-US');
formData.append('type', 'captions');
formData.append('file', [VTT_FILE]);
 
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks`, {
method: 'PUT',
body: formData,
headers: {
  'Authorization': `Bearer YOUR_TOKEN`,
}
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]/texttracks', [
'multipart' => [
  [
    'name' => 'language',
    'contents' => 'en-US'
  ],
  [
    'name' => 'type',
    'contents' => 'captions'
  ],
  [
    'name' => 'file',
    'contents' => fopen('[PATH_TO_VTT_FILE]', 'r')
  ]
],
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN'
]
]);

Respuesta

El objeto Text track recién creado. content en esta respuesta es un marcador de posición obsoleto codificado en URL, no el WebVTT subido. Obtén el text track para leer el archivo.


{
  "id": string,
  "language": "en-US" | "de-DE" | "fr-FR" | "es-ES" | "it-IT" | "...",
  "type": "subtitles" | "captions",
  "filename": string,
  "url": string,
  "content": string // URL-encoded placeholder, not the WebVTT
}