Class StreamManager

מטפל בשידורים עם הטמעת מודעות דינמיות (DAI). המחלקות האלה מנהלות אינטראקציות עם שרתי DAI, מטפלות בפינגים של מעקב ופולטות אירועים של סטרימינג ומודעות.
יצרנים
constructor
Methods
addEventListener
מוסיפה listener לסוג האירוע שצוין.
contentTimeForStreamTime
הפונקציה מחזירה את זמן הצפייה בתוכן בלי מודעות עבור זמן צפייה נתון בסטרימינג.
focus
העברת המיקוד ללחצן הדילוג, אם הוא קיים.
getAdSkippableState
הפונקציה מחזירה ערך true אם המשתמש יכול לדלג על המודעה הנוכחית.
loadStreamMetadata
הבקשה שולחת ל-DAI SDK לטעון מטא-נתונים של מודעות ופולטת אירוע LOADED stream.
onTimedMetadata
העברה במילון של מטא-נתונים מעובדים.
previousCuePointForStreamTime
מחזירה את נקודת ה-cue הקודמת לזמן הנתון בשידור.
processMetadata
מעבד מטא-נתונים מתוזמנים לשידורים.
removeEventListener
מסירה listener עבור סוג האירוע StreamEvent שצוין.
replaceAdTagParameters
מחליפה את כל הפרמטרים של תג המודעה שמשמשים לבקשות להצגת מודעות עתידיות בשידור חי.
requestStream
שליחת בקשה לטעינת שידור של הטמעת מודעות דינמיות (DAI) ב-IMA באמצעות פרמטרים של שידור שסופקו.
reset
מאפס את כלי הניהול של השידור ומסיר את כל הסקרים הרציפים.
streamTimeForContentTime
הפונקציה מחזירה את משך הצפייה הכולל בתוכן עם מודעות, בהינתן משך הצפייה בתוכן.

יצרנים

constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
פרמטרים
videoElement: HTMLVideoElement רכיב הווידאו ב-HTML שבו מתבצעת ההפעלה.
Optional adUiElement: HTMLElement האלמנט שבו ממשק המשתמש של המודעה מעובד.
Optional uiSettings: UiSettings הגדרות ממשק המשתמש שבהן יש להשתמש בשידור הזה.
החזרות
StreamManager

Methods

addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
מוסיפה listener לסוג האירוע שצוין.
פרמטרים
type: Type | Type[] סוג אירוע המודעה או מערך של סוגי אירועים.
listener: ((event: StreamEvent) => void) פונקציית קריאה חוזרת למאזין המודעות.

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
הפונקציה מחזירה את זמן הצפייה בתוכן בלי מודעות עבור זמן צפייה נתון בסטרימינג. הפונקציה מחזירה את הזמן שחלף בשידור החי שצוין.
פרמטרים
streamTime: number משך הצפייה בסטרימינג בשניות, כולל תוכן ומודעות.
החזרות
number זמן התוכן לזמן הסטרימינג הנתון, לא כולל מודעות.

focus

focus(): void
העברת המיקוד ללחצן הדילוג, אם הוא קיים. אם הוא לא קיים, המיקוד חוזר לרכיב האינטראקטיבי.

getAdSkippableState

getAdSkippableState(): boolean
הפונקציה מחזירה ערך true אם המשתמש יכול לדלג על המודעה הנוכחית. כשהערך הזה משתנה, המחלקה StreamManager שולחת אירוע של זרם SKIPPABLE_STATE_CHANGED.
החזרות
boolean ‫true אם המשתמש יכול לדלג על המודעה הנוכחית, false אחרת.

loadStreamMetadata

loadStreamMetadata(): void
הבקשה שולחת את ה-SDK של DAI לטעון מטא-נתונים של מודעות ופולטת LOADED אירוע של סטרימינג. צריך להפעיל את השיטה הזו באופן ידני כשמאחזרים את מניפסט הסטרימינג מהכלי החיצוני לחיבור סרטונים. השיטה הזו מיועדת רק להצגת מודעות בסטרימינג של תוכן וידאו על פי דרישה (VOD) עם תוכנת תפירת מודעות של צד שלישי.

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
העברה במילון של מטא-נתונים מעובדים. המילון מצפה למפתח המדויק "TXXX" עם מחרוזת המטא-נתונים שהוגדרה על ידי המשתמש כערך. אם נתוני המטא-נתונים הגולמיים מסופקים על ידי נגן, צריך לקרוא לשיטה StreamManager.processMetadata במקום זאת.
פרמטרים
metadata: {
  [key: string]: string;
} 		המילון של המטא-נתונים.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
מחזירה את נקודת ה-cue הקודמת לזמן הנתון בשידור. אם לא קיים cuepoint קודם, הפונקציה מחזירה null. אפשר להשתמש בשיטה הזו כדי להטמיע תכונות כמו חזרה מהירה (snapback) על ידי קריאה לשיטה כשהמשתמש מבקש לחזור להפסקה למודעה.
פרמטרים
streamTime: number השעה בשידור שהמשתמש מחפש.
החזרות
CuePoint ה-cuepoint הקודם לזמן השידור הנתון.

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
מעבד מטא-נתונים מתוזמנים לשידורים. כדאי להשתמש בשיטה הזו אם נגן הווידאו מספק מטא-נתונים לא מנותחים עם חותמות זמן. אחרת, מתקשרים אל StreamManager.onTimedMetadata.
פרמטרים
type: string הסוג של המטא-נתונים. צריך להיות מחרוזת 'ID3' עבור HLS, או URI של מזהה סכימת הודעות של אירוע עבור DASH.
data: string | Uint8Array נתוני תג גולמיים. במקרה של ID3, צריך להזין את כל נתוני התג הגולמיים. עבור הודעות אירועים ב-DASH, זוהי מחרוזת נתוני ההודעה.
timestamp: number הזמן בשניות שבו הנתונים יעובדו. ב-DASH, הפרמטר הזה הוא שעת ההתחלה של הודעת האירוע.

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
מסירה listener עבור סוג האירוע הנתון StreamEvent. כדי להסיר מאזין בהצלחה, פרמטר המאזין שמעבירים לשיטה הזו צריך להיות שווה בהפניה לפרמטר שהועבר קודם לשיטה addEventListener.
פרמטרים
type: Type סוג האירוע שעבורו רוצים להסיר את ה-listener.
listener: ((event: StreamEvent) => void) הפונקציה להסרה של משתמשים מהרשימה של מי שיכולים להאזין.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
הפקודה מחליפה את כל הפרמטרים של תג המודעה שמשמשים לבקשות להצגת מודעות עתידיות בשידור חי.
פרמטרים
adTagParameters: {
  [key: string]: string;
} 		הפרמטרים של תג המודעה החלופי. הערכים חייבים להיות מחרוזות.

requestStream

requestStream(streamRequest: StreamRequest): void
שליחת בקשה לטעינת שידור של הטמעת מודעות דינמיות (DAI) ב-IMA באמצעות פרמטרים של שידור שסופקו.
פרמטרים
streamRequest: StreamRequest מכיל פרמטרים לטעינת המטא-נתונים של הסטרימינג.

איפוס

reset(): void
מאפס את מנהל השידור ומסיר את כל הסקרים הרציפים.

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
הפונקציה מחזירה את משך הצפייה הכולל בתוכן עם מודעות, בהינתן משך הצפייה בתוכן. הפונקציה מחזירה את הזמן של התוכן שצוין בשידורים חיים.
פרמטרים
contentTime: number זמן התוכן בלי פרסומות בשניות.
החזרות
number זמן הסטרימינג הכולל שתואם לזמן התוכן הנתון אחרי שמודעות מוכנסות באמצעות DAI.