מחלקה: CastReceiverContext

cast.מסגרת.CastReceiverContext

class   סטטי

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

קליעות

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

שיטות

getInstance

סטטי

getInstance() returns cast.framework.CastReceiverContext

מחזירה את מופע ה-Singleton של CastReceiverContext.

החזרות

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות. הערה: לפני מרחב שמות חוקי, צריך להוסיף את המחרוזת 'urn:x-cast:'.

listener

function(non-null cast.framework.system.Message)
קליעות

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

addEventListener

addEventListener(type, handler)

הוספת listener לאירועי מערכת של העברה (cast).

פרמטר

סוג

cast.framework.system.EventType

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

handler

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

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

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

פרמטר

mimeType

מחרוזת

סוג MIME של המדיה. השדה מורכב מסוג וסוג משנה שמופרדים באמצעות התו '/'. הוא יכול להיות מסוג וידאו או סוג MIME של האודיו.

קודק

אופציונלי

מחרוזת

ה-Quoted-string מכיל רשימת פורמטים מופרדת בפסיקים, שבה כל פורמט מציין סוג של דגימת מדיה שנמצא בזרם.

רוחב

אופציונלי

מספר

מתאר את הרזולוציה האופקית של הזרם בפיקסלים.

גובה

אופציונלי

מספר

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

קצב פריימים

אופציונלי

מספר

מתאר את קצב הפריימים של הסטרימינג.
החזרות

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

getApplicationData

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

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

החזרות

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

getDeviceCapabilities

אובייקט getDeviceCapabilities()

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

החזרות

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

getPlayerManager

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

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

החזרות

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) returns cast.framework.system.Sender

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

פרמטר

senderId

מחרוזת

מזהה השולח שיש להחזיר.
החזרות

nullable cast.framework.system.Sender 

getSenders

getSenders() מחזיר מערך של cast.framework.system.Sender שאינו ריק

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

החזרות

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

getStandbyState

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

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

החזרות

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

getSystemState

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

isSystemמוכן() מחזיר בוליאני

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

החזרות

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

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

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

פרמטר

useLegacyDashSupport

אופציונלי

boolean

צריך לציין שיש להשתמש ב-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).

פרמטר

סוג

cast.framework.system.EventType

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

handler

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

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות. הערה: לפני מרחב שמות חוקי, צריך להוסיף את המחרוזת 'urn:x-cast:'.

senderId

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

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

נתונים

כל סוג

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

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

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

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

פרמטר

feedbackMessage

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

setApplicationState

setApplicationState(statusText)

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

פרמטר

statusText

מחרוזת

טקסט הסטטוס.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

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

פרמטר

feedbackHandler

function()

הערך יכול להיות אפס.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

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

פרמטר

maxInactivity

מספר

מרווח בשניות לפני סגירת חיבור שאינו מגיב.

setLoggerLevel

setLoggerLevel(level)

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

פרמטר

רמה

cast.framework.LoggerLevel

רמת הרישום ביומן.

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

התחלה

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

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

פרמטר

אפשרויות

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

non-null cast.framework.CastReceiverContext 

עצירת ביניים

stop()

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