מחלקה: PlayerManager

‪cast.framework.PlayerManager

class   static

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

זריקות

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)
זריקות

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

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

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 (מספר השניות מאז ראשית זמן יוניקס). הזמן המוחלט רלוונטי רק לשידורים חיים.

החזרות

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(loadRequest) מחזירה Promise שמכילה void

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

פרמטר

loadRequest

cast.framework.messages.LoadRequestData

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

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

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

השהיה

pause()

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

הפעלה

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)

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

eventListener

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

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

פרמטר

supportedMediaCommands

number

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

broadcastStatus

אופציונלי

בוליאני

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

הרץ

seek(seekTime)‎

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

פרמטר

seekTime

number

sendCustomState

sendCustomState(state)

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

פרמטר

הסמוי הסופי

אובייקט

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

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

sendError

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

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

פרמטר

senderId

מחרוזת

מזהה השולח.

requestId

number

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

סוג

cast.framework.messages.ErrorType

סוג השגיאה.

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

סיבה

אופציונלי

cast.framework.messages.ErrorReason

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

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

customData

אופציונלי

אובייקט

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

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

sendLocalMediaRequest

sendLocalMediaRequest(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 של התוכן.

פרמטר

מקודד

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

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

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

setMessageInterceptor

setMessageInterceptor(type, interceptor)

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

פרמטר

סוג

cast.framework.messages.MessageType

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

מיירט

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()

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