Referință API

VidioClient este principalul punct de intrare pentru interacțiunea cu API-ul VIDIO din Python. Folosiți-l pentru a încărca fișiere, a crea locuri de muncă pentru clipuri, a verifica starea muncii, a reda ieșiri și a aștepta finalizarea procesării.

Accesul API este disponibil în prezent pentru planul Studio și superior.

Modelul clientului

VidioClient oferă o interfață simplă pentru a lucra cu API-ul VIDIO. După ce ați creat un client cu cheia dvs. API, puteți încărca fișiere de intrare, crea locuri de muncă pentru clipuri, verifica starea muncii, reda ieșiri și aștepta finalizarea muncilor.

Proprietăți

api_keystring

Cheia dvs. API VIDIO utilizată pentru autentificarea cererilor.

Metode

CLASĂVidioClient(api_key)

Initializează clientul

Creează o nouă instanță VidioClient.

Parameters

api_keystring

Cheia dvs. API VIDIO.

Returns

O instanță VidioClient configurată.

python

from vidio import VidioClient
import os

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

METODĂclient.upload(file_path)

Încarcă fișier

Încarcă un fișier local pe VIDIO și returnează un rezultat de încărcare conținând cheia de intrare.

Parameters

file_pathstring

Calea locală către fișierul pe care doriți să-l încărcați.

Returns

Un obiect rezultat de încărcare conținând `input_key`.

python

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

METODĂclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Creează clip

Creează un loc de muncă pentru clip din unul sau mai multe fișiere de intrare încărcate.

Parameters

input_keyslist[string]

O listă de chei ale fișierelor încărcate returnate de upload(). Ordinea cheilor de intrare determină ordinea materialelor media în videoclipul final.

video_categorystring

Categoria videoclipului, de exemplu ball-sports. Poate fi podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. Pentru cele mai bune rezultate, specificați categoria care se potrivește cel mai mult conținutului dvs. Dacă conținutul dvs. nu se încadrează în nicio categorie, folosiți others.

output_lengthinteger, optional

Durata dorită a rezultatului în secunde. Obligatoriu când cut_method este ai-cut; nu este necesar când cut_method este no-cut. Durata de ieșire trebuie să fie mai mică sau egală cu durata totală a tuturor videoclipurilor de intrare combinate.

aspect_ratiostring

Raportul de aspect al ieșirii, de exemplu landscape, portrait sau square.

cut_methodstring, optional

Controlează modul în care videoclipurile sursă sunt tăiate înainte de redare. Valorile acceptate sunt ai-cut și no-cut. Implicit este ai-cut.

music_categorystring, optional

Categorie muzicală prestabilită care se aplică rezultatului. Valorile acceptate sunt corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary și trending_vlogs. Dacă durata rezultatului este mai scurtă decât durata piesei, melodia selectată va fi redată în buclă pentru a se potrivi duratei.

music_volumeinteger, optional

Volumul muzicii de fundal de la 0 la 100. Dacă nu este specificat, valoarea implicită este 100.

original_audio_volumeinteger, optional

Volumul audio al sursei originale de la 0 la 100. Dacă nu este specificat, valoarea implicită este 100.

Returns

Un obiect de loc de muncă care conține `job_id` și informații despre starea acestuia.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="sporturi cu minge",
    output_length=30,
    aspect_ratio="peisaj",
)

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

METODĂclient.get_job(job_id)

Obține muncă

Recuperează starea curentă a unei lucrări.

Parameters

job_idstring

ID-ul locului de muncă returnat când a fost creat locul de muncă pentru clip.

Returns

Un obiect de loc de muncă cu cea mai recentă stare.

Response fields

job_idstring

ID-ul jobului.

statusstring

Starea curentă a jobului, cum ar fi submitted, queued, processing, processed, rendering sau rendered.

outputslist[OutputResult]

Returnat când jobul este finalizat și datele de ieșire sunt disponibile din ultimul sub-job.

startfloat | null

Ora de început a segmentului de ieșire, dacă este disponibilă.

endfloat | null

Ora de sfârșit a segmentului de ieșire, dacă este disponibilă.

thumbnailstring | null

Calea sau URL-ul miniaturii pentru ieșire.

durationfloat | null

Durata ieșirii în secunde.

fpsfloat | null

Cadre pe secundă pentru ieșire.

overlayslist[OverlayResult]

Suprapuneri sanitizate incluse în ieșire.

idinteger | null

ID-ul suprapunerii.

fileIDstring | null

ID-ul fișierului asociat, când este disponibil.

originalFileNamestring | null

Numele fișierului de intrare original asociat suprapunerii, când este disponibil.

from_integer | float | null

Deplasarea în cadre la care începe suprapunerea.

contentstring | null

Valoarea conținutului suprapunerii, de exemplu calea unei miniaturi sau un identificator audio.

durationInFramesinteger | null

Durata suprapunerii în cadre.

typestring | null

Tipul suprapunerii, de exemplu video sau sound.

srcstring | null

URL-ul sursă pentru media suprapunerii.

videoStartTimeinteger | float | null

Ora de început a videoclipului sursă, când este aplicabilă.

python

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

json

{
  "job_id": "abc123",
  "status": "finalizat",
  "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": "alergare-noapte-393139",
          "durationInFrames": 912,
          "type": "sound",
          "src": "https://..."
        }
      ],
      "fps": 59.94
     }
  ]
}

METODĂclient.wait_for_job(job_id)

Așteaptă muncă

Polls API-ul până când locul de muncă pentru clip ajunge într-o stare finalizată.

Parameters

job_idstring

ID-ul locului de muncă pentru care așteptați.

Returns

Obiectul final de loc de muncă finalizat.

python

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

METODĂclient.render(job_id)

Redați ieșirea

Începe redarea unui videoclip de ieșire pentru un loc de muncă finalizat pentru clip.

Parameters

job_idstring

ID-ul locului de muncă finalizat pentru clip.

output_indexinteger, optional

Indexul listei OutputResult care trebuie redată. Valoarea implicită este 0. În general, prima ieșire este cel mai bun rezultat.

Returns

Un obiect rezultat de redare cu starea redării.

python

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

print(render_result.status)

METODĂclient.wait_for_render(job_id)

Așteptați redarea

Execută polling până când redarea se finalizează și ieșirea este gata.

Parameters

job_idstring

ID-ul locului de muncă asociat cu redarea.

Returns

Obiectul final de rezultat de redare.

python

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