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

StreamManager

כיתה

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

יצרן

StreamManager

חדש StreamManager(videoElement, adUiElement, uiSettings)

פרמטר

videoElement

רכיב הווידאו ב-HTML שבו תתבצע ההפעלה.

הערך לא יכול להיות null.

adUiElement

אופציונלי

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

הערך לא יכול להיות null.

uiSettings

אופציונלי

הגדרות ממשק המשתמש שיש להשתמש בהן לשידור הזה.

הערך לא יכול להיות null.
קליעות

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

שיטות

contentTimeForStreamTime

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

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

פרמטר

streamTime

number

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

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

מיקוד

Focus()

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

getAdSkippableState

הפרמטר getAdSkipState() מחזיר ערך בוליאני

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

החזרות

boolean True אם אפשר לדלג על המודעה בשלב הזה. אחרת, הערך false.

loadStreamMetadata

loadStreamMetadata()

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

onTimedMetadata

onTimedMetadata(metadata)

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

פרמטר

מטא נתונים

אובייקט

מילון המטא-נתונים.

הערך לא יכול להיות null.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) מחזירה CuePoint

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

פרמטר

streamTime

number

זמן השידור הרצוי.
החזרות

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

processMetadata

processMetadata(type, data, timestamp)

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

פרמטר

סוג

string

מקלידים את המטא-נתונים. חייב להיות 'ID3' ל-HLS או ל-URI של מזהה סכמת הודעות האירוע ל-DASH.

נתונים

(לא null Uint8Array או מחרוזת)

נתוני תגים גולמיים. עבור ID3, חייבים להיות כל הנתונים הגולמיים של התג. להודעות אירוע DASH, זוהי מחרוזת נתוני ההודעה.

חותמת זמן

number

הזמן בשניות שבו צריך לעבד את הנתונים עבור DASH, זוהי שעת ההתחלה של הודעת האירוע.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

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

פרמטר

adTagParameters

אובייקט עם מאפייני מחרוזת

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

הערך לא יכול להיות null.

requestStream

requestStream(streamRequest)

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

פרמטר

streamRequest

StreamRequest

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

הערך לא יכול להיות null.

אפס

איפוס()

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

setClickElement

setClickElement(clickElement)

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

פרמטר

clickElement

רכיב

הרכיב ששימש כקליק על המודעה.

הערך יכול להיות null.
חסר ערך
במקום זאת, יש לספק adUiElement ל-constructor של StreamManager.

streamTimeForContentTime

StreamTimeForContentTime(contentTime) מחזיר את מספר

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

פרמטר

contentTime

number

משך הזמן ללא מודעות בתוכן (בשניות).
החזרות

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