Mettre à jour une vidéo

La mise à jour d’une vidéo nécessite la permission videos.update. visibility n’est écrit que lorsque la clé a videos.publish. Sinon, le champ reste inchangé et la réponse reste 200. Voir Authentification.

Mettre à jour une vidéo

Pour mettre à jour une vidéo, envoie une requête PATCH à l’endpoint /videos/:id.

Si tu cherches un moyen de remplacer le fichier vidéo, consulte la section Remplacer une vidéo.

Champs modifiables

Champ	Notes
`title`	Obligatoire lorsqu’il est envoyé. Espaces retirés. De 1 à 150 caractères.
`description`	2000 caractères maximum.
`language`	Locale de la langue parlée, par exemple `en-US`. Les autres chaînes sont aussi enregistrées.
`aiContent`	`none`, `generated` ou `modified`.
`visibility`	Écrit seulement avec `videos.publish`. Sinon, le champ reste inchangé.
`categories`	Remplace la liste. Les ids inconnus sont retirés. S’il n’en reste aucun, le champ vaut `null`.
`tags`	Remplace la liste. Les ids inconnus sont retirés. S’il n’en reste aucun, le champ vaut `null`.
`customMetadata`	Fusionne avec l’objet stocké. Voir l’objet vidéo.
`chapters`	`title` (100 max) et `timestamp` au format `HH:MM:SS`.
`autoTranscription.autoStart`	Lance la transcription après le prochain encodage lorsque `true`.
`player.useCustomDesign`	Utilise `player.playerDesign` à la place du preset.
`player.selectedPreset`	Id de preset de lecteur, ou `null`.
`player.playerDesign`	Propriétés de design du lecteur. Voir l’objet vidéo.
`passwordProtection`	`{ enabled, password }`. `password` fait au moins 8 caractères. Écrit seulement lorsque l’espace de travail a la protection par mot de passe.

status, texttracks, audiotracks et les champs de fichier sont ignorés. Envoie les changements de Text track aux endpoints Text track.

CURL


curl -X PATCH https://app.ignitevideo.cloud/api/videos/[VIDEO_ID] \ 
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title": "New video title"}'

JavaScript / Node.js


const dataToUpdate = {
  "title": "New video title"
}
const response = await fetch(`https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]`, {
  method: 'PATCH',
  body: JSON.stringify(dataToUpdate),
  headers: {
    'Authorization': `Bearer YOUR_TOKEN`,
    'Content-Type': 'application/json'
  }
});

PHP


$client = new GuzzleHttp\Client();
$dataToUpdate = [
  "title" => "New video title"
];
$response = $client->request('PATCH', 'https://app.ignitevideo.cloud/api/videos/[VIDEO_ID]', [
  'body' => json_encode($dataToUpdate),
  'headers' => [
    'Authorization' => 'Bearer YOUR_TOKEN',
    'Content-Type' => 'application/json'
  ]
]);

Réponse

La réponse est un objet contenant l’objet vidéo et un message de mise à jour. Si l’id n’existe pas, la réponse est 403 avec l’erreur Payload. Un id manquant et un id interdit renvoient le même corps. Voir Authentification.


{
  doc: {
    "id": "[VIDEO_ID]",
    "title": "New video title",
    ...
  },
  message: "Updated successfully."
}