API Referanse

VidioClient er hovedinngangspunktet for å interagere med VIDIO API fra Python. Bruk det til å laste opp filer, opprette høydepunktjobber, sjekke jobbstatus, gjengi utdata og vente på at behandling skal fullføres.

API-tilgang er for øyeblikket kun tilgjengelig for Enterprise-planer. Be om tilgang her hvis du ikke er en Enterprise-bruker, men er interessert i å bruke API-en.

Kunde-modellen

VidioClient gir et enkelt grensesnitt for å arbeide med VIDIO API. Etter å ha opprettet en klient med din API-nøkkel, kan du laste opp inndatafiler, opprette høydepunktjobber, hente jobbstatus, gjengi utdata, og vente på at jobbene skal avsluttes.

Egenskaper

api_keystring

Din VIDIO API-nøkkel brukt for å autentisere forespørsler.

Metoder

KLASSEVidioClient(api_key)

Initier klient

Oppretter en ny VidioClient-forekomst.

Parameters

api_keystring

Din VIDIO API-nøkkel.

Returns

En konfigurert VidioClient-forekomst.

python

from vidio import VidioClient
import os

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

METODEclient.upload(file_path)

Last opp fil

Laster opp en lokal fil til VIDIO og returnerer et opplasteresultat som inneholder inndata-nøkkelen.

Parameters

file_pathstring

Den lokale stien til filen du vil laste opp.

Returns

Et opplasteresultatobjekt som inneholder `input_key`.

python

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

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

Opprett høydepunkt

Oppretter en høydepunktjobb fra en eller flere opplastede inndatafiler.

Parameters

input_keyslist[string]

En liste over opplastede filnøkler returnert av upload(). Rekkefølgen av inndata-nøkler bestemmer rekkefølgen av medier i den utgående videoen.

video_categorystring

Videokategori som ball-sports. Det kan være podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. For best resultat, spesifiser kategorien som mest nært matcher innholdet ditt. Hvis innholdet ditt ikke passer i noen kategori, bruk others.

output_lengthinteger

Ønsket utgangslengde i sekunder. Utgangslengden skal være mindre enn eller lik den totale lengden på alle inndatavideoer kombinert.

aspect_ratiostring

Utgangsformat som landskap, portrett, eller kvadrat.

Returns

Et jobbobjekt som inneholder `job_id` og statusinformasjon.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="ball-sports",
    output_length=30,
    aspect_ratio="landskap",
)

print(job.job_id)
print(job.status)

METODEclient.get_job(job_id)

Hent jobb

Henter den nåværende statusen til en jobb.

Parameters

job_idstring

Jobb-ID-en som ble returnert da høydepunktjobben ble opprettet.

Returns

Et jobbobjekt med den nyeste statusen.

python

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

METODEclient.wait_for_job(job_id)

Vent på jobb

Henter API-en til høydepunktjobben når den når en fullført tilstand.

Parameters

job_idstring

Jobb-ID-en å vente på.

Returns

Det endelige fullførte jobbobjektet.

python

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

METODEclient.render(job_id)

Gjengi utdata

Starter gjengivingen av en utgangsvideo for en fullført høydepunktjobb.

Parameters

job_idstring

Den fullførte høydepunktjobb-ID-en.

Returns

Et gjengivelsesresultatobjekt med gjengivelsesstatus.

python

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

print(render_result.status)

METODEclient.wait_for_render(job_id)

Vent på gjengivelse

Henter til gjengivelsen er ferdig og utdataene er klare.

Parameters

job_idstring

Jobb-ID-en knyttet til gjengivelsen.

Returns

Det endelige gjengivelsesresultatobjektet.

python

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