Rujukan API

VidioClient adalah titik masuk utama untuk berinteraksi dengan API VIDIO dari Python. Gunakan untuk memuat naik fail, membuat pekerjaan sorotan, memeriksa status kerja, merender output, dan menunggu pemprosesan selesai.

Akses API kini tersedia untuk pelan Studio dan ke atas.

Model klien

VidioClient menyediakan antara muka yang mudah untuk bekerja dengan API VIDIO. Setelah membuat klien dengan kunci API anda, anda boleh memuat naik fail input, membuat pekerjaan sorotan, memeriksa status kerja, merender output, dan menunggu kerja selesai.

Ciri-ciri

api_keystring

Kunci API VIDIO anda yang digunakan untuk mengesahkan permintaan.

Kaedah

KELASVidioClient(api_key)

Inisialisasi klien

Mencipta satu instance VidioClient yang baru.

Parameters

api_keystring

Kunci API VIDIO anda.

Returns

Sebuah instance VidioClient yang telah dikonfigurasi.

python

from vidio import VidioClient
import os

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

KAEDAHclient.upload(file_path)

Muat naik fail

Memuat naik fail tempatan ke VIDIO dan mengembalikan hasil muat naik yang mengandungi input key.

Parameters

file_pathstring

Jalan tempatan ke fail yang ingin anda muat naik.

Returns

Objek hasil muat naik yang mengandungi `input_key`.

python

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

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

Cipta sorotan

Membuat pekerjaan sorotan dari satu atau lebih fail input yang telah dimuat naik.

Parameters

input_keyslist[string]

Senarai kunci fail yang telah dimuat naik yang dikembalikan oleh upload(). Susunan input keys menentukan urutan media dalam video output.

video_categorystring

Kategori video seperti bola-aktiviti. Ia boleh menjadi podcast, bola-aktiviti, bukan-bola-aktiviti, demo-produk-kecantikan, perkahwinan, perjalanan, lain-lain. Untuk hasil terbaik, spesifikasikan kategori yang paling dekat dengan kandungan anda. Jika kandungan anda tidak sesuai dengan mana-mana kategori, gunakan lain-lain.

output_lengthinteger

Panjang output yang diinginkan dalam saat. Panjang output harus kurang dari atau sama dengan jumlah panjang semua video input digabungkan.

aspect_ratiostring

Nisbah aspek output seperti landskap, potret, atau persegi.

music_categorystring, optional

Kategori muzik pratetap untuk digunakan pada output. Nilai yang disokong ialah corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, dan trending_vlogs. Jika durasi output lebih pendek daripada durasi muzik, trek yang dipilih akan berulang untuk sesuai dengan output.

kelantangan_muzikinteger, optional

Kelantangan muzik latar dari 0 hingga 100. Jika tidak disediakan, nilai lalai adalah 100.

original_audio_volumeinteger, optional

Kelantangan audio sumber asal dari 0 hingga 100. Jika tidak disediakan, nilai lalai ialah 100.

Returns

Objek pekerjaan yang mengandungi `job_id` dan maklumat status.

python

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

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

KAEDAHclient.get_job(job_id)

Dapatkan pekerjaan

Mengambil status semasa pekerjaan.

Parameters

job_idstring

ID pekerjaan yang dikembalikan apabila pekerjaan sorotan dibuat.

Returns

Objek pekerjaan dengan status terkini.

Response fields

job_idstring

ID pekerjaan.

statusstring

Status pekerjaan semasa, seperti submitted, queued, processing, processed, rendering, atau rendered.

outputslist[OutputResult]

Dikembalikan apabila pekerjaan telah sepenuhnya dirender dan data keluaran tersedia daripada sub-pekerjaan terakhir.

startfloat | null

Masa mula segmen keluaran, jika tersedia.

endfloat | null

Masa tamat segmen keluaran, jika tersedia.

thumbnailstring | null

Laluan gambar kecil atau URL untuk keluaran.

durationfloat | null

Tempoh keluaran dalam saat.

fpsfloat | null

Bingkai per saat untuk keluaran.

overlayslist[OverlayResult]

Tindihan yang telah disanitasi disertakan dalam keluaran.

idinteger | null

ID tindihan.

fileIDstring | null

ID fail berkaitan, jika tersedia.

originalFileNamestring | null

Nama fail input asal yang berkaitan dengan tindihan, jika tersedia.

from_integer | float | null

Offset bingkai di mana tindihan bermula.

contentstring | null

Nilai kandungan tindihan, seperti laluan gambar kecil atau pengenal bunyi.

durationInFramesinteger | null

Tempoh tindihan dalam bingkai.

typestring | null

Jenis tindihan seperti video atau sound.

srcstring | null

URL sumber untuk media tindihan.

videoStartTimeinteger | float | null

Masa mula video sumber, jika berkenaan.

python

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

json

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

KAEDAHclient.wait_for_job(job_id)

Tunggu pekerjaan

Memeriksa API sehingga pekerjaan sorotan mencapai keadaan selesai.

Parameters

job_idstring

ID pekerjaan untuk ditunggu.

Returns

Objek pekerjaan yang telah selesai.

python

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

KAEDAHclient.render(job_id)

Render output

Memulakan proses rendering video output untuk pekerjaan sorotan yang telah selesai.

Parameters

job_idstring

ID pekerjaan sorotan yang telah selesai.

output_indexinteger, optional

Indeks bagi senarai OutputResult yang akan dipaparkan. Lalai ialah 0. Secara amnya, keluaran pertama adalah hasil terbaik.

Returns

Objek hasil render dengan status render.

python

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

print(render_result.status)

KAEDAHclient.wait_for_render(job_id)

Tunggu render

Memeriksa sehingga rendering selesai dan output siap.

Parameters

job_idstring

ID pekerjaan yang berkaitan dengan rendering.

Returns

Objek hasil render akhir.

python

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