Referencia de API

El VidioClient es el punto de entrada principal para interactuar con la API de VIDIO desde Python. Úsalo para subir archivos, crear trabajos de reel de destacados, verificar el estado de los trabajos, renderizar salidas y esperar a que el procesamiento se complete.

El acceso a la API está actualmente disponible para el plan Studio y superior.

El modelo de cliente

El VidioClient proporciona una interfaz simple para trabajar con la API de VIDIO. Después de crear un cliente con tu clave de API, puedes subir archivos de entrada, crear trabajos de reel de destacados, consultar el estado de los trabajos, renderizar salidas y esperar a que los trabajos terminen.

Propiedades

api_keystring
Tu clave de API de VIDIO utilizada para autenticar solicitudes.

Métodos

CLASEVidioClient(api_key)

Inicializar cliente

Crea una nueva instancia de VidioClient.

Parameters

api_keystring
Tu clave de API de VIDIO.

Returns

Una instancia de VidioClient configurada.

python
from vidio import VidioClient import os client = VidioClient( api_key=os.getenv("VIDIO_API_KEY") )
MÉTODOclient.upload(file_path)

Subir archivo

Sube un archivo local a VIDIO y devuelve un resultado de subida que contiene la clave de entrada.

Parameters

file_pathstring
La ruta local al archivo que deseas subir.

Returns

Un objeto de resultado de subida que contiene `input_key`.

python
result = client.upload("/path/to/video.mp4") print(result.input_key)
MÉTODOclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Crear reel de destacados

Crea un trabajo de reel de destacados a partir de uno o más archivos de entrada subidos.

Parameters

input_keyslist[string]
Una lista de claves de archivos subidos devueltas por upload(). El orden de las claves de entrada determina el orden de los medios en el video de salida.
video_categorystring
Categoría de video como ball-sports. Puede ser podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. Para obtener los mejores resultados, especifica la categoría que mejor se ajuste a tu contenido. Si tu contenido no encaja en ninguna categoría, usa others.
output_lengthinteger
Longitud de salida deseada en segundos. La longitud de salida debe ser menor o igual a la longitud total de todos los videos de entrada combinados.
aspect_ratiostring
Relación de aspecto de salida, como landscape, portrait o square.

Returns

Un objeto de trabajo que contiene `job_id` e información de estado.

python
job = client.create_highlight_reel( input_keys=[result.input_key], video_category="ball-sports", output_length=30, aspect_ratio="landscape", ) print(job.job_id) print(job.status)
MÉTODOclient.get_job(job_id)

Obtener trabajo

Obtiene el estado actual de un trabajo.

Parameters

job_idstring
El ID del trabajo devuelto cuando se creó el trabajo del reel de destacados.

Returns

Un objeto de trabajo con el estado más reciente.

python
job_status = client.get_job(job.job_id) print(job_status.status)
MÉTODOclient.wait_for_job(job_id)

Esperar por trabajo

Consulta la API hasta que el trabajo del reel de destacados alcanza un estado completado.

Parameters

job_idstring
El ID del trabajo por el que esperar.

Returns

El objeto de trabajo final completado.

python
final_job = client.wait_for_job(job.job_id) print(final_job.status)
MÉTODOclient.render(job_id)

Renderizar salida

Comienza a renderizar un video de salida para un trabajo de reel de destacados completado.

Parameters

job_idstring
El ID del trabajo de reel de destacados completado.

Returns

Un objeto de resultado de renderización con el estado de renderización.

python
render_result = client.render( job_id=job.job_id ) print(render_result.status)
MÉTODOclient.wait_for_render(job_id)

Esperar por renderización

Consulta hasta que la renderización finalice y la salida esté lista.

Parameters

job_idstring
El ID del trabajo asociado con la renderización.

Returns

El objeto de resultado final de renderización.

python
final_render = client.wait_for_render(job.job_id) print(final_render.output_url)