API Referenca

VidioClient je glavni ulaz za interakciju sa VIDIO API-jem iz Pythona. Koristite ga za učitavanje datoteka, kreiranje poslova za naglašavanje, proveru statusa posla, renderovanje izlaza i čekanje da se obrada završi.

API pristup trenutno je dostupan samo za Enterprise planove. Zatražite pristup ovde ako niste Enterprise korisnik, ali ste zainteresovani za korišćenje API-ja.

Model klijenta

VidioClient pruža jednostavno sučelje za rad sa VIDIO API-jem. Nakon što kreirate klijenta sa vašim API ključem, možete učitavati ulazne datoteke, kreirati poslove za naglašavanje, proveravati status posla, renderovati izlaze i čekati da poslovi završe.

Osobine

api_keystring

Vaš VIDIO API ključ koji se koristi za autentifikaciju zahteva.

Metode

KLASAVidioClient(api_key)

Inicijalizuj klijenta

Kreira novu instancu VidioClient-a.

Parameters

api_keystring

Vaš VIDIO API ključ.

Returns

Konfigurisana instanca VidioClient-a.

python

from vidio import VidioClient
import os

client = VidioClient(
    api_key=os.getenv("VIDIO_API_KEY")
)

METODAclient.upload(file_path)

Učitaj datoteku

Učitava lokalnu datoteku na VIDIO i vraća rezultat učitavanja koji sadrži ulazni ključ.

Parameters

file_pathstring

Lokalni put do datoteke koju želite da učitate.

Returns

Objekat rezultata učitavanja koji sadrži `input_key`.

python

result = client.upload("/path/to/video.mp4")
print(result.input_key)

METODAclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Kreiraj naglašavanje

Kreira posao za naglašavanje iz jedne ili više učitanih ulaznih datoteka.

Parameters

input_keyslist[string]

Lista ključeva učitanih datoteka vraćenih od strane upload(). Redosled ulaznih ključeva određuje redosled medija u izlaznom videu.

video_categorystring

Kategorija videa kao što je ball-sports. Može biti podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. Za najbolje rezultate, navedite kategoriju koja se najviše podudara sa vašim sadržajem. Ako vaš sadržaj ne spada u nijednu kategoriju, koristite others.

output_lengthinteger

Željena dužina izlaza u sekundama. Dužina izlaza treba da bude manja ili jednaka ukupnoj dužini svih ulaznih videa kombinovano.

aspect_ratiostring

Izlazni odnos širine i visine kao što su landscape, portrait, ili square.

Returns

Objekat posla koji sadrži `job_id` i informacije o statusu.

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)

METODAclient.get_job(job_id)

Dohvati posao

Dohvata trenutni status posla.

Parameters

job_idstring

ID posla vraćen kada je posao za naglašavanje kreiran.

Returns

Objekat posla sa najnovijim statusom.

python

job_status = client.get_job(job.job_id)
print(job_status.status)

METODAclient.wait_for_job(job_id)

Čekaj na posao

Proverava API dok posao za naglašavanje ne dosegne stanje završeno.

Parameters

job_idstring

ID posla na koji treba čekati.

Returns

Završeni objekat posla.

python

final_job = client.wait_for_job(job.job_id)
print(final_job.status)

METODAclient.render(job_id)

Renderuj izlaz

Pokreće renderovanje izlaznog videa za završeni posao naglašavanja.

Parameters

job_idstring

ID završenog posla za naglašavanje.

Returns

Objekat rezultata renderovanja sa statusom renderovanja.

python

render_result = client.render(
    job_id=job.job_id
)

print(render_result.status)

METODAclient.wait_for_render(job_id)

Čekaj na render

Proverava dok se render ne završi i izlaz ne bude spreman.

Parameters

job_idstring

ID posla povezanog sa renderovanjem.

Returns

Završeni objekat rezultata renderovanja.

python

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