מחלקה: מנהל הפסקות

cast.מסגרת.מעברים.BreakManager

class   סטטי

כיתה לניהול הפסקות.

שיטות

addBreak

addBreak(breakData, breakClips, wideCastMediaStatus) חוזר בוליאני

הוספת קליפים דינמיים של הפסקה והפסקה. קטעי ההפסקה ישויכו להפסקה (break.ClipIds ו-break.duration יעודכנו בהתאם לקליפים).

פרמטר
breakData	cast.framework.messages.Break הערך לא יכול להיות ריק.
breakClips	מערך של cast.framework.messages.BreakClip שאינו null הערך לא יכול להיות ריק.
broadCastMediaStatus	אופציונלי boolean האם צריך לבדוק אם סטטוס ההפסקה הנוכחי השתנה ב-CAF. ייתכן שהדבר לא רצוי לפני התחלת ההפעלה, כי ייתכן שהמקבל עדיין יצטרך להוסיף עוד הפסקות (למשל, במהלך השלמת הטעינה).

החזרות

boolean True אם ההפסקה נוספה בהצלחה.

getBreakById

getBreakById(id) returns 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 משך קליפ ההפסקה הנוכחי. null, אם השחקן לא משמיע קליפ של ההפסקה.

getBreakClips

getBreakClips() מחזיר מערך של cast.framework.messages.BreakClip שאינו ריק

קבלת קליפים עדכניים מהפסקות מדיה.

החזרות

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

getBreaks

getBreaks() מחזיר מערך של cast.framework.messages.Break שאינו null

קבלת הפסקות מדיה עדכניות.

החזרות

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

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) returns cast.framework.breaks.CreativeInformation

הפונקציה מקבלת מידע על קריאייטיב שמשויך לקליפ לפי מזהה.

פרמטר
breakClipId	מחרוזת מזהה הקליפ.

החזרות

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() מחזיר בוליאני

הפונקציה מחזירה את הערך True אם צריך להפעיל את ההפסקות שנצפו.

החזרות

boolean 

removeBreakById

removeBreakById(breakId) returns boolean

הסרת הפסקה וקטעי הפסקות משויכים.

פרמטר
breakId	מחרוזת מזהה מעבר

החזרות

boolean True אם ההפסקה הוסרה בהצלחה.

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) intercept או null אם המפתח רוצה לאפס אותו לברירת המחדל. יירוט הדילוג המוגדר כברירת מחדל יחזיר את ההפסקה הקרובה ביותר מהערך ExploreTo. הערך יכול להיות אפס.

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

מגדיר דגל כדי לקבוע אם יש להפעיל את המעבר לחיבור התמונות של הלקוח שנצפה.

פרמטר
playWatchedBreak	boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

מספק מיירט לשינוי כתובת URL למעקב של VAST לפני שהיא נשלחת לשרת. הקלט של הגורם המיירט הוא מחרוזת של כתובת ה-URL למעקב. הכלי ליירוט יכול להחזיר מחרוזת של כתובת URL ששונתה או הבטחה למחרוזת כתובת URL ששונתה. הכלי ליירוט יכול גם להחזיר את הערך null אם רוצים לשלוח את כתובת ה-URL למעקב באמצעות קוד משלכם במקום דרך CAF.

פרמטר
מיירט	function(string) כלי יירוט שמשנה את כתובת ה-URL לפני שליחתה. הערך יכול להיות אפס.