כיתה: מנהל סטרימינג

StreamManager

class,

מטפל בשידורים של הכנסת מודעות דינמיות. הוא מנהל את האינטראקציות עם הקצה העורפי של DAI ומטפל בפינגים של מעקב, וגם בהעברות בסטרימינג ובאירועי מודעות אל בעל התוכן הדיגיטלי. חשבון הניהול הזה לא יורש מ-BaseAdsManager כי הוא לא מנהל של מודעה ספציפית, אלא מנהל של כל הזרם

יצרן

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

פרמטר
videoElement	רכיב הווידאו ב-HTML שבו תתבצע ההפעלה. הערך לא יכול להיות ריק.
adUiElement	אופציונלי רכיב ה-HTML שבו משתמשים כדי להכיל את רכיבי ממשק המשתמש של המודעה. הרכיב הזה צריך להיות באותו גובה ורוחב כמו הפעלת הסרטון, והוא צריך להיות מוצג ישירות כשכבת-על. אם המדיניות לא מוגדרת, לא יוצג ממשק משתמש, ולא יישלחו בקשות להצגת מודעות שדורשות ממשק משתמש, כמו מודעות שניתן לדלג עליהן. הערך לא יכול להיות ריק.
uiSettings	אופציונלי הגדרות ממשק המשתמש שיהיו בשימוש עבור השידור הזה. הערך לא יכול להיות ריק.

הטמעות

EventTarget

קליעות

כשהפרמטרים של הקלט לא עומדים בדרישות.

שיטות

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) מחזיר מספר

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

פרמטר
streamTime	מספר זמן הסטרימינג עם מודעות שנוספו (בשניות).

החזרות

number זמן התוכן שתואם לשעת השידור הנתונה לאחר הסרת המודעות.

מיקוד

Focus()

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

getAdSkippableState

getAdSkippableState() חוזר בוליאני

הפונקציה מחזירה את הערך True אם כרגע ניתן לדלג על המודעה. כשהערך הזה משתנה, StreamManager מפעיל אירוע StreamEvent.SKIPPABLE_STATE_CHANGED.

החזרות

boolean True אם כרגע ניתן לדלג על המודעה, ו-FALSE אם לא.

loadStreamMetadata

loadStreamMetadata()

בקשת SDK תטען מטא-נתונים של מודעות ולאחר מכן היא משדרת את StreamEvent.LOADED. צריך להפעיל את ההגדרה הזו באופן ידני ברגע שהמניפסט של השידור אוחזר מהכלי ליצירת סרטונים של צד שלישי. האפשרות הזו משמשת רק להצגת VOD באמצעות כלי של צד שלישי לשידור וידאו, ואי אפשר להפעיל בקשות אחרות לשידור.

onTimedMetadata

onTimedMetadata(metadata)

כרטיסים במילון של מטא-נתונים מעובדים. המילון מצפה למפתח 'TXXX' עם מחרוזת המטא-נתונים שהוגדרה על ידי המשתמש בתור הערך. אם הנגן שלך מספק מטא-נתונים גולמיים, צריך לקרוא במקום זאת ל-StreamManager.processingMetadata.

פרמטר
מטא נתונים	אובייקט המילון של המטא-נתונים. הערך לא יכול להיות ריק.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) חוזר CuePoint

מחזירה את נקודת הרמז הקודמת לזמן השידור הנתון. הפונקציה מחזירה את הערך null אם לא קיימת נקודת סימון כזו. השיטה הזו משמשת להטמעת תכונות כמו Snapback, והיא מופעלת כשבעל התוכן הדיגיטלי מזהה שהמשתמש חיפש כדי להחזיר אותו להפסקה למודעה.

פרמטר
streamTime	מספר שעת השידור שחיפשתם.

החזרות

nullable CuePoint נקודת הרמז הקודמת לזמן השידור הנתון.

processMetadata

processMetadata(type, data, timestamp)

עיבוד מטא-נתונים מתוזמנים לגבי שידורים חיים. צריך להשתמש באפשרות הזו אם נגן הווידאו מספק מטא-נתונים שלא נותחו לצד חותמות זמן. אחרת, צריך לבצע קריאה אל StreamManager.onTimedMetadata.

פרמטר
סוג	מחרוזת מקלידים מטא-נתונים. הערך חייב להיות ID3 עבור HLS או של מזהה ה-URI של סכמת ההודעות לאירועים עבור DASH.
נתונים	(un-null Uint8Array או string) נתוני תג גולמיים. עבור ID3, חייב להיות כל נתוני התג הגולמיים. עבור הודעות אירוע DASH, זוהי מחרוזת נתוני ההודעה.
חותמת זמן	מספר הזמן בשניות שבו צריך לעבד את הנתונים. עבור DASH, זוהי שעת ההתחלה של הודעת האירוע.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

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

פרמטר
adTagParameters	אובייקט עם מאפייני מחרוזת הפרמטרים של תגי המודעות החדשים. יש להזין ערכי מחרוזת. הערך לא יכול להיות ריק.

requestStream

requestStream(streamRequest)

המערכת מבקשת לטעון שידור באמצעות הפרמטרים של השידור שסופקו.

פרמטר
streamRequest	StreamRequest מכיל פרמטרים לטעינת המטא-נתונים של השידור. הערך לא יכול להיות ריק.

אפס

איפוס

איפוס של מנהל השידור והסרה של סקרים מתמשכים.

setClickElement

setClickElement(clickElement)

מגדיר את רכיב הקליק על המודעה. הרכיב הזה משמש כמקלט קליקים או הקשה בזמן הצגה של מודעה, ויכול לגרום ליציאה מהדף הנוכחי. האפשרות הזו הוצאה משימוש עכשיו, ובמקום זאת יש להעביר adUiElement אל StreamManager. אם הפרמטר adUiElement מוקצה לבונה StreamManager, השיטה הזו הופכת ל-no-op.

פרמטר
clickElement	אלמנט הרכיב המשמש למעבר של הקליק על המודעה. הערך יכול להיות אפס.

הוצא משימוש

צריך לספק רכיב adUiElement לבנאי StreamManager במקום זאת.

streamTimeForContentTime

StreamTimeForContentTime(contentTime) מחזירה מספר

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

פרמטר
contentTime	מספר זמן התוכן ללא מודעות (בשניות).

החזרות

number זמן השידור התואם לזמן התוכן הנתון לאחר הוספת המודעות.