مرجع واجهة برمجة التطبيقات

يعد VidioClient نقطة الدخول الرئيسية للتفاعل مع واجهة برمجة التطبيقات VIDIO من بايثون. استخدمه لتحميل الملفات، إنشاء وظائف تجميع النقاط البارزة، التحقق من حالة الوظائف، تقديم المخرجات، وانتظار انتهاء المعالجة.

الوصول إلى واجهة برمجة التطبيقات متاح حاليًا لخطة الاستوديو وما فوق.

نموذج العميل

يوفر VidioClient واجهة بسيطة للعمل مع واجهة برمجة التطبيقات VIDIO. بعد إنشاء عميل باستخدام مفتاح واجهة برمجة التطبيقات الخاصة بك، يمكنك تحميل ملفات الإدخال، إنشاء وظائف تجميع النقاط البارزة، استعلام حالة الوظائف، تقديم المخرجات، وانتظار انتهاء الوظائف.

خصائص

api_keystring

مفتاح واجهة برمجة التطبيقات VIDIO الخاص بك المستخدم للمصادقة على الطلبات.

طرق

فئةVidioClient(api_key)

تهيئة العميل

ينشئ مثيل جديد من VidioClient.

Parameters

api_keystring

مفتاح واجهة برمجة التطبيقات VIDIO الخاص بك.

Returns

مثيل VidioClient مُهيأ.

python

from vidio import VidioClient
import os

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

طريقةclient.upload(file_path)

تحميل ملف

يقوم بتحميل ملف محلي إلى VIDIO ويعيد نتيجة التحميل التي تحتوي على مفتاح الإدخال.

Parameters

file_pathstring

المسار المحلي للملف الذي ترغب في تحميله.

Returns

كائن نتيجة التحميل الذي يحتوي على `input_key`.

python

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

طريقةclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

إنشاء وظيفة تجميع النقاط البارزة

ينشئ وظيفة تجميع النقاط البارزة من واحدة أو أكثر من ملفات الإدخال المحملة.

Parameters

input_keyslist[string]

قائمة بمفاتيح الملفات المحملة التي تم إرجاعها من upload(). تحدد ترتيب مفاتيح الإدخال ترتيب الوسائط في الفيديو الناتج.

video_categorystring

فئة الفيديو مثل رياضة كرة. يمكن أن تكون بودكاست، رياضة كرة، غير رياضة كرة، عرض منتج تجميلي، زفاف، سفر، أخرى. للحصول على أفضل النتائج، حدد الفئة التي تتطابق أكثر مع محتواك. إذا لم يناسب محتواك أي فئة، استخدم أخرى.

output_lengthinteger

المدة المرغوبة للمخرجات بالثواني. يجب أن تكون المدة الناتجة أقل من أو تساوي الطول الكلي لجميع مقاطع الفيديو المدخلة مجتمعة.

aspect_ratiostring

نسبة عرض إلى ارتفاع المخرجات مثل أفقي، عمودي، أو مربع.

Returns

كائن وظيفة يحتوي على `job_id` ومعلومات الحالة.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="رياضة كرة",
    output_length=30,
    aspect_ratio="أفقي",
)

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

طريقةclient.get_job(job_id)

الحصول على وظيفة

يسترد الحالة الحالية لوظيفة.

Parameters

job_idstring

معرف الوظيفة الذي تم إرجاعه عند إنشاء وظيفة تجميع النقاط البارزة.

Returns

كائن وظيفة بأحدث حالة.

python

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

طريقةclient.wait_for_job(job_id)

انتظر الوظيفة

يستعلم عن واجهة برمجة التطبيقات حتى تصل وظيفة تجميع النقاط البارزة إلى حالة مكتملة.

Parameters

job_idstring

معرف الوظيفة التي تنتظرها.

Returns

كائن الوظيفة النهائية المكتملة.

python

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

طريقةclient.render(job_id)

تقديم المخرجات

يبدأ تقديم فيديو المخرجات لوظيفة تجميع النقاط البارزة المكتملة.

Parameters

job_idstring

معرف وظيفة تجميع النقاط البارزة المكتملة.

Returns

كائن نتيجة التقديم مع حالة التقديم.

python

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

print(render_result.status)

طريقةclient.wait_for_render(job_id)

انتظر التقديم

يستعلم حتى ينتهي التقديم وتكون المخرجات جاهزة.

Parameters

job_idstring

معرف الوظيفة المرتبط بالتقديم.

Returns

كائن نتيجة التقديم النهائية.

python

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