Class StreamManager

מטפל בשידורים עם הטמעת מודעות דינמיות. המחלקות האלה מנהלות אינטראקציות עם שרתי DAI, מטפלות בפינגים של מעקב ופולטות אירועים של סטרימינג ומודעות.
יצרנים
constructor
Methods
addEventListener
מוסיפה listener לסוג האירוע שצוין.
contentTimeForStreamTime
הפונקציה מחזירה את זמן התוכן בלי מודעות עבור זמן סטרימינג נתון.
focus
העברת המיקוד ללחצן הדילוג, אם הוא קיים.
getAdSkippableState
הפונקציה מחזירה ערך true אם המשתמש יכול לדלג על המודעה הנוכחית.
loadStreamMetadata
שולחת בקשה ל-DAI SDK לטעינת מטא נתונים של מודעות ומפיקה אירוע LOADED stream.
onTimedMetadata
הפונקציה מעבירה מילון של מטא-נתונים מעובדים.
previousCuePointForStreamTime
מחזירה את נקודת האות הקודמת לזמן הנתון בשידור.
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, listener: ((event: StreamEvent) => void)): void
מוסיפה listener לסוג האירוע שצוין.
פרמטרים
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
שולח בקשה ל-DAI SDK לטעינת מטא נתונים של מודעות ומפיק LOADED אירוע סטרימינג. צריך להפעיל את השיטה הזו באופן ידני כשמאחזרים את מניפסט הסטרימינג מהכלי של הצד השלישי לחיבור סרטונים. השיטה הזו מיועדת רק להצגת מודעות בסטרימינג של תוכן וידאו על פי דרישה (VOD) עם כלי לחיבור תכנים של צד שלישי.

onTimedMetadata

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

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
מחזירה את נקודת האות הקודמת לזמן הנתון בשידור. אם לא קיים 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. כדי להסיר מאזין בהצלחה, פרמטר המאזין שמעבירים ל-method הזה צריך להיות שווה בהפניה לפרמטר שהועבר קודם ל-method‏ 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.