API Referencer

VidioClient er hovedindgangspunktet for interaktion med VIDIO API fra Python. Brug det til at uploade filer, oprette highlight reel jobs, tjekke jobstatus, gengive output og vente på, at behandlingen er færdig.

API-adgang er i øjeblikket tilgængelig for Studio-planen og derover.

Klientmodellen

VidioClient giver et simpelt interface til at arbejde med VIDIO API. Efter at have oprettet en klient med din API-nøgle, kan du uploade inputfiler, oprette highlight reel jobs, spørge jobstatus, gengive output og vente på, at jobberne er færdige.

Egenskaber

api_keystring

Din VIDIO API-nøgle, der bruges til at godkende anmodninger.

Metoder

KLASSEVidioClient(api_key)

Initialiser klient

Opretter en ny VidioClient-forekomst.

Parameters

api_keystring

Din VIDIO API-nøgle.

Returns

En konfigureret VidioClient-forekomst.

python

from vidio import VidioClient
import os

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

METODEclient.upload(file_path)

Upload fil

Uploader en lokal fil til VIDIO og returnerer et upload-resultat, der indeholder inputnøglen.

Parameters

file_pathstring

Den lokale sti til den fil, du vil uploade.

Returns

Et uploadresultat objekt, der indeholder `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)

Opret highlight reel

Opretter et highlight reel job fra en eller flere uploadede inputfiler.

Parameters

input_keyslist[string]

En liste over uploadede filnøgler, der returneres af upload(). Rækkefølgen af inputnøgler bestemmer rækkefølgen af medier i outputvideoen.

video_categorystring

Videokategori som f.eks. bold-sport. Det kan være podcast, bold-sport, ikke-bold-sport, skønhedsprodukt-demo, bryllup, rejse, andre. For de bedste resultater, angiv den kategori, der bedst matcher dit indhold. Hvis dit indhold ikke passer ind i nogen kategori, brug andre.

output_lengthinteger

Ønsket outputlængde i sekunder. Outputlængden skal være mindre end eller lig med den samlede længde af alle inputvideoer tilsammen.

aspect_ratiostring

Output aspektforhold som f.eks. landskab, portræt eller kvadrat.

music_categorystring, optional

Forudindstillet musikkategori, der skal anvendes på outputtet. Understøttede værdier er corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, og trending_vlogs. Hvis outputtets varighed er kortere end musikkens varighed, vil det valgte spor blive gentaget for at passe til outputtet.

music_volumeinteger, optional

Baggrundsmusikkens lydstyrke fra 0 til 100. Hvis ikke angivet, er standardværdien 100.

original_audio_volumeinteger, optional

Lydstyrken for den originale kilde fra 0 til 100. Hvis den ikke angives, er standardværdien 100.

Returns

Et jobobjekt, der indeholder `job_id` og statusinformation.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="bold-sport",
    output_length=30,
    aspect_ratio="landskab",
)

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

METODEclient.get_job(job_id)

Hent job

Henter den nuværende status for et job.

Parameters

job_idstring

Job-ID'en, der returneres, når highlight reel job blev oprettet.

Returns

Et jobobjekt med den nyeste status.

Response fields

job_idstring

Job-id.

statusstring

Den aktuelle jobstatus, såsom submitted, queued, processing, processed, rendering eller rendered.

outputslist[OutputResult]

Returneres, når jobbet er fuldt gengivet, og outputdata er tilgængelige fra det seneste deljob.

startfloat | null

Starttidspunkt for outputsegmentet, hvis tilgængeligt.

endfloat | null

Sluttidspunkt for outputsegmentet, hvis tilgængeligt.

thumbnailstring | null

Sti til miniaturebillede eller URL for outputtet.

durationfloat | null

Varighed af output i sekunder.

fpsfloat | null

Billeder per sekund (fps) for outputtet.

overlayslist[OverlayResult]

Sanerede overlays inkluderet i outputtet.

idinteger | null

Overlay-id.

fileIDstring | null

Tilknyttet fil-id, når tilgængeligt.

originalFileNamestring | null

Originalt inputfilnavn knyttet til overlayet, hvis tilgængeligt.

from_integer | float | null

Frame-offset hvor overlayet starter.

contentstring | null

Overlayets indholdsværdi, såsom en sti til miniaturebillede eller en lydidentifikator.

durationInFramesinteger | null

Overlayets varighed i frames.

typestring | null

Overlaytype såsom video eller sound.

srcstring | null

Kilde-URL for overlayets medie.

videoStartTimeinteger | float | null

Starttidspunkt i kildevideoen, når relevant.

python

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

json

{
  "job_id": "abc123",
  "status": "renderet",
  "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": "løbende-nat-393139",
          "durationInFrames": 912,
          "type": "sound",
          "src": "https://..."
        }
      ],
      "fps": 59.94
     }
  ]
}

METODEclient.wait_for_job(job_id)

Vent på job

Spørger API'et, indtil highlight reel job når en afsluttet tilstand.

Parameters

job_idstring

Job-ID'en at vente på.

Returns

Det endelige afsluttede jobobjekt.

python

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

METODEclient.render(job_id)

Gengiv output

Starter gengivelsen af en outputvideo for et afsluttet highlight reel job.

Parameters

job_idstring

Det afsluttede highlight reel job-ID.

output_indeksinteger, optional

Indekset i OutputResult-listen, der skal gengives. Standardværdien er 0. Generelt er det første output det bedste resultat.

Returns

Et gengivelsesresultat objekt med gengivelsesstatus.

python

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

print(render_result.status)

METODEclient.wait_for_render(job_id)

Vent på gengivelse

Spørger indtil gengivelsen er færdig og outputtet er klar.

Parameters

job_idstring

Job-ID'en knyttet til gengivelsen.

Returns

Det endelige gengivelsesresultat objekt.

python

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