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 – تنسيق مسار الترجمة والشرح غير متوافق.