API Referens

VidioClient är den huvudsakliga ingångspunkten för att interagera med VIDIO API från Python. Använd den för att ladda upp filer, skapa jobb för höjdpunkter, kontrollera jobbs status, rendrera utdata och vänta på att bearbetningen ska slutföras.

API-åtkomst är för närvarande tillgänglig för Studio-planen och högre.

Klientmodellen

VidioClient tillhandahåller ett enkelt gränssnitt för att arbeta med VIDIO API. Efter att ha skapat en klient med din API-nyckel kan du ladda upp inmatningsfiler, skapa jobb för höjdpunkter, kontrollera jobbs status, rendrera utdata och vänta på att jobb ska slutföras.

Egenskaper

api_keystring

Din VIDIO API-nyckel som används för att autentisera förfrågningar.

Metoder

KlassVidioClient(api_key)

Initiera klient

Skapar en ny instans av VidioClient.

Parameters

api_keystring

Din VIDIO API-nyckel.

Returns

En konfigurerad instans av VidioClient.

python

from vidio import VidioClient
import os

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

Metodclient.upload(file_path)

Ladda upp fil

Laddar upp en lokal fil till VIDIO och returnerar ett uppladdningsresultat som innehåller inmatningsnyckeln.

Parameters

file_pathstring

Det lokala sökvägen till filen du vill ladda upp.

Returns

Ett objekt med uppladdningsresultat som innehåller `input_key`.

python

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

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

Skapa höjdpunktsklipp

Skapar ett jobb för höjdpunkter från en eller flera uppladdade inmatningsfiler.

Parameters

input_keyslist[string]

En lista med uppladdade filnycklar som returneras av upload(). Ordningen på inmatningsnycklarna bestämmer ordningen på media i den utgående videon.

video_categorystring

Videokategori som boll-sporter. Den kan vara podcast, boll-sporter, icke-boll-sporter, skönhetsproduktrdemo, bröllop, resa, övrigt. För bästa resultat, specificera den kategori som bäst matchar ditt innehåll. Om ditt innehåll inte passar i någon kategori, använd övrigt.

output_lengthinteger

Önskad utgångslängd i sekunder. Utgångslängden bör vara mindre än eller lika med den totala längden på alla inmatningsvideor sammanlagt.

aspect_ratiostring

Utgångsbildförhållande som landskap, porträtt eller fyrkant.

music_categorystring, optional

Förinställd musikkategori att tillämpa på resultatet. Stödda värden är corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary och trending_vlogs. Om resultatets längd är kortare än musikens längd kommer det valda spåret att loopa för att passa resultatet.

music_volumeinteger, optional

Bakgrundsmusikens volym från 0 till 100. Om det inte anges är standardvärdet 100.

ursprunglig_ljud_volyminteger, optional

Ursprunglig ljudvolym för källan, från 0 till 100. Om det inte anges är standardvärdet 100.

Returns

Ett jobbut objekt som innehåller `job_id` och statusinformation.

python

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

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

Metodclient.get_job(job_id)

Hämta jobb

Hämtar den aktuella statusen för ett jobb.

Parameters

job_idstring

Jobb-ID:t som returnerades när jobbet för höjdpunkter skapades.

Returns

Ett jobbut objekt med den senaste statusen.

Response fields

job_idstring

Jobb-ID.

statusstring

Den aktuella statusen för jobbet, såsom submitted, queued, processing, processed, rendering eller rendered.

outputslist[OutputResult]

Returneras när jobbet är helt renderat och utdata från det sista deljobbet är tillgänglig.

startfloat | null

Starttid för utdatasegmentet, om tillgängligt.

endfloat | null

Sluttid för utdatasegmentet, om tillgängligt.

thumbnailstring | null

Sökväg eller URL till miniatyrbilden för utdatan.

durationfloat | null

Varaktighet för utdatan i sekunder.

fpsfloat | null

Bildrutor per sekund för utdatan.

overlayslist[OverlayResult]

Sanerade överlägg som ingår i utdatan.

idinteger | null

ID för överlägget.

fileIDstring | null

Associerat fil-ID, om tillgängligt.

originalFileNamestring | null

Ursprungligt indatafilnamn som är associerat med överlägget, om tillgängligt.

from_integer | float | null

Offset i bildrutor där överlägget börjar.

contentstring | null

Värde för överläggets innehåll, t.ex. en sökväg till en miniatyrbild eller ett ljud-ID.

durationInFramesinteger | null

Överläggets varaktighet i bildrutor.

typestring | null

Typ av överlägg, såsom video eller sound.

srcstring | null

Käll-URL för överläggets media.

videoStartTimeinteger | float | null

Starttid i källvideon, när tillämpligt.

python

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

json

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

Metodclient.wait_for_job(job_id)

Vänta på jobb

Kontrollerar API:t tills jobbet för höjdpunkter når ett avslutat tillstånd.

Parameters

job_idstring

Jobb-ID:t att vänta på.

Returns

Det slutgiltiga avslutade jobbut objektet.

python

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

Metodclient.render(job_id)

Rendrerar utdata

Startar rendering av en utgångsvideo för ett avslutat jobb för höjdpunkter.

Parameters

job_idstring

Det avslutade jobb-ID:t för höjdpunkter.

output_indexinteger, optional

Indexet i listan OutputResult som ska renderas. Standardvärdet är 0. I allmänhet är det första resultatet det bästa.

Returns

Ett renderingsresultatobjekt med renderingsstatus.

python

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

print(render_result.status)

Metodclient.wait_for_render(job_id)

Vänta på rendering

Kontrollerar tills renderingen är klar och utdata är redo.

Parameters

job_idstring

Jobb-ID:t kopplat till renderingen.

Returns

Det slutgiltiga renderingsresultatobjektet.

python

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