کلاس: BreakManager

قالب. چارچوب . می شکند . BreakManager

کلاس ایستا

کلاس برای مدیریت استراحت.

مواد و روش ها

addBreak

addBreak (breakData، breakClips، broadCastMediaStatus) بولین را برمی‌گرداند

کلیپ های شکست و شکست پویا را اضافه می کند. کلیپ های استراحت با استراحت مرتبط می شوند (break.breakClipIds و break.duration با توجه به کلیپ ها به روز می شوند).

پارامتر
breakData	cast.framework.messages.break مقدار نباید صفر باشد.
گیره های شکست	آرایه ای از cast.framework.messages.BreakClip غیر پوچ مقدار نباید صفر باشد.
وضعیت پخش رسانه ای	اختیاری بولی آیا CAF باید بررسی کند که آیا وضعیت استراحت فعلی تغییر کرده است یا خیر. این ممکن است قبل از شروع پخش مطلوب نباشد، زیرا ممکن است گیرنده همچنان نیاز به اضافه کردن وقفه های بیشتری داشته باشد (مثلاً در حین بارگذاری کامل).

برمی گرداند

boolean True if break با موفقیت اضافه شد.

getBreakById

getBreakById(id) cast.framework.messages.Break را برمی گرداند

شکست رسانه های فعلی را با شناسه دریافت می کند.

پارامتر
شناسه	رشته شکستن شناسه

برمی گرداند

nullable cast.framework.messages.Break

getBreakClipById

getBreakClipById(id) cast.framework.messages.BreakClip را برمی گرداند

کلیپ وقفه رسانه ای فعلی را با شناسه دریافت می کند.

پارامتر
شناسه	رشته شناسه کلیپ

برمی گرداند

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 را برمی گرداند

اطلاعات خلاقانه مرتبط با breakclip را با شناسه دریافت می کند.

پارامتر
breakClipId	رشته شناسه کلیپ

برمی گرداند

nullable cast.framework.breaks.CreativeInformation

getPlayWatchedBreak

getPlayWatchedBreak() بولی را برمی گرداند

اگر وقفه‌های تماشا شده باید پخش شوند، درست برمی‌گردند.

برمی گرداند

boolean

removeBreakById

removeBreakById(breakId) Boolean برمی گرداند

وقفه و کلیپ های استراحت مرتبط را حذف می کند.

پارامتر
breakId	رشته شناسه شکست

برمی گرداند

اگر شکست با موفقیت حذف شد، boolean است.

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(رهگیر)

یک رهگیر را فراهم می کند تا به توسعه دهنده اجازه دهد تا کلیپ های شکست بیشتری را وارد کند یا کلیپ شکست فعلی را قبل از شروع استراحت تغییر دهد.

اگر رهگیر صفر باشد، رهگیر را به حالت پیش فرض بازنشانی می کند. به طور پیش فرض VAST واکشی و تجزیه منطق در رهگیر پیش فرض. بنابراین اگر رهگیر سفارشی شده توسط توسعه دهنده تنظیم شود، منطق VAST لغو می شود و توسعه دهندگان باید منطق واکشی و تجزیه VAST خود را در رهگیر ارائه شده پیاده سازی کنند.

پارامتر
رهگیر	تابع ( cast.framework.messages.BreakClip غیر تهی، cast.framework.breaks غیر تهی اختیاری.BreakClipLoadInterceptorContext) رهگیر بارگیری کلیپ پیش‌فرض، همان گیره شکستن را به عنوان ورودی برمی‌گرداند. مقدار ممکن است صفر باشد.

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

یک رهگیر برای توسعه‌دهنده فراهم می‌کند تا مشخص کند که بعد از جستجو چه وقفه‌هایی را می‌خواهند بازی کنند.

پارامتر
به دنبال رهگیر	تابع ( cast.framework.breaks.BreakSeekData غیر تهی) اگر توسعه‌دهنده بخواهد آن را به حالت پیش‌فرض بازنشانی کند، رهگیر یا تهی است. رهگیر جستجوی شکست پیش‌فرض، نزدیک‌ترین فاصله را از مقدار seekTo برمی‌گرداند. مقدار ممکن است صفر باشد.

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

یک پرچم تنظیم می کند تا کنترل کند که آیا شکستن دوخت مشتری تماشا شده باید پخش شود یا خیر.

پارامتر
playWatchedBreak	بولی

setVastTrackingInterceptor

setVastTrackingInterceptor(رهگیر)

یک رهگیر برای تغییر URL ردیابی VAST قبل از ارسال به سرور ارائه می دهد. ورودی رهگیر یک رشته از URL ردیابی است. رهگیر می تواند یک رشته تغییر یافته URL یا یک Promise از رشته تغییر یافته URL را برگرداند. اگر بخواهید URL ردیابی را به جای CAF با کد خود ارسال کنید، رهگیر می تواند null را برگرداند.

پارامتر
رهگیر	تابع (رشته) یک رهگیر که URL را قبل از ارسال تغییر می دهد. مقدار ممکن است صفر باشد.