API Viittaus

VidioClient on pääsyöttökohta VIDIO API:in vuorovaikutuksessa Pythonista. Käytä sitä tiedostojen lataamiseen, kohokohtareelityöpaikkojen luomiseen, työpaikan tilan tarkistamiseen, tulosten renderöimiseen ja odottamiseen prosessin valmistumiseksi.

API-pääsy on tällä hetkellä saatavilla Studio-suunnitelmalle ja sitä korkeammille.

Asiakas malli

VidioClient tarjoaa yksinkertaisen käyttöliittymän VIDIO API:n kanssa työskentelyyn. Kun olet luonut asiakkaan API-avaimellasi, voit ladata syötetiedostoja, luoda kohokohtareelityöpaikkoja, kysyä työpaikan tilaa, renderöidä tuloksia ja odottaa työpaikkojen valmistuvan.

Ominaisuudet

api_keystring

VIDIO API-avaimesi, jota käytetään pyyntöjen todennukseen.

Menetelmät

LUOKKAVidioClient(api_key)

Alusta asiakas

Luo uusi VidioClient-instanssi.

Parameters

api_keystring

VIDIO API-avaimesi.

Returns

Konfiguroitu VidioClient-instanssi.

python

from vidio import VidioClient
import os

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

MENETELMÄclient.upload(file_path)

Lataa tiedosto

Lataa paikallinen tiedosto VIDIO:hon ja palauttaa lataustuloksen, joka sisältää syöteavaimen.

Parameters

file_pathstring

Paikallinen polku tiedostoon, jonka haluat ladata.

Returns

Lataustulosobjekti, joka sisältää `input_key`.

python

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

MENETELMÄclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Luo kohokohtareeli

Luo kohokohtareelityöpaikka yhdestä tai useammasta ladatusta syötetiedostosta.

Parameters

input_keyslist[string]

Luettelo ladatuista tiedostoavaimista, jotka palautettiin upload():sta. Syöteavainten järjestys määrittää median järjestyksen lähtövideossa.

video_categorystring

Videokategoria kuten pallo-urheilu. Se voi olla podcast, pallo-urheilu, ei-pallo-urheilu, kauneustuote-demo, häät, matkailu, muut. Parhaiden tulosten saavuttamiseksi määritä kategoria, joka vastaa eniten sisältöäsi. Jos sisältösi ei sovi mihinkään kategoriaan, käytä muut.

output_lengthinteger

Haluttu lähtöpituus sekunteina. Lähtöpituuden on oltava yhtä suuri tai pienempi kuin kaikkien ladattujen videoiden yhteenlaskettu pituus.

aspect_ratiostring

Lähdön kuvasuhde, kuten vaaka, pysty tai neliö.

music_categorystring, optional

Ennalta määritetty musiikkikategoria, joka sovelletaan tuotokseen. Tuetut arvot ovat corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary ja trending_vlogs. Jos tuotoksen kesto on lyhyempi kuin musiikin kesto, valittu kappale toistuu silmukkana sopiakseen tuotokseen.

music_volumeinteger, optional

Taustamusiikin äänenvoimakkuus välillä 0 ja 100. Jos arvoa ei anneta, oletusarvo on 100.

original_audio_volumeinteger, optional

Alkuperäisen lähteen äänenvoimakkuus välillä 0–100. Jos arvoa ei anneta, oletusarvo on 100.

Returns

Työobjekti, joka sisältää `job_id` ja tila tiedot.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="pallo-urheilu",
    output_length=30,
    aspect_ratio="vaaka",
)

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

MENETELMÄclient.get_job(job_id)

Hae työ

Tuo esiin työpaikan nykyinen tila.

Parameters

job_idstring

Työpaikan ID, joka palautettiin, kun kohokohtareelityöpaikka luotiin.

Returns

Työobjekti, jossa on viimeisin tila.

Response fields

tehtävä_idstring

Tehtävän tunniste.

tilastring

Nykyinen tehtävän tila, esimerkiksi submitted, queued, processing, processed, rendering tai rendered.

tuotoksetlist[OutputResult]

Palautetaan, kun tehtävä on täysin renderöity ja viimeisestä alitehtävästä on saatavilla ulostulotiedot.

alkuaikafloat | null

Ulostulosegmentin aloitusaika, jos saatavilla.

loppuaikafloat | null

Ulostulosegmentin loppuaika, jos saatavilla.

pikkukuvastring | null

Pikkukuvan polku tai URL ulostulolle.

kestofloat | null

Ulostulon kesto sekunteina.

ruutuja_sekunnissafloat | null

Ulostulon ruudut sekunnissa.

peitteetlist[OverlayResult]

Ulostuloon sisältyvät puhdistetut peitteet.

tunnisteinteger | null

Peitteen tunniste.

tiedosto_tunnistestring | null

Liittyvän tiedoston tunniste, jos saatavilla.

alkuperäinen_tiedoston_nimistring | null

Peitteeseen liittyvän alkuperäisen syötetiedoston nimi, jos saatavilla.

alkaeninteger | float | null

Kehyksen siirtymä, jossa peite alkaa.

sisältöstring | null

Peitteen sisältöarvo, esimerkiksi pikkukuvan polku tai äänen tunniste.

kesto_kehyksissainteger | null

Peitteen kesto kehyksinä.

tyyppistring | null

Peitteen tyyppi, kuten video tai sound.

lähdestring | null

Peitteen median lähde-URL.

videon_alkamisaikainteger | float | null

Lähdevideon aloitusaika, kun se on sovellettavissa.

python

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

json

{
  "job_id": "abc123",
  "status": "renderöity",
  "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
     }
  ]
}

MENETELMÄclient.wait_for_job(job_id)

Odota työtä

Kysyy API:lta, kunnes kohokohtareelityöpaikka saavuttaa valmiin tilan.

Parameters

job_idstring

Työpaikan ID, jota odotetaan.

Returns

Lopullinen valmis työobjekti.

python

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

MENETELMÄclient.render(job_id)

Renderöi lähtö

Aloittaa valmiin kohokohtareelityöpaikan lähtövideon renderöimisen.

Parameters

job_idstring

Valmiin kohokohtareelityöpaikan ID.

output_indexinteger, optional

Renderoitavan OutputResult-listan indeksi. Oletusarvo on 0. Yleensä ensimmäinen tulos on paras.

Returns

Renderöintitulosobjekti renderointitilalla.

python

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

print(render_result.status)

MENETELMÄclient.wait_for_render(job_id)

Odota renderointia

Kysyy, kunnes renderointi on valmis ja lähtö on valmis.

Parameters

job_idstring

Renderointiin liittyvä työpaikan ID.

Returns

Lopullinen renderointi tulosobjekti.

python

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