מחלקה: CastReceiverContext

cast.framework.CastReceiverContext

class   static

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

זריקות

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

Methods

getInstance

static

הפונקציה getInstance()‎ מחזירה cast.framework.CastReceiverContext

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

החזרות

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות. שימו לב: מרחב שמות תקין צריך להתחיל במחרוזת 'urn:x-cast:‎'.

listener

function(non-null cast.framework.system.Message)
זריקות

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

addEventListener

addEventListener(type, handler)

הוספת 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

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

החזרות

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

הדוחות מראים אם אפליקציית ה-Cast היא הקלט הפעיל של 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)

הפונקציה של ה-listener של ההודעה לביטול הרישום.
זריקות

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

removeEventListener

removeEventListener(type, handler)

הסרת listener להעברת אירועי מערכת.

פרמטר

סוג

cast.framework.system.EventType

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

handler

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות. שימו לב: מרחב שמות תקין צריך להתחיל במחרוזת 'urn:x-cast:‎'.

senderId

(מחרוזת או לא מוגדר)

מזהה השולח, או undefined לשידור לכל השולחים.

נתונים

כל סוג

המטען הייעודי (payload) של ההודעה.

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

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

פרמטר

feedbackMessage

מחרוזת
הוצא משימוש
Use cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

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

פרמטר

statusText

מחרוזת

הטקסט של הסטטוס.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

מגדירים 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

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

פרמטר

options

(non-null cast.framework.CastReceiverOptions או אובייקט אופציונלי non-null)
החזרות

non-null cast.framework.CastReceiverContext 

עצור

stop()

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