الصف: BreakManager

cast.إطار العمل.فواصل.BreakManager

class   ثابت

صف لإدارة أوقات الاستراحة.

الطُرق

addBreak

تعرض addBreak(breakData, breakClips, broadCastMediaStatus) قيمة منطقية

إضافة فواصل ديناميكية وفواصل المقاطع سيتم ربط مقاطع الفواصل (سيتم تعديل break.breakClipIds و break.duration وفقًا للمقاطع).

المَعلمة

breakData

cast.framework.messages.Break

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

breakClips

مصفوفة cast.framework.messages.BreakClip غير الفارغة

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

broadCastMediaStatus

إجراء اختياري

boolean

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

boolean صحيح إذا تمت إضافة الفاصل بنجاح.

getBreakById

تعرض getBreakById(id) cast.framework.messages.Break

للحصول على فاصل إعلاني حالي حسب رقم التعريف

المَعلمة

id

سلسلة

رقم تعريف الفاصل.
المرتجعات

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) returns cast.framework.messages.BreakClip

للحصول على المقطع الحالي للفاصل الإعلامي حسب المعرّف.

المَعلمة

id

سلسلة

معرّف المقطع
المرتجعات

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

تعرض getBreakClipCurrentTimeSec() رقمًا.

لعرض الوقت الحالي بالثواني في مقطع الفواصل قيد التشغيل حاليًا.

المرتجعات

nullable number الوقت الحالي بالثواني داخل مقطع الفاصل الحالي لا شيء، إذا لم يكن اللاعب يلعب مقطع استراحة.

getBreakClipDurationSec

تُرجع الدالة getBreakClipDurationSec() رقمًا

لعرض المدة بالثواني لمقطع الفواصل قيد التشغيل حاليًا.

المرتجعات

nullable number مدة مقطع الفاصل الحالي لا شيء، إذا لم يكن اللاعب يشغّل مقطع استراحة.

getBreakClips

تعرض getBreakClips() مصفوفة cast.framework.messages.BreakClip غير الفارغة.

عرض مقاطع حالية للفواصل الإعلانية

المرتجعات

non-null Array of non-null cast.framework.messages.BreakClip 

getBreaks

تعرض getBreaks() صفيفًا من cast.framework.messages.Break غير الفارغة.

عرض الفواصل الإعلانية الحالية في الوسائط.

المرتجعات

non-null Array of non-null cast.framework.messages.Break 

getCreativeInfoByClipId

تعرض getCreativeInfoByClipId(breakClipId) cast.framework.breaks.CreativeInformation

الحصول على معلومات إبداعية مرتبطة بمقطع الفواصل حسب المعرّف.

المَعلمة

breakClipId

سلسلة

معرّف المقطع
المرتجعات

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

تُرجع الدالة getPlaywatchedBreak() قيمة منطقية.

تعرِض القيمة "صحيح" إذا كان يجب تشغيل الفواصل الإعلانية التي تمت مشاهدتها.

المرتجعات

boolean 

removeBreakById

إزالة BreakById(breakId) يُرجع قيمة منطقية

لإزالة الفواصل الإعلانية ومقاطع الفواصل الإعلانية المرتبطة بها.

المَعلمة

breakId

سلسلة

رقم تعريف الفاصل
المرتجعات

boolean صحيح إذا تمت إزالة الفاصل بنجاح.

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

يوفر أداة اعتراض للسماح للمطوّر بإدراج المزيد من مقاطع الفواصل أو تعديل مقطع الفواصل الحالية قبل بدء الفاصل.

إذا كان المعترض قيمة فارغة، فستتم إعادة ضبط التقاطع على القيمة التلقائية. بشكل تلقائي، يتم جلب ومنطق تحليل نموذج عرض إعلانات الفيديو (VAST) في أداة الاعتراض التلقائية. وبالتالي، في حال ضبط مطوّر البرامج الاعتراض المخصّص، سيتم إلغاء منطق VAST، وعلى المطوّرين تنفيذ منطق استرجاع وتحليل نموذج عرض إعلانات الفيديو (VAST) في أداة الاعتراض التي تم توفيرها.

المَعلمة

جهاز اعتراض

function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext)

وسيعرض أداة اعتراض تحميل مقطع الفاصل التلقائي مقطع الفاصل نفسه كإدخال.

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

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

يتم توفير أداة اعتراض للمطوّر لتحديد الفواصل التي يريد تشغيلها بعد التقديم.

المَعلمة

seekInterceptor

function(non-null cast.framework.breaks.BreakSeekData)

تقاطع أو قيمة فارغة إذا أراد المطوّر إعادة ضبطه على القيمة التلقائية وسيعرض أداة اعتراض محاولة الفاصل التلقائي أقرب فاصل من قيمة SeeTo.

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

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

تضع علامة للتحكّم في ما إذا كان يجب تشغيل فاصل تركيب العميل الذي تمت مشاهدته.

المَعلمة

playWatchedBreak

boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

توفر أداة اعتراض لتعديل عنوان URL لتتبع نموذج عرض إعلانات الفيديو (VAST) قبل إرساله إلى الخادم. إدخال أداة الاعتراض هو سلسلة من عنوان URL للتتبُّع. ويمكن أن تعرض أداة الاعتراض سلسلة معدّلة من عنوان URL أو تعهدًا بسلسلة معدّلة من عنوان URL. ويمكن أن تعرض أداة الاعتراض أيضًا قيمة فارغة إذا كنت تريد إرسال عنوان URL للتتبّع باستخدام رمزك الخاص بدلاً من استخدام CAF.

المَعلمة

جهاز اعتراض

الدالة(سلسلة نصية)

أداة اعتراض تعدِّل عنوان URL قبل الإرسال.

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