الصف: StreamManager

StreamManager

class   public

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

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

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

طريقة الإنشاء

المَعلمة

videoElement

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

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

adUiElement

اختياري

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

uiSettings

اختياري

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

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

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

الخصائص

clickElement

عنصر HTMLElement غير صفري

clickElement

عنصر HTMLElement غير صفري

streamMonitor

PodServingStreamMonitor غير صفري

الطُرق

addEventListener

تُعرِض دالة addEventListener(type, listener) قيمة فارغة.

تُضيف أداة معالجة لنوع الحدث المحدّد.

المَعلمة

كتابة

سلسلة

نوع الحدث الذي سينشط له المشغِل.

أداة معالجة الحدث

function(non-null StreamEvent)

دالة يتمّ استدعاؤها في كلّ مرّة يقع فيها حدث من هذا النوع.
المرتجعات

void 

contentTimeForStreamTime

تُعرِض دالة contentTimeForStreamTime(streamTime) رقمًا.

تعرِض هذه السمة وقت عرض المحتوى بدون إعلانات في وقت بث معيّن. لعرض وقت البث المباشر المحدّد

المَعلمة

streamTime

الرقم

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

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

البؤرة

تُعرِض الدالة focus() قيمة فارغة.

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

المرتجعات

void 

getAdSkippableState

تُعرِض الدالة getAdSkippableState() قيمة منطقية.

تعرِض هذه السمة القيمة true إذا كان بالإمكان حاليًا تخطي الإعلان. عندما تتغيّر هذه القيمة، يُشغِّل StreamManager حدثًا StreamEvent.SKIPPABLE_STATE_CHANGED.

المرتجعات

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

loadStreamMetadata

تُعرِض الدالة loadStreamMetadata() قيمة فارغة.

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

المرتجعات

void 

onTimedMetadata

تُعرِض دالة onTimedMetadata(metadata) قيمة فارغة.

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

المَعلمة

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

(عنصر فارغ أو غير فارغ يتضمّن سمات سلسلة)

قاموس البيانات الوصفية
المرتجعات

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

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

المَعلمة

streamTime

الرقم

وقت البث الذي تم التقديم أو الإيقاف إليه
المرتجعات

(null or non-null CuePoint) نقطة البدء السابقة لوقت البث المحدّد

processMetadata

تُعرِض الدالة processMetadata(type, data, timestamp) قيمة فارغة.

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

المَعلمة

كتابة

سلسلة

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

البيانات

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

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

timestamp

الرقم

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

void 

removeEventListener

لا تُعرِض removeEventListener(type, listener) أي قيمة.

تزيل أداة معالجة لنوع الحدث المحدّد. يجب أن تكون دالة المستمع مساوية من حيث المراجع للدالة التي تم تمريرها سابقًا إلى addEventListener.

المَعلمة

كتابة

سلسلة

نوع الحدث الذي يجب إزالة أداة معالجته

أداة معالجة الحدث

function(non-null StreamEvent)

وظيفة الإزالة كمستمع
المرتجعات

void 

replaceAdTagParameters

تُعرِض الدالة replaceAdTagParameters(adTagParameters) قيمة فارغة.

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

المَعلمة

adTagParameters

عنصر يتضمّن سمات سلاسل

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

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

void 

requestStream

تُعرِض requestStream(streamRequest) قيمة فارغة.

تطلب تحميل بث باستخدام مَعلمات البث المقدَّمة.

المَعلمة

streamRequest

StreamRequest

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

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

void 

إعادة ضبط

تُعرِض الدالة reset() قيمة فارغة.

يؤدي هذا الإجراء إلى إعادة ضبط مدير البث وإزالة أي عمليات استطلاع مستمرة.

المرتجعات

void 

setClickElement

تُعرِض دالة setClickElement(clickElement) قيمة فارغة.

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

المَعلمة

clickElement

(عنصر فارغ أو غير فارغ)

العنصر المستخدَم كرابط للانتقال إلى الإعلان
منهي العمل به
قدِّم عنصر adUiElement إلى منشئ StreamManager بدلاً من ذلك.
المرتجعات

void 

streamTimeForContentTime

تُعرِض دالة streamTimeForContentTime(contentTime) رقمًا.

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

المَعلمة

contentTime

الرقم

مدة المحتوى بدون أي إعلانات (بالثواني)
المرتجعات

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