מחלקה: PlayerManager

‪cast.framework.PlayerManager

class   static

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

מקפיצה את הודעות השגיאה (Throws)

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

Methods

addEventListener

addEventListener(eventType, eventListener)

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

פרמטר

eventType

(non-null cast.framework.events.EventType or non-null Array of non-null cast.framework.events.EventType)

סוג אירוע או מערך של סוגי אירוע

eventListener

function(non-null cast.framework.events.Event)
מקפיצה את הודעות השגיאה (Throws)

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

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

פרמטר

supportedMediaCommands

number

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

broadcastStatus

אופציונלי

בוליאני

‫true מציין שצריך להודיע לשולחים על השינוי (אם לא מצוין, השולחים לא יקבלו הודעה).
ראה גם
cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

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

פרמטר

includeMedia

אופציונלי

בוליאני

‫true מציין שההודעה צריכה לכלול פרטי מדיה.

requestId

אופציונלי

number

המזהה של הבקשה הנכנסת שגרמה לתשובה הזו.

customData

אופציונלי

אובייקט

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

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

includeQueueItems

אופציונלי

בוליאני

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

getAbsoluteTimeForMediaTime

‫getAbsoluteTimeForMediaTime(mediaTime) מחזירה מספר

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

פרמטר

mediaTime

number

הזמן במדיה.
מחזירה

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() returns Array of non-null cast.framework.messages.Break

מחזירה רשימה של הפסקות פרסומות.

מחזירה

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

getCurrentSupportedMediaCommands

‫getCurrentSupportedMediaCommands()‎ מחזירה מספר

מקבלת את פקודות המדיה הנתמכות הנוכחיות של המקבל. בניגוד ל-getSupportedMediaCommands(), הערך שה-method הזו מחזירה משתנה באופן דינמי על סמך סטטוס ההפעלה הנוכחי. לדוגמה, יכול להיות שלא תהיה תמיכה בפקודה SEEK במהלך הפעלת מודעות. אפשר להפעיל את ה-method הזו רק אחרי שקוראים למקבל 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(absoluteTime) מחזירה מספר

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

פרמטר

absoluteTime

number

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

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()‎ מחזירה מספר

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

מחזירה

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 אם לא מופעלת מדיה.

getRawSeekableRange

‫getRawSeekableRange()‎ מחזירה cast.framework.messages.Range

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

הערה: זה תואם ליחידות של getRawCurrentTimeSec(), אבל לא ל-seek()!. לא נלקחים בחשבון מודעות או היסטים אחרים במדיה. אלא אם אתם בטוחים שאתם צריכים את הערכים הגולמיים, עדיף להשתמש ב-getLiveSeekableRange().

מחזירה

nullable cast.framework.messages.Range 

getStartAbsoluteTime

‫getStartAbsoluteTime()‎ מחזירה מספר

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

מחזירה

nullable number 

getStats

הפונקציה getStats()‎ מחזירה 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

‫load(loadRequest) מחזירה אובייקט promise שמכיל void

מפעילה בקשה לטעינת מדיה.

פרמטר

loadRequest

cast.framework.messages.LoadRequestData

בקשה לטעינת מדיה.

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

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

pause

pause()‎

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

play

play()‎

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

removeEventListener

removeEventListener(eventType, eventListener)

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

פרמטר

eventType

(non-null cast.framework.events.EventType or non-null Array of non-null cast.framework.events.EventType)

‫eventType או מערך של סוגי אירועים

eventListener

function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

פרמטר

supportedMediaCommands

number

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

broadcastStatus

אופציונלי

בוליאני

‫true מציין שצריך להודיע לשולחים על השינוי (אם לא מצוין, השולחים לא יקבלו הודעה).
ראה גם
cast.framework.messages.Command

seek

seek(seekTime)‎

מעבר למיקום מסוים בפריט המדיה הנוכחי.

פרמטר

seekTime

number

sendCustomState

sendCustomState(state)

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

פרמטר

state

אובייקט

אובייקט של מצב בהתאמה אישית.

הערך לא יכול להיות null.
ראה גם
cast.framework.ui.PlayerData#customState

sendError

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

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

פרמטר

senderId

מחרוזת

מזהה השולח.

requestId

number

המזהה של הבקשה הנכנסת שגרמה לשגיאה הזו.

type

cast.framework.messages.ErrorType

סוג השגיאה.

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

reason

אופציונלי

cast.framework.messages.ErrorReason

הסיבה לשגיאה.

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

customData

אופציונלי

אובייקט

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

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

sendLocalMediaRequest

sendLocalMediaRequest(request)

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

פרמטר

request

cast.framework.messages.RequestData

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

sendStatus

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

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

פרמטר

senderId

מחרוזת

מזהה השולח.

requestId

number

המזהה של הבקשה הנכנסת שגרמה לתשובה הזו.

includeMedia

אופציונלי

בוליאני

‫true מציין שההודעה צריכה לכלול מופע של MediaInformation.

customData

אופציונלי

אובייקט

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

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

includeQueueItems

אופציונלי

בוליאני

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

setIdleReason

setIdleReason(idleReason)

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

פרמטר

idleReason

cast.framework.messages.IdleReason

הסיבה למצב IDLE.

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

setMediaElement

setMediaElement(mediaElement)

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

פרמטר

mediaElement

(non-null HTMLMediaElement or non-null Promise containing non-null HTMLMediaElement)

MediaElement שבו ישתמש ה-Player.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

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

פרמטר

mediaInformation

cast.framework.messages.MediaInformation

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

opt_broadcast

אופציונלי

בוליאני

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)

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

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

setMediaUrlResolver

setMediaUrlResolver(resolver)

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

פרמטר

resolver

function(non-null cast.framework.messages.LoadRequestData)

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

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

setMessageInterceptor

setMessageInterceptor(type, interceptor)

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

פרמטר

type

cast.framework.messages.MessageType

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

interceptor

function(non-null cast.framework.messages.RequestData)

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

setPlaybackConfig

setPlaybackConfig(playbackConfig)

קובעת את הגדרות ההפעלה ב-PlayerManager.

פרמטר

playbackConfig

cast.framework.PlaybackConfig

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

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

מגדירה את פקודות המדיה שהמקבל תומך בהן.

פרמטר

supportedMediaCommands

number

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

broadcastStatus

אופציונלי

בוליאני

‫true מציין שצריך להודיע לשולחים על השינוי (אם לא מצוין, השולחים לא יקבלו הודעה).
ראה גם
cast.framework.messages.Command

stop

stop()‎

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