API de vídeosGuias

Atualizar smart autoplay

Ative o overlay de autoplay sem som e escolha o template e a posição dele.

O smart autoplay inicia o vídeo sem som e coloca por cima um overlay para ativar o som. A gravação é só por seleção: você escolhe um template e onde ele fica na grade 3×3 do player, e a API monta o overlay a partir desse preset.

Isto é um merge-patch: envie só as chaves que você quer alterar, e todo o resto mantém o valor salvo.

Escolha um template

curl -X PATCH https://api.vturb.com/v1/videos/{id} \
  -H "Authorization: Bearer vt_..." \
  -H "Content-Type: application/json" \
  -d '{ "smart_autoplay": { "enabled": true, "variants": [ { "template_name": "modern", "template_position": "middle-center" } ] } }'

Use a sua própria imagem

Defina template_name como image para sobrepor uma imagem que você enviou em vez de um preset. Primeiro faça o upload da imagem por POST /v1/files, depois referencie o id retornado com file_id e escolha um scale entre 0.1 e 1.

A API dimensiona a imagem pelas dimensões dela, reduz a imagem para caber dentro do player (deixando uma margem), aplica o seu scale a esse tamanho ajustado e a ancora em template_position.

curl -X PATCH https://api.vturb.com/v1/videos/{id} \
  -H "Authorization: Bearer vt_..." \
  -H "Content-Type: application/json" \
  -d '{ "smart_autoplay": { "variants": [ { "template_name": "image", "template_position": "top-right", "file_id": "0190a0b0-0000-7000-8000-000000000001", "scale": 0.5 } ] } }'

As chaves

ChaveTipoDefine
enabledbooleanoLiga ou desliga o smart autoplay
variants[].template_namestringUm de default, discrete, modern, sightcare, fullscreen, ou image para a sua própria imagem
variants[].template_positionstringPosição na grade: top/middle/bottom × left/center/right, por exemplo middle-center
variants[].file_idstringSó para image — o id de um arquivo de imagem enviado
variants[].scalenúmeroSó para image — tamanho relativo à imagem ajustada, de 0.1 a 1

Um template ou uma posição desconhecidos geram um 422 unprocessable_content. Em uma variante image, um file_id ausente ou que não seja uma imagem, ou um scale fora de 0.1–1, também gera um 422.

O GET também pode retornar mode e active_number — eles descrevem o experimento A/B que a plataforma roda entre as variantes e são somente leitura. Uma variante montada à mão no painel (e não a partir de um preset) aparece como o objeto completo em vez das duas chaves de seleção.

Nesta página