الصف: StreamManager

الشركة المصنِّعة

StreamManager

جديد StreamManager(videoElement, adUiElement, uiSettings)

المَعلمة

videoElement

عنصر فيديو HTML الذي سيتمّ تشغيله.

يجب ألا تكون القيمة فارغة.

adUiElement

اختيارية

عنصر HTML المطلوب استخدامه للاحتفاظ بعناصر واجهة المستخدم الخاصة بالإعلان. ويجب أن يتطابق هذا العنصر مع ارتفاع وعرض تشغيل الفيديو، كما يجب أن يظهر على سطحه مباشرةً. وفي حال عدم تقديمه، لن يتم عرض أي واجهة مستخدم، ولن يتم طلب أي إعلانات تتطلّب واجهة مستخدم، مثل الإعلانات القابلة للتخطّي.

يجب ألا تكون القيمة فارغة.

uiSettings

اختيارية

إعدادات واجهة المستخدم المطلوب استخدامها لهذا البث

يجب ألا تكون القيمة فارغة.

الرميات

عندما لا تفي معلَمات الإدخال بالمتطلبات.

الطُرق

contentTimeForStreamTime

يعرض contentTimeForStreamTime(streamTime) رقمًا.

عرض وقت المحتوى بدون إعلانات لوقت بث معيّن. يعرض وقت البث المحدد لأحداث البث المباشر.

المَعلمة

streamTime

الرقم

وقت البث مع الإعلانات المُدرَجة (بالثواني)

المرتجعات

number وقت المحتوى الذي يتوافق مع وقت البث المحدَّد بعد إزالة الإعلانات.

البؤرة

()التركيز

للتركيز على زر التخطّي، إذا كان متوفّرًا. وإذا لم يكن متوفّرًا، يتم التركيز على العناصر التفاعلية، بما في ذلك الرموز أو المواد الإبداعية التفاعلية.

getAdSkippableState

تعرض الطريقة getAdSteppableState() قيمة منطقية.

تعرض القيمة "صحيح" إذا كان بالإمكان تخطّي الإعلان في الوقت الحالي. وعند تغيير هذه القيمة، يتم تنشيط حدث StreamEvent.SKIPPABLE_STATE_CHANGED من خلال StreamManager.

المرتجعات

boolean صحيح إذا كان بالإمكان تخطّي الإعلان في الوقت الحالي، وخطأ في حال كان من الممكن تخطّي الإعلان

loadStreamMetadata

loadStreamMetadata()

يطلب هذا الإذن من حزمة تطوير البرامج (SDK) تحميل البيانات الوصفية للإعلان، ثم يبث StreamEvent.LOADED. يجب تشغيل هذه الميزة يدويًا بعد استرداد بيان البث من أداة دمج الفيديوهات التابعة لجهة خارجية. لا تُستخدم هذه السمة إلا مع الفيديوهات عند الطلب التي يتم عرضها على شكل مجموعات باستخدام أداة دمج الفيديوهات التابعة لجهة خارجية، وهي غير مسموح بها في طلبات البث الأخرى.

onTimedMetadata

onTimedMetadata(metadata)

البطاقات في قاموس البيانات الوصفية التي تمّت معالجتها ويتوقع القاموس المفتاح "TXXX" مع سلسلة البيانات الوصفية التي يحددها المستخدم كقيمة. إذا كان المشغّل يوفّر بيانات وصفية أولية، يمكنك طلب StreamManager.processMetadata بدلاً من ذلك.

المَعلمة

البيانات الوصفية

الكائن

قاموس بيانات التعريف.

يجب ألا تكون القيمة فارغة.

previousCuePointForStreamTime

يعرض سابقةCuePointForStreamTime(streamTime) CuePoint.

عرض الإشارة السابقة لوقت البث المحدّد تعرض قيمة خالية في حال عدم وجود نقطة إشارة مثل هذه. ويُستخدَم هذا الإجراء لتنفيذ ميزات مثل العودة إلى الفيديو السابق، ويتم طلبه عندما يرصد الناشر أنّ المستخدم أراد إعادة المستخدم إلى فاصل إعلاني.

المَعلمة

streamTime

الرقم

ووقت البث المرجو.

المرتجعات

nullable CuePoint يشير إلى التوقيت السابق لوقت البث المحدد.

processMetadata

processMetadata(type, data, timestamp)

معالجة البيانات الوصفية الموقوتة لأحداث البث المباشر يمكنك استخدامها إذا كان مشغّل الفيديو يوفّر بيانات وصفية غير معدَّلة مع طوابع زمنية، أو يمكنك طلب StreamManager.onTimedMetadata.

المَعلمة

كتابة

سلسلة

اكتب البيانات الوصفية. يجب أن يكون القيمة "ID3" لبروتوكول HLS، أو معرّف الموارد المنتظم (URI) لمعرّف مخطّط رسالة الحدث في DASH.

البيانات

(مصفوفة Uint8Array أو سلسلة غير فارغة)

بيانات العلامة الأولية بالنسبة إلى رقم التعريف 3، يجب أن يعرض جميع بيانات العلامة الأولية. بالنسبة إلى رسائل حدث DASH، يكون هذا هو سلسلة بيانات الرسالة.

timestamp

الرقم

يشير ذلك المصطلح إلى الوقت بالثواني الذي يجب فيه معالجة البيانات. بالنسبة إلى DASH، هذا هو وقت بدء رسالة الحدث.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

تستبدل جميع مَعلمات علامات الإعلان المستخدَمة لطلبات الإعلان القادمة في بث مباشر.

المَعلمة

adTagParameters

كائن بخصائص سلسلة

معلمات علامات الإعلان الجديدة. يجب أن يحتوي على قيم سلسلة.

يجب ألا تكون القيمة فارغة.

requestStream

requestStream(streamRequest)

يطلب هذا الإذن تحميل مصدر بيانات باستخدام مَعلمات البث المتوفّرة.

المَعلمة

streamRequest

StreamRequest

يحتوي على معلَمات لتحميل البيانات الوصفية للبث.

يجب ألا تكون القيمة فارغة.

إعادة ضبط

إعادة الضبط()

ستتم إعادة ضبط مدير البث وإزالة أي استطلاع مستمر.

setClickElement

setClickElement(clickElement)

لضبط عنصر النقر على الإعلانات في الإعلانات يُستخدم هذا العنصر كنقر أو مستقبل النقر أثناء عرض الإعلان، وقد يؤدي إلى الانتقال بعيدًا عن الصفحة الحالية. تم إيقاف هذه الميزة نهائيًا ويجب إرسال عنصر adUiElement إلى StreamManager بدلاً من ذلك. في حال توفير adUiElement للدالة الإنشائية StreamManager، ستصبح هذه الطريقة عبارة عن أمر فوري.

المَعلمة

clickElement

عنصر

العنصر المستخدَم عند النقر على الإعلان

قد تكون القيمة فارغة.

منهي العمل به
وفِّر adUiElement في الدالة الإنشائية StreamManager بدلاً من ذلك.

streamTimeForContentTime

يعرض StreamTimeForContentTime(contentTime) رقمًا

عرض وقت البث مع الإعلانات لفترة محتوى محددة لعرض الوقت المحدّد للمحتوى لأحداث البث المباشر.

المَعلمة

contentTime

الرقم

وقت المحتوى بدون أي إعلانات (بالثواني).

المرتجعات

number وقت البث الذي يتوافق مع وقت المحتوى المحدّد بعد إدراج الإعلانات.