Captions

ملاحظة: في 13 مارس 2024، أعلنت YouTube أنّ إيقاف العمل بالمعلَمة sync captions.insert و captions.update نقطة نهاية لواجهة برمجة التطبيقات. لا تزال ميزة المزامنة التلقائية للشرح متاحة في "استوديو YouTube". يمكنك الاطّلاع على سجل النُسخ السابقة لواجهة برمجة التطبيقات لـ المزيد من التفاصيل.

يمثّل مورد caption مسار ترجمة في YouTube. يرتبط مسار الترجمة بفيديو واحد فقط على YouTube.

الطُرق

تتيح واجهة برمجة التطبيقات استخدام الطرق التالية لموارد captions:

list
يمكنك استرداد قائمة بمسارات الترجمة المرتبطة بفيديو محدّد. يُرجى العِلم أنّ استجابة واجهة برمجة التطبيقات لا تتضمّن ترجمة وشرحًا، وأنّ طريقة captions.download تتيح استرداد مسار الترجمة والشرح. تجربة ذلك الآن
إدراج
تحميل مسار ترجمة وشرح
تعديل
تعديل مسار ترجمة وشرح عند تحديث مسار ترجمة وشرح، يمكنك تغيير حالة مسودّة المقطع الصوتي أو تحميل ملف ترجمة جديد للمقطع الصوتي أو تنفيذ كلا الإجراءَين.
حذف
حذف مسار ترجمة وشرح محدّد التجربة الآن
تنزيل
نزِّل مسار ترجمة وشرح. يتم عرض مسار الترجمة بتنسيقه الأصلي ما لم يحدِّد الطلب قيمة للمَعلمة tfmt وبلغتها الأصلية ما لم يحدّد الطلب قيمة للمَعلمة tlang.

تمثيل الموارد

تعرض بنية JSON التالية تنسيق مورد captions:

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

أماكن إقامة

يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:

أماكن إقامة
kind string
تحدد هذه السياسة نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#caption.
etag etag
تشير هذه السمة إلى علامة هذا المورد.
id string
المعرّف الذي تستخدمه YouTube لتحديد المقطع الصوتي للترجمة والشرح بشكل فريد
snippet object
يحتوي العنصر snippet على تفاصيل أساسية عن الترجمة والشرح.
snippet.videoId string
المعرّف الذي تستخدمه YouTube لتحديد الفيديو المرتبط بمسار الترجمة والشرح بشكل فريد
snippet.lastUpdated datetime
تاريخ ووقت آخر تعديل لمسار الترجمة يتم تحديد القيمة بتنسيق ISO 8601.
snippet.trackKind string
نوع مسار الترجمة والشرح.

في ما يلي القيم الصالحة لهذه السمة:
  • ASR – مسار ترجمة يتم إنشاؤه باستخدام التعرف التلقائي على الكلام.
  • forced – مسار ترجمة يتم تشغيله عند عدم تحديد مقطع صوتي آخر في المشغّل. على سبيل المثال، قد يتضمّن فيديو يعرض أجنبيًين يتحدثان بلغة أجنبية مسار ترجمة مُجبَرًا لعرض ترجمة للغة الأجنبية فقط.
  • standard – مسار ترجمة وشرح عادي هذه هي القيمة الافتراضية.
snippet.language string
لغة مسار الترجمة والشرح قيمة السمة هي علامة لغة BCP-47.
snippet.name string
اسم مسار الترجمة والشرح ومن المفترض أن يظهر الاسم للمستخدم كخيار أثناء التشغيل. يبلغ الحد الأقصى لطول الاسم المسموح به 150 حرفًا.
snippet.audioTrackType string
نوع المقطع الصوتي المرتبط بمسار الترجمة.

في ما يلي القيم الصالحة لهذه السمة:
  • commentary – يرتبط مقطع الترجمة والشرح بمقطع صوتي بديل يتضمّن تعليقًا، مثل تعليقات حول الدليل.
  • descriptive – يرتبط مسار الترجمة والشرح بمسار صوتي بديل يتضمّن محتوًى صوتيًا وصفيًا إضافيًا.
  • primary – يتوافق مسار الترجمة مع المقطع الصوتي الأساسي للفيديو، وهو المسار الصوتي المرتبط عادةً بالفيديو.
  • unknown – هذه هي القيمة التلقائية.
snippet.isCC boolean
يشير إلى ما إذا كان المقطع الصوتي يتضمن ترجمة وشرحًا للصمّ وضعاف السمع. القيمة التلقائية هي false.
snippet.isLarge boolean
يشير إلى ما إذا كان مسار الترجمة يستخدم نصًا كبيرًا لذوي العجز البصري. القيمة التلقائية هي false.
snippet.isEasyReader boolean
للإشارة إلى ما إذا كان مسار الترجمة والشرح بتنسيق "سهل القارئ" مما يعني أنه في مستوى الصف الثالث لمتعلمي اللغة. تكون القيمة التلقائية false.
snippet.isDraft boolean
تشير هذه العلامة إلى ما إذا كان مسار الترجمة والشرح عبارة عن مسودة. إذا كانت القيمة هي true، لن يكون المقطع الصوتي مرئيًا بشكل علني. القيمة التلقائية هي false.
snippet.isAutoSynced boolean
تشير هذه العلامة إلى ما إذا كان YouTube قد تزامن مسار الترجمة مع المقطع الصوتي في الفيديو. ستكون القيمة true إذا تم طلب المزامنة بشكل صريح عند تحميل مسار الترجمة. على سبيل المثال، عند استدعاء الطرق captions.insert أو captions.update، يمكنك ضبط المعلمة sync على true لتوجيه YouTube بمزامنة المقطع الصوتي الذي تم تحميله مع الفيديو. إذا كانت القيمة هي false، يستخدم YouTube رموز الوقت في مسار الترجمة والشرح المحمَّل لتحديد وقت عرض الترجمة.
snippet.status string
حالة مسار الترجمة والشرح.

القيم الصالحة لهذه السمة هي:
  • failed
  • serving
  • syncing
snippet.failureReason string
سبب تعذُّر معالجة مسار الترجمة على YouTube. تتوفّر هذه السمة فقط إذا كانت قيمة السمة state هي failed.

في ما يلي القيم الصالحة لهذه السمة:
  • processingFailed – تعذّر على YouTube معالجة مسار الترجمة والشرح الذي تم تحميله.
  • unknownFormat – لم يتم التعرف على تنسيق مسار الترجمة.
  • unsupportedFormat – تنسيق مسار الترجمة غير متوافق.