एपीआई संदर्भ

VidioClient मुख्य प्रवेश बिंदु है VIDIO API के साथ Python से बातचीत करने के लिए। इसका उपयोग फ़ाइलें अपलोड करने, हाइलाइट रील नौकरियों का निर्माण करने, नौकरी की स्थिति की जांच करने, आउटपुट बनाने और प्रसंस्करण पूरा होने की प्रतीक्षा करने के लिए करें।

एपीआई एक्सेस वर्तमान में स्टूडियो योजना और उससे ऊपर के लिए उपलब्ध है।

क्लाइट मॉडल

VidioClient VIDIO API के साथ काम करने के लिए एक सरल इंटरफ़ेस प्रदान करता है। अपने API कुंजी के साथ एक क्लाइट बनाने के बाद, आप इनपुट फ़ाइलें अपलोड कर सकते हैं, हाइलाइट रील नौकरियों का निर्माण कर सकते हैं, नौकरी की स्थिति की जांच कर सकते हैं, आउटपुट बना सकते हैं, और नौकरियों को समाप्त होने की प्रतीक्षा कर सकते हैं।

गुण

api_keystring

आपकी VIDIO API कुंजी जिसका उपयोग अनुरोधों को प्रमाणीकरण करने के लिए किया जाता है।

विधियाँ

CLASSVidioClient(api_key)

क्लाइट प्रारंभ करें

एक नया VidioClient उदाहरण बनाता है।

Parameters

api_keystring

आपकी VIDIO API कुंजी।

Returns

एक कॉन्फ़िगर किया गया VidioClient उदाहरण।

python

from vidio import VidioClient
import os

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

METHODclient.upload(file_path)

फ़ाइल अपलोड करें

एक स्थानीय फ़ाइल को VIDIO पर अपलोड करता है और इनपुट कुंजी के साथ एक अपलोड परिणाम लौटाता है।

Parameters

file_pathstring

आप जिस फ़ाइल को अपलोड करना चाहते हैं उसका स्थानीय पथ।

Returns

एक अपलोड परिणाम वस्तु जिसमें `input_key` शामिल है।

python

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

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

हाइलाइट रील बनाएं

एक या अधिक अपलोड की गई इनपुट फ़ाइलों से एक हाइलाइट रील नौकरी बनाता है।

Parameters

input_keyslist[string]

अपलोड की गई फ़ाइल कुंजी की एक सूची जो upload() द्वारा लौटाई जाती है। इनपुट कुंजियों का क्रम आउटपुट वीडियो में मीडिया का क्रम निर्धारित करता है।

video_categorystring

जैसे ball-sports वीडियो श्रेणी। यह podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others हो सकता है। सर्वश्रेष्ठ परिणामों के लिए, उस श्रेणी को निर्दिष्ट करें जो आपके सामग्री के सबसे करीब है। यदि आपकी सामग्री किसी श्रेणी में नहीं आती है, तो others का उपयोग करें।

output_lengthinteger

सेकंड में वांछित आउटपुट लंबाई। आउटपुट लंबाई सभी इनपुट वीडियो की कुल लंबाई के बराबर या उससे कम होनी चाहिए।

aspect_ratiostring

आउटपुट आस्पेक्ट अनुपात जैसे landscape, portrait, या square।

music_categorystring, optional

आउटपुट पर लागू करने के लिए पूर्वनिर्धारित संगीत श्रेणी। समर्थित मान हैं corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, और trending_vlogs। यदि आउटपुट की अवधि संगीत की अवधि से कम है, तो चुना गया ट्रैक आउटपुट के अनुरूप फिट होने के लिए लूप करेगा।

संगीत_वॉल्यूमinteger, optional

पृष्ठभूमि संगीत की आवाज़ 0 से 100 तक। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट 100 है।

original_audio_volumeinteger, optional

मूल स्रोत ऑडियो वॉल्यूम 0 से 100 तक। यदि प्रदान नहीं किया गया है, तो डिफ़ॉल्ट 100 है।

Returns

एक नौकरी वस्तु जिसमें `job_id` और स्थिति की जानकारी होती है।

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)

METHODclient.get_job(job_id)

नौकरी प्राप्त करें

एक नौकरी की वर्तमान स्थिति प्राप्त करता है।

Parameters

job_idstring

जब हाइलाइट रील नौकरी बनाई गई थी तब लौटाई गई नौकरी ID।

Returns

नवीनतम स्थिति के साथ एक नौकरी वस्तु।

Response fields

job_idstring

जॉब आईडी।

statusstring

वर्तमान जॉब स्थिति, जैसे submitted, queued, processing, processed, rendering, या rendered।

outputslist[OutputResult]

तब लौटाया जाता है जब जॉब पूरी तरह रेंडर हो गया हो और अंतिम उप-कार्य से आउटपुट डेटा उपलब्ध हो।

startfloat | null

आउटपुट सेगमेंट का प्रारंभ समय, यदि उपलब्ध हो।

endfloat | null

आउटपुट सेगमेंट का समाप्ति समय, यदि उपलब्ध हो।

thumbnailstring | null

आउटपुट के लिए थंबनेल पथ या URL।

durationfloat | null

आउटपुट की अवधि (सेकेंड में)।

fpsfloat | null

आउटपुट के लिए फ्रेम प्रति सेकंड (FPS)।

overlayslist[OverlayResult]

आउटपुट में शामिल सैनिटाइज़्ड ओवरले।

idinteger | null

ओवरले आईडी।

fileIDstring | null

संबंधित फ़ाइल आईडी, यदि उपलब्ध हो।

originalFileNamestring | null

ओवरले से संबंधित मूल इनपुट फ़ाइल नाम, यदि उपलब्ध हो।

from_integer | float | null

वह फ्रेम ऑफ़सेट जहाँ ओवरले शुरू होता है।

contentstring | null

ओवरले सामग्री का मान, जैसे थंबनेल पथ या ध्वनि पहचानकर्ता।

durationInFramesinteger | null

फ्रेमों में ओवरले की अवधि।

typestring | null

ओवरले प्रकार जैसे video या sound।

srcstring | null

ओवरले मीडिया के लिए स्रोत URL।

videoStartTimeinteger | float | null

स्रोत वीडियो का प्रारंभ समय, यदि लागू हो।

python

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

जेएसओएन

{
  "job_id": "abc123",
  "status": "रेंडर किया गया",
  "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": "रनिंग-नाइट-393139",
          "durationInFrames": 912,
          "type": "sound",
          "src": "https://..."
        }
      ],
      "fps": 59.94
     }
  ]
}

METHODclient.wait_for_job(job_id)

नौकरी के लिए प्रतीक्षा करें

जब तक हाइलाइट रील नौकरी पूर्ण स्थिति में नहीं पहुँचती तब तक API को पोल करता है।

Parameters

job_idstring

जिस नौकरी के लिए प्रतीक्षा करनी है उसकी नौकरी ID।

Returns

अंतिम पूर्ण नौकरी वस्तु।

python

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

METHODclient.render(job_id)

आउटपुट रेंडर करें

पूर्ण हाइलाइट रील नौकरी के लिए आउटपुट वीडियो को रेंडर करना प्रारंभ करता है।

Parameters

job_idstring

पूर्ण हाइलाइट रील नौकरी ID।

output_indexinteger, optional

दिखाने के लिए OutputResult सूची का सूचकांक। डिफ़ॉल्ट 0 है। सामान्यतः पहला आउटपुट सबसे अच्छा परिणाम होता है।

Returns

रेंडर स्थिति के साथ एक रेंडर परिणाम वस्तु।

python

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

print(render_result.status)

METHODclient.wait_for_render(job_id)

रेंडर के लिए प्रतीक्षा करें

जब तक रेंडर समाप्त नहीं होता है और आउटपुट तैयार नहीं होता है तब तक पोल करता है।

Parameters

job_idstring

जिस रेंडर के साथ नौकरी ID जुड़ी है।

Returns

अंतिम रेंडर परिणाम वस्तु।

python

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