Atualizar um vídeo

Atualizar um vídeo exige a permissão videos.update. visibility só é gravado quando a chave tem videos.publish. Caso contrário, o campo permanece inalterado e a resposta mantém-se 200. Consulta Autenticação.

Atualizar vídeo

Atualizar um único vídeo faz-se enviando um pedido PATCH para o endpoint /videos/:id.

Se procuras uma forma de substituir um ficheiro de vídeo, consulta a secção substituir vídeo.

Campos graváveis

Campo	Notas
`title`	Obrigatório quando é enviado. Aparado. 1 a 150 caracteres.
`description`	Máximo de 2000 caracteres.
`language`	Locale do idioma falado, por exemplo `en-US`. Outras strings também são guardadas.
`aiContent`	`none`, `generated` ou `modified`.
`visibility`	Gravado apenas com `videos.publish`. Caso contrário, o campo permanece inalterado.
`categories`	Substitui a lista. Os ids desconhecidos são descartados. Se não restar nenhum, o campo é `null`.
`tags`	Substitui a lista. Os ids desconhecidos são descartados. Se não restar nenhum, o campo é `null`.
`customMetadata`	Faz merge no objeto guardado. Consulta o objeto de vídeo.
`chapters`	`title` (máx. 100) e `timestamp` como `HH:MM:SS`.
`autoTranscription.autoStart`	Inicia a transcrição após a próxima codificação quando é `true`.
`player.useCustomDesign`	Usa `player.playerDesign` em vez do preset.
`player.selectedPreset`	Id do preset do leitor, ou `null`.
`player.playerDesign`	Propriedades de design do leitor. Consulta o objeto de vídeo.
`passwordProtection`	`{ enabled, password }`. `password` tem pelo menos 8 caracteres. Gravado apenas quando o workspace tem proteção por palavra-passe.

status, texttracks, audiotracks e os campos de ficheiro são ignorados. Envia alterações de Text track para os endpoints de 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'
  ]
]);

Resposta

A resposta é um objeto que contém o objeto de vídeo e uma mensagem de atualização. Se o id não existir, a resposta é 403 com o erro do Payload. Um id em falta e um id proibido devolvem o mesmo corpo. Consulta Autenticação.


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