API Reference

VidioClient je hlavní vstupní bod pro interakci s VIDIO API z Pythonu. Použijte ho k nahrávání souborů, vytváření pracovních úloh na sestřihy, kontrole stavu úloh, renderování výstupů a čekání na dokončení zpracování.

API přístup je aktuálně k dispozici pro plán Studio a vyšší.

Model klienta

Třída VidioClient poskytuje jednoduché rozhraní pro práci s VIDIO API. Po vytvoření klienta s vaším API klíčem můžete nahrávat vstupní soubory, vytvářet pracovní úlohy na sestřihy, dotazovat se na stav úloh, renderovat výstupy a čekat, až úlohy skončí.

Vlastnosti

api_keystring
Váš VIDIO API klíč používaný k autentizaci žádostí.

Metody

CLASSVidioClient(api_key)

Inicializovat klienta

Vytváří novou instanci VidioClient.

Parameters

api_keystring
Váš VIDIO API klíč.

Returns

Konfigurovaná instance VidioClient.

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

Nahrát soubor

Nahraje místní soubor do VIDIO a vrátí výsledek nahrávání obsahující vstupní klíč.

Parameters

file_pathstring
Místní cesta k souboru, který chcete nahrát.

Returns

Objekt výsledku nahrávání obsahující `input_key`.

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

Vytvořit sestřih

Vytváří pracovní úlohu na sestřih z jednoho nebo více nahraných vstupních souborů.

Parameters

input_keyslist[string]
Seznam klíčů nahraných souborů vrácených funkcí upload(). Pořadí vstupních klíčů určuje pořadí médií ve výstupním videu.
video_categorystring
Kategorie videa, například ball-sports. Může to být podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. Pro nejlepší výsledky specifikujte kategorii, která nejvíce odpovídá vašemu obsahu. Pokud váš obsah neodpovídá žádné kategorii, použijte others.
output_lengthinteger
Požadovaná délka výstupu v sekundách. Délka výstupu by měla být menší nebo rovna celkové délce všech nahraných videí.
aspect_ratiostring
Poměr stran výstupu, například landscape, portrait nebo square.
hudební_kategoriestring, optional
Přednastavená kategorie hudby, která se použije pro výstup. Podporované hodnoty jsou corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary a trending_vlogs. Pokud je délka výstupu kratší než délka hudby, vybraná skladba se bude přehrávat v smyčce, aby odpovídala délce výstupu.
hlasitost_hudbyinteger, optional
Hlasitost hudby na pozadí od 0 do 100. Pokud není zadána, výchozí hodnota je 100.
původní_hlasitost_zvukuinteger, optional
Původní hlasitost zdrojového zvuku od 0 do 100. Pokud není uvedeno, výchozí je 100.

Returns

Objekt úlohy obsahující `job_id` a informace o stavu.

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)
METHODclient.get_job(job_id)

Získat úlohu

Získává aktuální stav úlohy.

Parameters

job_idstring
ID úlohy vrácené při vytváření úlohy na sestřih.

Returns

Objekt úlohy s nejnovějším stavem.

Response fields

job_idstring
ID úlohy.
statusstring
Aktuální stav úlohy, například submitted, queued, processing, processed, rendering nebo rendered.
outputslist[OutputResult]
Vráceno, když je úloha plně vyrenderovaná a data výstupu jsou dostupná z posledního podúkolu.
startfloat | null
Počáteční čas segmentu výstupu, pokud je k dispozici.
endfloat | null
Koncový čas segmentu výstupu, pokud je k dispozici.
thumbnailstring | null
Cesta k miniatuře nebo URL pro výstup.
durationfloat | null
Doba trvání výstupu v sekundách.
fpsfloat | null
Snímků za sekundu (FPS) pro výstup.
overlayslist[OverlayResult]
Sanitizované překryvy zahrnuté ve výstupu.
idinteger | null
ID překryvu.
fileIDstring | null
Přiřazené ID souboru, pokud je k dispozici.
originalFileNamestring | null
Původní název vstupního souboru spojený s překryvem, pokud je k dispozici.
from_integer | float | null
Posun snímku, na kterém překryv začíná.
contentstring | null
Hodnota obsahu překryvu, například cesta k miniatuře nebo identifikátor zvuku.
durationInFramesinteger | null
Délka překryvu ve snímcích.
typestring | null
Typ překryvu, například video nebo sound.
srcstring | null
Zdrojová URL pro médium překryvu.
videoStartTimeinteger | float | null
Počáteční čas zdrojového videa, pokud je relevantní.
python
job_status = client.get_job(job.job_id) print(job_status.status)
json
{ "job_id": "abc123", "status": "vyrenderováno", "outputs": [ { "start": null, "end": null, "thumbnail": "out/...jpg", "duration": 15.22, "overlays": [ { "id": 0, "fileID": "file_123", "from": 0, "content": "https://...", "durationInFrames": 284, "type": "video", "src": "https://...", "videoStartTime": 5425 }, { "id": 876361, "from": 0, "content": "running-night-393139", "durationInFrames": 912, "type": "sound", "src": "https://..." } ], "fps": 59.94 } ] }
METHODclient.wait_for_job(job_id)

Čekat na úlohu

Dotazuje se na API, dokud úloha na sestřih nedosáhne dokončeného stavu.

Parameters

job_idstring
ID úlohy, na kterou se čeká.

Returns

Konečný objekt dokončené úlohy.

python
final_job = client.wait_for_job(job.job_id) print(final_job.status)
METHODclient.render(job_id)

Renderovat výstup

Zahájí renderování výstupního videa pro dokončenou úlohu na sestřih.

Parameters

job_idstring
ID dokončené úlohy na sestřih.
output_indexinteger, optional
Index položky v seznamu OutputResult, která se má vykreslit. Výchozí hodnota je 0. Obecně je první výstup nejlepší výsledek.

Returns

Objekt výsledku renderování se stavem renderování.

python
render_result = client.render( job_id=job.job_id ) print(render_result.status)
METHODclient.wait_for_render(job_id)

Čekat na renderování

Dotazuje se, dokud renderování neskončí a výstup nebude připraven.

Parameters

job_idstring
ID úlohy spojené s renderováním.

Returns

Konečný objekt výsledku renderování.

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