Text tracks erstellen

Du kannst Text tracks anlegen, um deinem Publikum Untertitel und/oder Captions für dein Video bereitzustellen. Ignite nutzt für alle Text tracks das WebVTT-Format. WebVTT wird unter anderem von YouTube und Vimeo verwendet und von Browsern und Playern weitgehend unterstützt. Mehr zum WebVTT-Format erfährst du hier .

language muss eine unterstützte Locale mit Region sein, zum Beispiel en-US oder de-DE. Ein Sprach-Tag ohne Region wie en wird mit 400 { "error": "unsupported_language" } abgelehnt. type ist subtitles oder captions.

Das Video muss bereits encodiert sein. Ein fehlendes Video oder ein Video, dessen status nicht COMPLETE ist, liefert 400.

Text-track-Objekt erstellen

Text tracks erstellst du, indem du eine PUT-Anfrage an den Endpoint /videos/:videoId/texttracks sendest – entweder mit angehängter VTT-Datei oder indem du den VTT-Inhalt als String übergibst.

Option 1: VTT-Inhalt als String übergeben

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

Option 2: VTT-Datei bereitstellen

Der Content-Type muss multipart/form-data sein und nicht application/json. Datei und Sprache musst du als Teil der Formulardaten senden.

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

Antwort

Das neu erstellte Text-track-Objekt. content in dieser Antwort ist ein URL-codierter, veralteter Platzhalter, nicht das hochgeladene WebVTT. Text track abrufen, um die Datei zu lesen.


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