מחלקה: CastReceiverContext

cast.framework.CastReceiverContext

class   static

מנהל את הטעינה של הספריות הבסיסיות ומאתחל את ה-SDK הבסיסי של Cast Receiver.

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

non-null Error אם MediaElement לא נוצר בגוף המסמך. אם נוצרים כמה רכיבי מדיה, המפתח צריך להגדיר את המחלקה castMediaElement לאחד מהם, שבו ישתמש מקלט ה-CAF.

Methods

getInstance

static

‫getInstance()‎ מחזירה cast.framework.CastReceiverContext

הפונקציה מחזירה את המופע של CastReceiverContext singleton.

החזרות

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

מגדיר מאזין להודעות בערוץ הודעות בהתאמה אישית. אפשר להגדיר יותר ממאזין אחד למרחב שמות.

פרמטר
מרחב שמות	מחרוזת מרחב השמות. שימו לב שמרחב שמות תקין צריך לכלול את הקידומת "urn:x-cast:‎".
listener	function(non-null cast.framework.system.Message)

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

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

addEventListener

addEventListener(type, handler)

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

פרמטר
סוג	cast.framework.system.EventType הערך לא יכול להיות null.
handler	function(non-null cast.framework.system.Event)

canDisplayType

‫canDisplayType(mimeType, codecs, width, height, framerate) מחזירה ערך בוליאני

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

פרמטר
mimeType	מחרוזת סוג MIME של המדיה. הוא מורכב מסוג ומסוג משנה שמופרדים באמצעות לוכסן ('/'). הוא יכול להיות סוג MIME של וידאו או של אודיו.
קודקים	אופציונלי מחרוזת המחרוזת במירכאות מכילה רשימה מופרדת בפסיקים של פורמטים, שבה כל פורמט מציין סוג של דגימת מדיה שקיימת בסטרימינג.
רוחב	אופציונלי number מתאר את הרזולוציה האופקית של השידור בפיקסלים.
גובה	אופציונלי number מתאר את הרזולוציה האנכית של השידור בפיקסלים.
קצב פריימים	אופציונלי number מתאר את קצב הפריימים של השידור.

החזרות

boolean אם אפשר להפעיל את השידור ב-Chromecast.

getApplicationData

‫getApplicationData()‎ מחזירה cast.framework.system.ApplicationData

מספק מידע על האפליקציה כשהמערכת מוכנה, אחרת הוא יהיה null.

החזרות

nullable cast.framework.system.ApplicationData פרטי האפליקציה או null אם המערכת לא מוכנה.

getDeviceCapabilities

‫getDeviceCapabilities()‎ מחזירה cast.framework.system.DeviceCapabilitiesObj

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

החזרות

nullable cast.framework.system.DeviceCapabilitiesObj המידע על יכולות המכשיר (צמדי מפתח/ערך). הערך יהיה null אם המערכת עדיין לא מוכנה. הוא יכול להיות אובייקט ריק אם הפלטפורמה לא חושפת מידע על יכולות המכשיר.

getDeviceInformation

‫getDeviceInformation()‎ מחזירה cast.framework.system.DeviceInformationObj

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

החזרות

nullable cast.framework.system.DeviceInformationObj פרטי המכשיר (צמדי מפתח/ערך). הערך יהיה null אם המערכת עדיין לא מוכנה. יכול להיות שהאובייקט יהיה ריק אם הפלטפורמה לא חושפת את המידע הזה.

getPlayerManager

‫getPlayerManager()‎ מחזירה cast.framework.PlayerManager

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

החזרות

non-null cast.framework.PlayerManager 

getSender

‫getSender(senderId)‎ מחזירה cast.framework.system.Sender

קבלת שולח לפי מזהה שולח

פרמטר
senderId	מחרוזת המזהה של השולח שרוצים להחזיר.

החזרות

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

מקבלת רשימה של השולחים שמחוברים כרגע.

החזרות

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

‫getStandbyState()‎ מחזירה cast.framework.system.StandbyState

דיווח אם קלט ה-HDMI של אפליקציית Cast נמצא במצב המתנה.

החזרות

non-null cast.framework.system.StandbyState אם קלט ה-HDMI של האפליקציה נמצא במצב המתנה או לא. אם אי אפשר לקבוע את המצב, למשל כי הטלוויזיה לא תומכת בפקודות CEC, הערך שמוחזר הוא UNKNOWN.

getSystemState

‫getSystemState()‎ מחזירה cast.framework.system.SystemState

מספקת לאפליקציה מידע על מצב המערכת.

החזרות

non-null cast.framework.system.SystemState מצב המערכת.

getVisibilityState

‫getVisibilityState()‎ מחזירה cast.framework.system.VisibilityState

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

החזרות

non-null cast.framework.system.VisibilityState אם האפליקציה היא קלט ה-HDMI הפעיל. אם אי אפשר לקבוע את המצב, למשל כי הטלוויזיה לא תומכת בפקודות CEC, הערך שיוחזר הוא UNKNOWN.

isSystemReady

‫isSystemReady()‎ מחזירה ערך בוליאני

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

החזרות

‫boolean אם המערכת מוכנה לעבד הודעות או לא.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

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

פרמטר
useLegacyDashSupport	אופציונלי בוליאני מציינים שצריך להשתמש ב-MPL לתוכן DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

הסרת מאזין להודעות שנרשם בעבר באמצעות CastReceiverContext#addCustomMessageListener.

פרמטר
מרחב שמות	מחרוזת מרחב השמות. שימו לב שמרחב שמות תקין צריך לכלול את הקידומת "urn:x-cast:‎".
listener	function(non-null cast.framework.system.Message) פונקציית ההאזנה להודעות שרוצים לבטל את הרישום שלה.

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

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

removeEventListener

removeEventListener(type, handler)

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

פרמטר
סוג	cast.framework.system.EventType הערך לא יכול להיות null.
handler	function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

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

פרמטר
מרחב שמות	מחרוזת מרחב השמות. שימו לב שמרחב שמות תקין צריך לכלול את הקידומת "urn:x-cast:‎".
senderId	(מחרוזת או לא מוגדר) ה-senderId, או לא מוגדר לשידור לכל השולחים.
נתונים	כל סוג ההודעה. הערך לא יכול להיות null.

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

‫Error אם הייתה שגיאה בהכנת ההודעה.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

פרמטר
feedbackMessage	מחרוזת

הוצא משימוש

Use cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

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

פרמטר
statusText	מחרוזת טקסט הסטטוס.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

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

פרמטר
feedbackHandler	function()‎ הערך יכול להיות null.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

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

פרמטר
maxInactivity	number מרווח הזמן בשניות לפני סגירת חיבור שלא מגיב.

setLoggerLevel

setLoggerLevel(level)

מגדירה את רמת המלל ביומן.

פרמטר
שלב	cast.framework.LoggerLevel רמת הרישום ביומן. הערך לא יכול להיות null.

start

‫start(options)‎ מחזירה cast.framework.CastReceiverContext

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

פרמטר
אפשרויות	(non-null cast.framework.CastReceiverOptions or optional non-null Object)

החזרות

non-null cast.framework.CastReceiverContext 

עצור

stop(closeReason)‎

סגירת אפליקציית המקלט.

פרמטר

closeReason

אופציונלי cast.framework.common.CloseReason סיבת הסגירה האופציונלית שמציינת למה אפליקציית המקלט נעצרת. אם לא צוינה סיבה, המסגרת תסיק את הסיבה על סמך אירועים אחרונים בנגן המדיה, או תחזור ל-APP_REQUEST. צריך להעביר אחד מהערכים המספריים הבאים: ‫13 (APP_CUSTOM_STOP): לפעולות עסקיות או לפעולות בממשק המשתמש של המקלט בהתאמה אישית (למשל, המשתמש לוחץ על כפתור "יציאה" או "סגירה" באפליקציה, ניווט של המקלט בהתאמה אישית מחוץ ל-Cast). ‫15 ‏(APP_ERROR): שגיאות חמורות ברמת האפליקציה (למשל, כשלים באימות בהתאמה אישית, כשלים באחזור DRM או רישיון, קריסות של ממשק API לקצה העורפי) שמתרחשות מחוץ לאירועי השגיאה של הנגן המובנה של CAF. ‫14 ‏(APP_PLAYBACK_FINISHED): האפליקציה סיימה להפעיל את הפלייליסט או התור, או סיימה חוויית מדיה עצמאית. 6 ‏(APP_REQUEST): ברירת מחדל כללית או מדור קודם כשאפליקציה מבקשת סיום בלי סיבה ספציפית יותר. הערך לא יכול להיות null.