API de vídeosGuías

Actualizar smart autoplay

Activa la superposición de reproducción automática sin sonido y elige su plantilla y posición.

Smart autoplay inicia el vídeo sin sonido y coloca encima una superposición para activar el sonido. La escritura es solo de selección: eliges una plantilla y dónde se ubica en la cuadrícula de 3×3 del reproductor, y la API construye la superposición a partir de esa plantilla predefinida.

Esto es un merge-patch: envía solo las claves que quieres cambiar y todo lo demás conserva su valor guardado.

Elige una plantilla

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" } ] } }'

Usa tu propia imagen

Define template_name como image para superponer una imagen que cargaste en lugar de una plantilla predefinida. Primero carga la imagen con POST /v1/files, luego referencia el id devuelto con file_id y elige un scale entre 0.1 y 1.

La API dimensiona la imagen según su tamaño original, la reduce para que quepa dentro del reproductor (dejando un margen), aplica tu scale a ese tamaño ajustado y la ancla en 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 } ] } }'

Las claves

ClaveTipoDefine
enabledbooleanoActiva o desactiva smart autoplay
variants[].template_namestringUna de default, discrete, modern, sightcare, fullscreen, o image para tu propia imagen
variants[].template_positionstringCelda de la cuadrícula: top/middle/bottom × left/center/right, p. ej. middle-center
variants[].file_idstringSolo image — el id de un archivo de imagen cargado
variants[].scalenúmeroSolo image — tamaño relativo a la imagen ajustada, de 0.1 a 1

Una plantilla o posición desconocida es un 422 unprocessable_content. En una variante image, un file_id ausente o que no sea una imagen, o un scale fuera de 0.1–1, también es un 422.

GET también puede devolver mode y active_number — describen el experimento A/B que la plataforma ejecuta entre las variantes y son de solo lectura. Una variante que se ajustó a mano en el panel (no creada a partir de una plantilla predefinida) se devuelve con su objeto completo en lugar de las dos claves de selección.

En esta página