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

StreamManager

class   public

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

יצרן

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

יוצר.

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

זריקות

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

מאפיינים

clickElement

HTMLElement שאינו null

clickElement

HTMLElement שאינו null

streamMonitor

PodServingStreamMonitor שאינו null

Methods

addEventListener

הפונקציה addEventListener(type, listener) מחזירה void

הוספת listener לסוג האירוע הנתון.

פרמטר
סוג	מחרוזת סוג האירוע שרוצים להאזין לו.
listener	function(non-null StreamEvent) פונקציה שנקראת בכל פעם שמתרחש אירוע מהסוג הזה.

החזרת מוצרים

void 

contentTimeForStreamTime

הפונקציה contentTimeForStreamTime(streamTime) מחזירה מספר

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

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

החזרת מוצרים

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

מיקוד

הפונקציה focus() מחזירה void

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

החזרת מוצרים

void 

getAdSkippableState

הפונקציה getAdSkippableState()‎ מחזירה ערך בוליאני

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

החזרת מוצרים

boolean ערך True אם אפשר לדלג על המודעה כרגע, או False אחרת.

loadStreamMetadata

הפונקציה loadStreamMetadata() מחזירה void

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

החזרת מוצרים

void 

onTimedMetadata

הפונקציה onTimedMetadata(metadata) מחזירה void

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

פרמטר
מטא נתונים	(אובייקט null או אובייקט שאינו null עם מאפייני מחרוזת) המילון של המטא-נתונים.

החזרת מוצרים

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

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

פרמטר
streamTime	number שעת הסטרימינג שאליו בוצע המעבר.

החזרת מוצרים

(null or non-null CuePoint) נקודת העצירה הקודמת לזמן הסטרימינג הנתון.

processMetadata

הפונקציה processMetadata(type, data, timestamp) מחזירה void

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

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

החזרת מוצרים

void 

removeEventListener

הפונקציה removeEventListener(type, listener) מחזירה void

הסרת מאזין לסוג האירוע הנתון. פונקציית המאזין חייבת להיות שווה, לפי הפניה, לפונקציה שהועברה בעבר אל addEventListener.

פרמטר
סוג	מחרוזת סוג האירוע שעבורו רוצים להסיר את ה-listener.
listener	function(non-null StreamEvent) הפונקציה שרוצים להסיר כמאזין.

החזרת מוצרים

void 

replaceAdTagParameters

הפונקציה replaceAdTagParameters(adTagParameters) מחזירה void

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

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

החזרת מוצרים

void 

requestStream

הפונקציה requestStream(streamRequest) מחזירה void

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

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

החזרת מוצרים

void 

אפס

הפונקציה reset() מחזירה void

איפוס מנהל הסטרימינג והסרה של כל סקרים רציפים.

החזרת מוצרים

void 

setClickElement

הפונקציה setClickElement(clickElement) מחזירה void

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

פרמטר
clickElement	(אלמנט null או אלמנט שאינו null) הרכיב שמשמש כקליק על המודעה.

הוצא משימוש

במקום זאת, צריך לספק את adUiElement ל-constructor של StreamManager.

החזרת מוצרים

void 

streamTimeForContentTime

הפונקציה streamTimeForContentTime(contentTime) מחזירה מספר

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

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

החזרת מוצרים

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