cast. framework. system
זה מרחב השמות cast.framework.system.
שיעורים
ApplicationData
מטא-נתונים שמתארים את הנתונים של האפליקציה שהופעלה.
אירוע
אירוע שנשלח על ידי cast.framework.CastReceiverContext ומכיל פרטי מערכת.
FeedbackStartedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהמערכת מתחילה ליצור דוח משוב.
MaxVideoResolutionChangedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהמערכת צריכה לעדכן את ההגבלה על הרזולוציה המקסימלית של הסרטון.
Message
הודעה מותאמת אישית שהתקבלה משולח. כדי להאזין לאירועים מותאמים אישית, משתמשים בשיטה cast.framework.CastReceiverContext#addCustomMessageListener.
ReadyEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהמערכת מוכנה.
השולח
הנתונים האלה מייצגים את הנתונים של מכשיר השולח המחובר.
SenderConnectedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשמשדר מתחבר.
SenderDisconnectedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשמשתמש שולח מתנתק.
ShutdownEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהאפליקציה מושבתת.
StandbyChangedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהטלוויזיה נכנסת למצב המתנה או יוצאת ממנו, ולכן האפליקציה צריכה תמיד לאמת את המאפיין isStandby. כדי לדעת אם הסטטוס בפועל לא ידוע, האפליקציה יכולה לקרוא לשיטה cast.framework.CastReceiverContext#getStandbyState.
SystemVolumeChangedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשנפח הקול של המערכת משתנה.
SystemVolumeData
הנתונים האלה מייצגים את נפח המערכת.
VisibilityChangedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשמצב החשיפה של האפליקציה משתנה – למשל, כשקלט ה-HDMI משתנה או כשהטלוויזיה כבויה.
ערכי ספירה
DeviceCapabilities
מחרוזת
מתאר את היכולות של ההגדרה הנוכחית, שמורכבת ממכשיר עם תמיכה ב-Cast וממכשיר התצוגה שאליו הוא מחובר, אם רלוונטי.
ערך |
|
|---|---|
|
AUDIO_ASSISTANT |
מחרוזת תמיכה בעוזר האודיו. דוגמאות למכשירים עם תמיכה ב-Assistant לאודיו שמופעלת באמצעות Cast כוללות את Google Home ו-Google Home Mini. |
|
BLUETOOTH_SUPPORTED |
מחרוזת תמיכה ב-Bluetooth. |
|
DISPLAY_SUPPORTED |
מחרוזת תמיכה בפלט של המסך. דוגמאות למכשירים עם תמיכה ב-Cast ובתצוגה כוללות Chromecast וטלוויזיות עם Cast. דוגמאות למכשירים עם תמיכה ב-Cast שאין להם תמיכה במסך: Chromecast Audio ו-Google Home. |
|
HI_RES_AUDIO_SUPPORTED |
מחרוזת תמיכה באודיו ברזולוציה גבוהה (עד 24 ביט / 96KHz). |
|
IS_DV_SUPPORTED |
מחרוזת תמיכה ב-Dolby Vision. |
|
IS_HDR_SUPPORTED |
מחרוזת תמיכה בסרטוני HDR. |
|
CAST_LITE_ONLY |
מחרוזת האם המכשיר הזה פועל בפלטפורמה עם אודיו בלבד. יכול להיות שממשקי API מסוימים לא נתמכים באופן מלא בפלטפורמות כאלה. |
|
DPAD_INPUT_SUPPORTED |
מחרוזת האם המכשיר תומך במנגנון קלט, כמו לחצני חצים לביטול הנעילה. |
|
TOUCH_INPUT_SUPPORTED |
מחרוזת תמיכה בקלט מגע. דוגמאות למכשירים עם Cast שתומכים בהזנת מגע כוללות את Google Nest Hub ו-Google Nest Hub Max. |
|
IS_GROUP |
מחרוזת אם המכשיר הוא מכשיר וירטואלי ומייצג קבוצת יעד ולא מכשיר פיזי. |
|
IS_DEVICE_REGISTERED |
מחרוזת כשהערך של הדגל הזה הוא |
|
IS_CBCS_SUPPORTED |
מחרוזת אם הערך מוגדר ל- |
|
IS_DOLBY_ATMOS_SUPPORTED |
מחרוזת אם הערך מוגדר ל- |
DeviceInformation
מחרוזת
קבועים למפתחות התקינים ב-cast.framework.CastReceiverContext.DeviceInformationObj.
ערך |
|
|---|---|
|
MODEL_NAME |
מחרוזת שם דגם המכשיר (לדוגמה: Google TV Streamer, Nest Hub, Nest Mini וכו'), אם ידוע. 'unknown' אם לא ידוע. |
|
BRAND_NAME |
מחרוזת שם מותג המכשיר (לדוגמה: Google, LG, Sony וכו') אם ידוע. מחרוזת ריקה אם לא ידוע. |
|
OS_NAME |
מחרוזת השם של מערכת ההפעלה של המכשיר (לדוגמה: Android, Fuchsia, Linux וכו'), אם ידוע. מחרוזת ריקה אם לא ידוע, או 'not Cast' אם זה לא מכשיר Cast. |
|
OS_VERSION |
מחרוזת הגרסה של מערכת ההפעלה שמותקנת במכשיר (למשל: 14.0 וכו'), אם ידועה. מחרוזת ריקה אם לא ידוע. |
|
סביבה |
מחרוזת סוג הסביבה שבה המכשיר נמצא (לדוגמה: בית, רכב, מטוס, מלון וכו'), אם ידוע. בדרך כלל 'בית' ברוב המכשירים. |
|
DEVICE_ID |
מחרוזת המזהה הייחודי של מכשיר הנמען, אם הוא ידוע. הערך יהיה זהה לערך של מזהה מקלט Cast שנחשף על ידי Sender SDK. מחרוזת ריקה אם לא ידוע. |
|
METADATA_FROM_FIRMWARE |
מחרוזת האם פרטי המכשיר סופקו על ידי הקושחה. |
DisconnectReason
מחרוזת
מייצג את הסיבה לניתוק.
ערך |
|
|---|---|
|
REQUESTED_BY_SENDER |
מחרוזת השליחה של בקשת סגירת החיבור בוצעה באופן פעיל על ידי אפליקציית השולח (בדרך כלל הפעולה הזו מופעלת על ידי המשתמש). |
|
שגיאה |
מחרוזת אירעה שגיאת פרוטוקול. |
|
UNKNOWN |
מחרוזת לא ידוע אם השולח ביקש להתנתק בצורה תקינה על ידי קריאה ל-
|
EventType
מחרוזת
אירועי מערכת שנשלחים על ידי cast.framework.CastReceiverContext.
ערך |
|
|---|---|
|
מוכן |
מחרוזת האירוע מופעל כשהמערכת מוכנה. |
|
SHUTDOWN |
מחרוזת מופעל כשהאפליקציה מסתיימת. |
|
SENDER_CONNECTED |
מחרוזת האירוע מופעל כשמתבצע חיבור של שולח חדש. |
|
SENDER_DISCONNECTED |
מחרוזת מופעל כששולח מתנתק. |
|
שגיאה |
מחרוזת מופעלת כשמתרחשת שגיאת מערכת. |
|
SYSTEM_VOLUME_CHANGED |
מחרוזת מופעל כשעוצמת הקול של המערכת משתנה. |
|
VISIBILITY_CHANGED |
מחרוזת האירוע מופעל כשמצב החשיפה של האפליקציה משתנה (לדוגמה, אחרי שינוי של קלט HDMI או כשהטלוויזיה מופעלת או מושבתת ומכשיר Cast מקבל מתח ממקור חיצוני). שימו לב: ל-API הזה יש אותה השפעה כמו לאירוע webkitvisibilitychange שמופעל על ידי הדפדפן. ה-API הזה מסופק כ-cast.framework.CastReceiverContext כדי שיהיה נוח להשתמש בו וכדי למנוע תלות באירוע עם קידומת webkit. |
|
STANDBY_CHANGED |
מחרוזת מופעל כשהמצב של הטלוויזיה השתנה למצב המתנה. האירוע הזה קשור לאירוע cast.framework.system.EventType.VISIBILITY_CHANGED, כי אם הטלוויזיה במצב המתנה, הנראות תהיה מצבי חשיפה הם יותר ספציפיים ממצבי המתנה (כי חשיפה כוללת גם בחירה של ערוץ טלוויזיה), אבל לא תמיד אפשר לזהות אותם באופן מהימן בכל הטלוויזיות. אפשר להשתמש במצב המתנה במקרים האלה כי רוב הטלוויזיות תומכות בו. |
|
MAX_VIDEO_RESOLUTION_CHANGED |
מחרוזת |
|
FEEDBACK_STARTED |
מחרוזת האירוע מופעל כשהמערכת מתחילה ליצור דוח משוב. |
LaunchedFrom
מחרוזת
הערך הזה מייצג את סוג הבקשה שהפעילה את המקבל.
ערך |
|
|---|---|
|
UNKNOWN |
מחרוזת לא ניתן לקבוע את הבעלים של ההשקה. |
|
DIAL |
מחרוזת האפליקציה הופעלה על ידי בקשת DIAL. |
|
העברה |
מחרוזת האפליקציה הופעלה על ידי בקשת Cast V2. |
|
CLOUD |
מחרוזת האפליקציה הופעלה באמצעות בקשה ל-Assistant (לדוגמה, באמצעות פקודה ל-Google Assistant). |
MessageType
מחרוזת
סוגים של הודעות בהתאמה אישית.
ערך |
|
|---|---|
|
מחרוזת |
מחרוזת ההודעות הן מחרוזות חופשיות. האפליקציה אחראית לקידוד ולפענוח של המידע שמועבר. |
|
JSON |
מחרוזת ההודעות מקודדות ב-JSON. ההעברה הבסיסית תשתמש במחרוזת מקודדת ב-JSON. |
StandbyState
מחרוזת
הערך הזה מייצג את מצב ההמתנה הנוכחי שדווח על ידי הפלטפורמה. יכול להיות שיוצג הערך
UNKNOWN אם פלטפורמת Cast לא מצליחה לקבוע את המצב.
ערך |
|
|---|---|
|
STANDBY |
מחרוזת |
|
NOT_STANDBY |
מחרוזת |
|
UNKNOWN |
מחרוזת |
SystemState
מחרוזת
הערך הזה מייצג את מצב המערכת הנוכחי.
ערך |
|
|---|---|
|
NOT_STARTED |
מחרוזת האפליקציה עדיין לא התבקשה להתחיל. |
|
STARTING_IN_BACKGROUND |
מחרוזת האפליקציה מתחילה לפעול אבל לא מוצגת למשתמש. |
|
STARTING |
מחרוזת האפליקציה מתחילה לפעול. |
|
מוכן |
מחרוזת האפליקציה פועלת בחזית ומוכנה לשליחה ולקבלה של הודעות. |
|
STOPPING_IN_BACKGROUND |
מחרוזת האפליקציה מפסיקה לפעול ברקע. |
|
הפסקה |
מחרוזת האפליקציה מפסיקה לפעול. |
VisibilityState
מחרוזת
הערך הזה מייצג את מצב החשיפה הנוכחי שמדווח על ידי הפלטפורמה. יכול להיות שהערך יהיה UNKNOWN אם פלטפורמת Cast לא מצליחה לקבוע את מצב החשיפה.
ערך |
|
|---|---|
|
VISIBLE |
מחרוזת |
|
NOT_VISIBLE |
מחרוזת |
|
UNKNOWN |
מחרוזת |
מאפיינים
DeviceCapabilities
מחרוזת
מתאר את היכולות של ההגדרה הנוכחית, שמורכבת ממכשיר עם תמיכה ב-Cast וממכשיר התצוגה שאליו הוא מחובר, אם רלוונטי.
ערך |
|
|---|---|
|
AUDIO_ASSISTANT |
מחרוזת תמיכה בעוזר האודיו. דוגמאות למכשירים עם תמיכה ב-Assistant לאודיו שמופעלת באמצעות Cast כוללות את Google Home ו-Google Home Mini. |
|
BLUETOOTH_SUPPORTED |
מחרוזת תמיכה ב-Bluetooth. |
|
DISPLAY_SUPPORTED |
מחרוזת תמיכה בפלט של המסך. דוגמאות למכשירים עם תמיכה ב-Cast ובתצוגה כוללות Chromecast וטלוויזיות עם Cast. דוגמאות למכשירים עם תמיכה ב-Cast שאין להם תמיכה במסך: Chromecast Audio ו-Google Home. |
|
HI_RES_AUDIO_SUPPORTED |
מחרוזת תמיכה באודיו ברזולוציה גבוהה (עד 24 ביט / 96KHz). |
|
IS_DV_SUPPORTED |
מחרוזת תמיכה ב-Dolby Vision. |
|
IS_HDR_SUPPORTED |
מחרוזת תמיכה בסרטוני HDR. |
|
CAST_LITE_ONLY |
מחרוזת האם המכשיר הזה פועל בפלטפורמה עם אודיו בלבד. יכול להיות שממשקי API מסוימים לא נתמכים באופן מלא בפלטפורמות כאלה. |
|
DPAD_INPUT_SUPPORTED |
מחרוזת האם המכשיר תומך במנגנון קלט, כמו לחצני חצים לביטול הנעילה. |
|
TOUCH_INPUT_SUPPORTED |
מחרוזת תמיכה בקלט מגע. דוגמאות למכשירים עם Cast שתומכים בהזנת מגע כוללות את Google Nest Hub ו-Google Nest Hub Max. |
|
IS_GROUP |
מחרוזת אם המכשיר הוא מכשיר וירטואלי ומייצג קבוצת יעד ולא מכשיר פיזי. |
|
IS_DEVICE_REGISTERED |
מחרוזת כשהערך של הדגל הזה הוא |
|
IS_CBCS_SUPPORTED |
מחרוזת אם הערך מוגדר ל- |
|
IS_DOLBY_ATMOS_SUPPORTED |
מחרוזת אם הערך מוגדר ל- |
DeviceInformation
מחרוזת
קבועים למפתחות התקינים ב-cast.framework.CastReceiverContext.DeviceInformationObj.
ערך |
|
|---|---|
|
MODEL_NAME |
מחרוזת שם דגם המכשיר (לדוגמה: Google TV Streamer, Nest Hub, Nest Mini וכו'), אם ידוע. 'unknown' אם לא ידוע. |
|
BRAND_NAME |
מחרוזת שם מותג המכשיר (לדוגמה: Google, LG, Sony וכו') אם ידוע. מחרוזת ריקה אם לא ידוע. |
|
OS_NAME |
מחרוזת השם של מערכת ההפעלה של המכשיר (לדוגמה: Android, Fuchsia, Linux וכו'), אם ידוע. מחרוזת ריקה אם לא ידוע, או 'not Cast' אם זה לא מכשיר Cast. |
|
OS_VERSION |
מחרוזת הגרסה של מערכת ההפעלה שמותקנת במכשיר (למשל: 14.0 וכו'), אם ידועה. מחרוזת ריקה אם לא ידוע. |
|
סביבה |
מחרוזת סוג הסביבה שבה המכשיר נמצא (לדוגמה: בית, רכב, מטוס, מלון וכו'), אם ידוע. בדרך כלל 'בית' ברוב המכשירים. |
|
DEVICE_ID |
מחרוזת המזהה הייחודי של מכשיר הנמען, אם הוא ידוע. הערך יהיה זהה לערך של מזהה מקלט Cast שנחשף על ידי Sender SDK. מחרוזת ריקה אם לא ידוע. |
|
METADATA_FROM_FIRMWARE |
מחרוזת האם פרטי המכשיר סופקו על ידי הקושחה. |
DisconnectReason
מחרוזת
מייצג את הסיבה לניתוק.
ערך |
|
|---|---|
|
REQUESTED_BY_SENDER |
מחרוזת השליחה של בקשת סגירת החיבור בוצעה באופן פעיל על ידי אפליקציית השולח (בדרך כלל הפעולה הזו מופעלת על ידי המשתמש). |
|
שגיאה |
מחרוזת אירעה שגיאת פרוטוקול. |
|
UNKNOWN |
מחרוזת לא ידוע אם השולח ביקש להתנתק בצורה תקינה על ידי קריאה ל-
|
EventType
מחרוזת
אירועי מערכת שנשלחים על ידי cast.framework.CastReceiverContext.
ערך |
|
|---|---|
|
מוכן |
מחרוזת האירוע מופעל כשהמערכת מוכנה. |
|
SHUTDOWN |
מחרוזת מופעל כשהאפליקציה מסתיימת. |
|
SENDER_CONNECTED |
מחרוזת האירוע מופעל כשמתבצע חיבור של שולח חדש. |
|
SENDER_DISCONNECTED |
מחרוזת מופעל כששולח מתנתק. |
|
שגיאה |
מחרוזת מופעלת כשמתרחשת שגיאת מערכת. |
|
SYSTEM_VOLUME_CHANGED |
מחרוזת מופעל כשעוצמת הקול של המערכת משתנה. |
|
VISIBILITY_CHANGED |
מחרוזת האירוע מופעל כשמצב החשיפה של האפליקציה משתנה (לדוגמה, אחרי שינוי של קלט HDMI או כשהטלוויזיה מופעלת או מושבתת ומכשיר Cast מקבל מתח ממקור חיצוני). שימו לב: ל-API הזה יש אותה השפעה כמו לאירוע webkitvisibilitychange שמופעל על ידי הדפדפן. ה-API הזה מסופק כ-cast.framework.CastReceiverContext כדי שיהיה נוח להשתמש בו וכדי למנוע תלות באירוע עם קידומת webkit. |
|
STANDBY_CHANGED |
מחרוזת מופעל כשהמצב של הטלוויזיה השתנה למצב המתנה. האירוע הזה קשור לאירוע cast.framework.system.EventType.VISIBILITY_CHANGED, כי אם הטלוויזיה במצב המתנה, הנראות תהיה מצבי חשיפה הם יותר ספציפיים ממצבי המתנה (כי חשיפה כוללת גם בחירה של ערוץ טלוויזיה), אבל לא תמיד אפשר לזהות אותם באופן מהימן בכל הטלוויזיות. אפשר להשתמש במצב המתנה במקרים האלה כי רוב הטלוויזיות תומכות בו. |
|
MAX_VIDEO_RESOLUTION_CHANGED |
מחרוזת |
|
FEEDBACK_STARTED |
מחרוזת האירוע מופעל כשהמערכת מתחילה ליצור דוח משוב. |
LaunchedFrom
מחרוזת
הערך הזה מייצג את סוג הבקשה שהפעילה את המקבל.
ערך |
|
|---|---|
|
UNKNOWN |
מחרוזת לא ניתן לקבוע את הבעלים של ההשקה. |
|
DIAL |
מחרוזת האפליקציה הופעלה על ידי בקשת DIAL. |
|
העברה |
מחרוזת האפליקציה הופעלה על ידי בקשת Cast V2. |
|
CLOUD |
מחרוזת האפליקציה הופעלה באמצעות בקשה ל-Assistant (לדוגמה, באמצעות פקודה ל-Google Assistant). |
MessageType
מחרוזת
סוגים של הודעות בהתאמה אישית.
ערך |
|
|---|---|
|
מחרוזת |
מחרוזת ההודעות הן מחרוזות חופשיות. האפליקציה אחראית לקידוד ולפענוח של המידע שמועבר. |
|
JSON |
מחרוזת ההודעות מקודדות ב-JSON. ההעברה הבסיסית תשתמש במחרוזת מקודדת ב-JSON. |
StandbyState
מחרוזת
הערך הזה מייצג את מצב ההמתנה הנוכחי שדווח על ידי הפלטפורמה. יכול להיות שיוצג הערך
UNKNOWN אם פלטפורמת Cast לא מצליחה לקבוע את המצב.
ערך |
|
|---|---|
|
STANDBY |
מחרוזת |
|
NOT_STANDBY |
מחרוזת |
|
UNKNOWN |
מחרוזת |
SystemState
מחרוזת
הערך הזה מייצג את מצב המערכת הנוכחי.
ערך |
|
|---|---|
|
NOT_STARTED |
מחרוזת האפליקציה עדיין לא התבקשה להתחיל. |
|
STARTING_IN_BACKGROUND |
מחרוזת האפליקציה מתחילה לפעול אבל לא מוצגת למשתמש. |
|
STARTING |
מחרוזת האפליקציה מתחילה לפעול. |
|
מוכן |
מחרוזת האפליקציה פועלת בחזית ומוכנה לשליחה ולקבלה של הודעות. |
|
STOPPING_IN_BACKGROUND |
מחרוזת האפליקציה מפסיקה לפעול ברקע. |
|
הפסקה |
מחרוזת האפליקציה מפסיקה לפעול. |
VisibilityState
מחרוזת
הערך הזה מייצג את מצב החשיפה הנוכחי שמדווח על ידי הפלטפורמה. יכול להיות שהערך יהיה UNKNOWN אם פלטפורמת Cast לא מצליחה לקבוע את מצב החשיפה.
ערך |
|
|---|---|
|
VISIBLE |
מחרוזת |
|
NOT_VISIBLE |
מחרוזת |
|
UNKNOWN |
מחרוזת |
סוגים מופשטים
DeviceCapabilitiesObj
{audio_assistant: (boolean or undefined), bluetooth_supported: (boolean or undefined), display_supported: (boolean or undefined), hi_res_audio_supported: (boolean or undefined), is_dv_supported: (boolean or undefined), is_hdr_supported: (boolean or undefined), cast_lite_only: (boolean or undefined), dpad_input_supported: (boolean or undefined), touch_input_supported: (boolean or undefined), is_group: (boolean or undefined), remote_control_overlay_supported: (boolean or undefined), sleep_timer_overlay_supported: (boolean or undefined), app_foreground: (boolean or undefined), is_device_registered: (boolean or undefined), is_cbcs_supported: (boolean or undefined), is_dolby_atmos_supported: (boolean or undefined)}
מתאר את האובייקט שמוחזר על ידי getDeviceCapabilities
DeviceInformationObj
{model-name: string, brand-name: string, os-name: string, os-version: string, environment: string, device-id: string, metadata-from-firmware: boolean}
מתאר את האובייקט שמוחזר על ידי getDeviceInformation