מחלקה: PlayerManager

cast.framework.PlayerManager

class   סטטי

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

קליעות

non-null Error אם משתמשים ב-constructor ישירות. יש לגשת אל PlayerManager רק באמצעות קריאה ל-cast.framework.CastReceiverContext#getPlayerManager.

שיטות

addEventListener

addEventListener(eventType, eventListener)

הוספת event listener שמאזין לאירועי הפעלה.

פרמטר
eventType	(non-null cast.framework.events.EventType או מערך לא-null של cast.framework.events.EventType שאינו ריק) סוג אירוע או מערך של סוגי אירועים
eventListener	function(non-null cast.framework.events.Event)

קליעות

non-null Error אם הארגומנטים הנתונים לא חוקיים.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

פרמטר
supportedMediaCommands	מספר מסיכת סיביות של פקודות מדיה שנתמכות על ידי האפליקציה.
broadcastStatus	אופציונלי boolean true מציין שצריך להודיע לשולחים על השינוי (אם לא צוין, השולחים יקבלו הודעה).

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

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

פרמטר
includeMedia	אופציונלי boolean true מסמן שההודעה צריכה לכלול פרטי מדיה.
requestId	אופציונלי מספר המזהה של הבקשה הנכנסת שגרמה לתגובה הזו.
customData	אופציונלי אובייקט הודעת הסטטוס עם נתונים מותאמים אישית ספציפיים לאפליקציה. הערך יכול להיות אפס.
includeQueueItems	אופציונלי boolean האם לכלול פריטים בתור בהודעת הסטטוס. כברירת מחדל, הן לא נכללות.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) מספר החזרות

ממירה את זמן המדיה לזמן המוחלט של המדיה. הגדרת זמן מוחלט רלוונטית רק לשידורים חיים.

פרמטר
mediaTime	מספר זמן מדיה.

החזרות

nullable number זמן מוחלט או null אם לא זמין.

getAudioTracksManager

getAudioTracksManager() מחזיר cast.framework.AudioTracksManager

הפונקציה מקבלת את המופע AudioTracksManager.

החזרות

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() מחזיר מספר

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

החזרות

nullable number הזמן הנוכחי בשניות בקליפ ההפסקה הנוכחי. null כשהPlayer לא מפעיל את קליפ ההפסקה.

getBreakClipDurationSec

getBreakClipDurationSec() מחזיר מספר

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

החזרות

nullable number משך הזמן של קליפ ההפסקה הנוכחי. null כשהPlayer לא מפעיל קליפ של ההפסקה.

getBreakManager

getBreakManager() מחזיר cast.framework.breaks.BreakManager

הפונקציה מקבלת את המופע BreakManager.

החזרות

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() מחזיר מערך של cast.framework.messages.Break שאינו null

מחזירה רשימה של מעברי שורה.

החזרות

non-null Array of non-null cast.framework.messages.Break 

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() מחזיר מספר

קבלת פקודות המדיה הנתמכות עבור המקלט. שלא כמו בשיטה getSupportedMediaCommands(), הערך המוחזר של השיטה הזו משתנה באופן דינמי על סמך סטטוס ההפעלה הנוכחי. לדוגמה, במהלך הפעלת מודעות, יכול להיות שהפקודה SEEK לא נתמכת. יש להפעיל את השיטה הזו רק אחרי הקריאה לנמען CastReceiverContext#start, אחרת היא תחזיר 0.

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.Command

החזרות

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

getCurrentTimeSec

getCurrentTimeSec() מחזיר מספר

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

החזרות

number הזמן שחלף, בשניות. אם לא מופעלת מדיה , הערך יהיה 0.

getDurationSec

getDurationSec() מחזיר מספר

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

החזרות

number משך המדיה. NaN אם לא מופעלת מדיה.

getLiveSeekableRange

getLiveSeekableRange() חוזרת cast.framework.messages.LiveSeekableRange

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

החזרות

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

getMediaInformation() החזרת cast.framework.messages.MediaInformation

קבלת פרטי מדיה של המדיה הנוכחית.

החזרות

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

מספר ההחזרות getMediaTimeForAbsoluteTime(boluteTime)

ממירה את הזמן המוחלט של המדיה לזמן מדיה. הגדרת זמן מוחלט רלוונטית רק לשידורים חיים.

פרמטר
absoluteTime	מספר הזמן המוחלט של המדיה, כזמן מערכת UNIX (שניות מאז תקופת Unix).

החזרות

nullable number זמן מדיה או null אם הם לא זמינים.

getPlaybackConfig

getPlaybackConfig() מחזיר cast.framework.PlaybackConfig

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

החזרות

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() מחזיר מספר

מחזירה את קצב ההפעלה הנוכחי. הפונקציה מחזירה את הערך 1 לפני קריאה לנמען CastReceiverContext#start.

החזרות

number קצב ההפעלה הנוכחי.

getPlayerState

getPlayerState() מחזיר cast.framework.messages.PlayerState

הפונקציה מקבלת את המצב Player.

החזרות

non-null cast.framework.messages.PlayerState המצב של Player הנוכחי.

getPreferredPlaybackRate

getPreferredPlaybackRate() מחזיר מספר

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

החזרות

number 

getPreferredTextLanguage

getPreferredTextLanguage() מחזיר מחרוזת

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

החזרות

nullable string 

getPreferredTextStyle

getPreferredTextStyle() מחזיר cast.framework.messages.TextTrackStyle

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

החזרות

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() returns (cast.framework.QueueManager or undefined)

הפונקציה מקבלת את המופע QueueManager.

החזרות

(non-null cast.framework.QueueManager or undefined) 

getRawCurrentTimeSec

getRawCurrentTimeSec() מחזיר מספר

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

החזרות

number הזמן שחלף, בשניות. אם לא מופעלת מדיה , הערך יהיה 0.

getStartAbsoluteTime

getStartAbsoluteTime() מחזיר מספר

הפונקציה מקבלת את שעת ההתחלה המוחלטת של המדיה, כזמן UNIX Epoch (שניות מאז תקופת Unix). הגדרת זמן מוחלט רלוונטית רק לשידורים חיים.

החזרות

nullable number 

getStats

getStats() returns cast.framework.stats.Stats

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

החזרות

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getsupportedMediaCommands() מחזיר מספר

הפונקציה מקבלת פקודות מדיה שנתמכות על ידי המקבל. יש להפעיל אותה רק אחרי הקריאה ל-CastReceiverContext#start(), אחרת היא תחזיר 0. הערך הנתמך של פקודות מדיה נשלט אך ורק על ידי האפליקציה המקבלת . הוא לא מתעדכן באופן אוטומטי על סמך MediaStatus.

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.Command

החזרות

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

getTextTracksManager

getTextTracksManager() מחזיר cast.framework.TextTracksManager

הפונקציה מקבלת את המופע TextTracksManager.

החזרות

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() מחזירה מערך של cast.framework.TimedMetadata שאינו null

הפונקציה מחזירה מטא-נתונים מתוזמנים שנמצאו במהלך ניתוח המניפסט. הערך הוא #EXT-X-DATERANGE ב-HLS ו-EventStream ב-DASH.

החזרות

non-null Array of non-null cast.framework.TimedMetadata 

משקל

load(loadRequest) מחזיר הבטחה שמכילה void

שולח בקשה לטעון מדיה.

פרמטר
loadRequest	cast.framework.messages.LoadRequestData בקשה לטעון מדיה. הערך לא יכול להיות ריק.

החזרות

non-null Promise containing void מבטיחים שהפעולה תיפתר כשהפעולה תסתיים או תידחה אם היא נכשלה.

השהיה

pause()

השהיית המדיה שפועלת כרגע.

הפעלה, פליי

play()

הפעלת המדיה שמושהית כרגע.

removeEventListener

removeEventListener(eventType, eventListener)

מסיר את ה-event listener שנוסף לאירוע הפעלה נתון. אם אין event listener תואם, המערכת תתעלם מהשיחה הזו.

פרמטר
eventType	(non-null cast.framework.events.EventType או מערך לא-null של cast.framework.events.EventType שאינו ריק) eventType או מערך של סוגי אירועים
eventListener	function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

פרמטר
supportedMediaCommands	מספר מסיכת סיביות של פקודות מדיה שנתמכות על ידי האפליקציה.
broadcastStatus	אופציונלי boolean true מציין שצריך להודיע לשולחים על השינוי (אם לא צוין, השולחים יקבלו הודעה).

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.Command

הרץ

search(seekTime)

דילוג במדיה הנוכחית.

פרמטר
seekTime	מספר

sendCustomState

sendCustomState(state)

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

פרמטר
state	אובייקט אובייקט של מצב בהתאמה אישית. הערך לא יכול להיות ריק.

כדאי לעיין גם בפרטים הבאים

cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

שולח שגיאה לשולח ספציפי.

פרמטר
senderId	מחרוזת מזהה השולח
requestId	מספר המזהה של הבקשה הנכנסת שגרמה לשגיאה הזו.
סוג	cast.framework.messages.ErrorType סוג השגיאה. הערך לא יכול להיות ריק.
סיבה	אופציונלי cast.framework.messages.ErrorReason סיבת השגיאה. הערך יכול להיות אפס.
customData	אופציונלי אובייקט הודעת השגיאה על נתונים מותאמים אישית הספציפיים לאפליקציה. הערך יכול להיות אפס.

sendLocalMediaRequest

sendLocalMediaRequest(request)

שליחת בקשה למדיה מקומית.

פרמטר
בקשה	cast.framework.messages.RequestData הערך לא יכול להיות ריק.

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

שולח הודעה על סטטוס מדיה לשולח ספציפי.

פרמטר
senderId	מחרוזת מזהה השולח
requestId	מספר המזהה של הבקשה הנכנסת שגרמה לתגובה הזו.
includeMedia	אופציונלי boolean true מציין שההודעה צריכה לכלול מופע של MediaInformation.
customData	אופציונלי אובייקט הודעת הסטטוס עם נתונים מותאמים אישית ספציפיים לאפליקציה. הערך יכול להיות אפס.
includeQueueItems	אופציונלי boolean האם לכלול פריטים בתור בהודעת הסטטוס. כברירת מחדל, הן לא נכללות.

setIdleReason

setIdleReason(idleReason)

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

פרמטר
idleReason	cast.framework.messages.IdleReason הסיבה להיות במצב IDLE. הערך לא יכול להיות ריק.

setMediaElement

setMediaElement(mediaElement)

מגדיר את HTMLMediaElement לשימוש. אם מוגדר Promise של HTMLMediaElement, הפעלת המדיה תתחיל אחרי שתפתרו את הבעיה Promise.

פרמטר
mediaElement	(HTMLMediaElement שאינו ריק או non-null Promise המכיל HTMLMediaElement שאינו null) MediaElement שישמש את Player.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

מגדיר פרטי מדיה.

פרמטר
mediaInformation	cast.framework.messages.MediaInformation הערך לא יכול להיות ריק.
opt_broadcast	אופציונלי boolean

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

מגדירה handler שיחזיר או ישנה את cast.framework.PlaybackConfig, לבקשת טעינה ספציפית. הפרמטרים של ה-handler הם LoadRequestData ו-PlaybackConfig שמוגדרים כברירת מחדל עבור המקבל (מפורטים ב-CastReceiverOptions). handler צריך להחזיר הגדרת הפעלה ששונתה, או null כדי למנוע את ההפעלה של המדיה. הערך המוחזר יכול להיות גם Promise, כדי לאפשר המתנה לנתונים מהשרת.

פרמטר
handler	function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig) פונקציה שמספקת הגדרת הפעלה ספציפית לבקשה. הערך יכול להיות אפס.

setMediaUrlResolver

setMediaUrlResolver(resolver)

מגדירה handler שיחזיר את כתובת ה-URL של המדיה עבור בקשת LOAD. אפשר להשתמש ב-handler הזה כדי למנוע פרסום של כתובת ה-URL של תוכן המדיה כחלק מסטטוס המדיה. כברירת מחדל, קובץ המדיה contentId משמש ככתובת ה-URL של התוכן.

פרמטר
מקודד	function(non-null cast.framework.messages.LoadRequestData) פונקציה שמייצגת כתובת URL של תוכן מדיה. הערך יכול להיות אפס.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

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

פרמטר
סוג	cast.framework.messages.MessageType הערך לא יכול להיות ריק.
מיירט	function(non-null cast.framework.messages.RequestData) הערך יכול להיות אפס.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

מגדיר את תצורת ההפעלה בPlayerManager.

פרמטר
playbackConfig	cast.framework.PlaybackConfig הערך לא יכול להיות ריק.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

מגדיר את פקודות המדיה הנתמכות על ידי המקבל.

פרמטר
supportedMediaCommands	מספר מסיכת סיביות של פקודות מדיה שנתמכות על ידי האפליקציה.
broadcastStatus	אופציונלי boolean true מציין שצריך להודיע לשולחים על השינוי (אם לא צוין, השולחים יקבלו הודעה).

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.Command

עצירת ביניים

stop()

עוצר את המדיה שפועלת כרגע.