API Referencia

A VidioClient az alapvető belépési pont a VIDIO API-val való interakcióhoz Pythonban. Használja fájlok feltöltésére, kiemelő videó munkák létrehozására, munkastátusz ellenőrzésére, kimenetek renderelésére és a feldolgozás befejezésére való várakozásra.

Az API-hozzáférés jelenleg a Studio terv és annál magasabb szintre érhető el.

Az ügyfél modell

A VidioClient egyszerű interfészt biztosít a VIDIO API-val való munka során. Miután létrehozott egy klienst az API kulcsával, feltöltheti a bemeneti fájlokat, létrehozhat kiemelő videó munkákat, ellenőrizheti a munkák állapotát, renderelheti a kimeneteket és várakozhat a munkák befejezésére.

Tulajdonságok

api_keystring

Az ön VIDIO API kulcsa, amelyet a kérések hitelesítésére használ.

Metódusok

OSZTÁLYVidioClient(api_key)

Ügyfél inicializálása

Létrehoz egy új VidioClient példányt.

Parameters

api_keystring

Az ön VIDIO API kulcsa.

Returns

Egy konfigurált VidioClient példány.

python

from vidio import VidioClient
import os

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

METÓDUSclient.upload(file_path)

Fájl feltöltése

Feltölt egy helyi fájlt a VIDIO-ra, és visszaad egy feltöltési eredményt, amely tartalmazza a bemeneti kulcsot.

Parameters

file_pathstring

A helyi útvonal a feltölteni kívánt fájlhoz.

Returns

Egy feltöltési eredmény objektum, amely tartalmazza az `input_key`-t.

python

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

METÓDUSclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Kiemelő videó létrehozása

Kiemelő videó munkát hoz létre egy vagy több feltöltött bemeneti fájlból.

Parameters

input_keyslist[string]

A upload() által visszaadott feltöltött fájk kulcsok listája. A bemeneti kulcsok sorrendje meghatározza a média sorrendjét a kimeneti videóban.

video_categorystring

Videó kategória, például ball-sports. Lehet podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. A legjobb eredmények érdekében adja meg azt a kategóriát, amely a legjobban illeszkedik a tartalmához. Ha a tartalma nem illik egy kategóriába sem, használja az others-t.

output_lengthinteger

Kívánt kimeneti hossz másodpercben. A kimeneti hossznak kevesebbnek vagy egyenlőnek kell lennie az összes bemeneti videó összeadott hosszával.

aspect_ratiostring

Kimeneti képarány, például landscape, portrait vagy square.

music_categorystring, optional

Előre beállított zenei kategória, amely a kimenetre alkalmazandó. A támogatott értékek: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary és trending_vlogs. Ha a kimenet hossza rövidebb, mint a zene hossza, a kiválasztott szám ismétlődni fog, hogy illeszkedjen a kimenethez.

zene_hangerőinteger, optional

Háttérzene hangereje 0 és 100 között. Ha nincs megadva, az alapértelmezett 100.

original_audio_volumeinteger, optional

Eredeti forrás hangereje 0 és 100 között. Ha nincs megadva, az alapértelmezett 100.

Returns

Egy munka objektum, amely tartalmazza a `job_id`-t és a státusz információt.

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)

METÓDUSclient.get_job(job_id)

Munka lekérése

Lekéri egy munka aktuális állapotát.

Parameters

job_idstring

A munka azonosítója, amelyet a kiemelő videó munka létrehozásakor adtak vissza.

Returns

Egy munka objektum a legfrissebb státusszal.

Response fields

job_idstring

A munka azonosítója.

statusstring

A munka aktuális állapota, például submitted, queued, processing, processed, rendering vagy rendered.

outputslist[OutputResult]

Visszaadódik, amikor a munka teljesen renderelődött, és az utolsó alfeladat kimeneti adatai elérhetőek.

startfloat | null

A kimeneti szegmens kezdési ideje, ha elérhető.

endfloat | null

A kimeneti szegmens befejezési ideje, ha elérhető.

thumbnailstring | null

Bélyegkép útvonala vagy URL-je a kimenethez.

durationfloat | null

A kimenet időtartama másodpercben.

fpsfloat | null

Másodpercenkénti képkockák száma a kimenethez.

overlayslist[OverlayResult]

A kimenetben található, megtisztított átfedések.

idinteger | null

Átfedés azonosítója.

fileIDstring | null

Kapcsolódó fájl azonosítója, ha elérhető.

originalFileNamestring | null

Az átfedéshez kapcsolódó eredeti bemeneti fájl neve, ha elérhető.

from_integer | float | null

A képkocka-eltolás, ahol az átfedés kezdődik.

contentstring | null

Az átfedés tartalmi értéke, például egy bélyegkép útvonala vagy hangazonosító.

durationInFramesinteger | null

Az átfedés időtartama képkockában.

typestring | null

Az átfedés típusa, például video vagy sound.

srcstring | null

Az átfedés média forrás-URL-je.

videoStartTimeinteger | float | null

Forrásvideó kezdési ideje, ha alkalmazható.

python

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

json

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

METÓDUSclient.wait_for_job(job_id)

Várakozás a munkára

Lekérdezi az API-t, amíg a kiemelő videó munka befejezett állapotba nem kerül.

Parameters

job_idstring

A munka azonosítója, amelyre várni kell.

Returns

A végső befejezett munka objektum.

python

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

METÓDUSclient.render(job_id)

Kimeneti renderelése

Kezdi renderelni egy kimeneti videót egy befejezett kiemelő videó munkához.

Parameters

job_idstring

A befejezett kiemelő videó munka azonosítója.

output_indexinteger, optional

A megjelenítendő OutputResult lista indexe. Az alapértelmezett érték 0. Általában az első kimenet a legjobb eredmény.

Returns

Egy renderelési eredmény objektum renderelési státusszal.

python

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

print(render_result.status)

METÓDUSclient.wait_for_render(job_id)

Várakozás a renderelésre

Lekérdezi, amíg a renderelés befejeződik és a kimenet kész nem lesz.

Parameters

job_idstring

A rendereléshez kapcsolódó munka azonosítója.

Returns

A végső renderelési eredmény objektum.

python

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