Criar Text tracks

Podes criar Text tracks para fornecer legendas e/ou captions ao público do teu vídeo. O Ignite usa o formato WebVTT para todos os Text tracks. O formato WebVTT é usado pelo YouTube, Vimeo e muitos outros e é amplamente suportado por todos os browsers e players. Mais informação sobre o formato WebVTT aqui .

language tem de ser um locale suportado que inclua uma região, como en-US ou de-DE. Uma etiqueta só com o idioma, como en, é rejeitada com 400 { "error": "unsupported_language" }. type é subtitles ou captions.

O vídeo já tem de estar codificado. Um vídeo em falta, ou um vídeo cujo status não é COMPLETE, devolve 400.

Criar objeto Text track

Para criar Text tracks, envia um pedido PUT para o endpoint /videos/:videoId/texttracks, quer com um ficheiro VTT anexado quer passando o conteúdo VTT como cadeia.

Opção 1: Fornecer conteúdo VTT como cadeia

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'
]
]);

Opção 2: Fornecer ficheiro VTT

O Content-Type tem de ser multipart/form-data e não application/json. O ficheiro e o idioma têm de ser enviados como parte dos dados do formulário.

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'
]
]);

Resposta

O objeto Text track recém-criado. content nesta resposta é um placeholder obsoleto codificado em URL, e não o WebVTT carregado. Obter o Text track para leres o ficheiro.


{
  "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
}