cast. framework. system
זהו מרחב השמות cast.framework.system.
שיעורים
ApplicationData
מטא-נתונים שמתארים את הנתונים של האפליקציה שהופעלה.
אירוע
אירוע שנשלח על ידי cast.framework.CastReceiverContext שמכיל מידע על המערכת.
FeedbackStartedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהמערכת מתחילה ליצור דוח משוב.
MaxVideoResolutionChangedEvent
אירוע שנשלח על ידי cast.framework.CastReceiverContext כשהמערכת צריכה לעדכן את ההגבלה על הרזולוציה המקסימלית של הסרטון.
Message
הודעה בהתאמה אישית שהתקבלה משולח. כדי להאזין לאירועים בהתאמה אישית, משתמשים ב-method 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 |
מחרוזת תמיכה ב-Audio Assistant. דוגמאות למכשירים שתומכים ב-Cast עם תמיכה ב-Audio Assistant כוללות את Google Home ואת Google Home Mini. |
|
BLUETOOTH_SUPPORTED |
מחרוזת תמיכה ב-Bluetooth. |
|
DISPLAY_SUPPORTED |
מחרוזת תמיכה בפלט תצוגה. דוגמאות למכשירים שתומכים ב-Cast עם תמיכה במסך כוללות את Chromecast וטלוויזיות עם Cast. דוגמאות למכשירים שתומכים ב-Cast אבל לא תומכים במסכים: Chromecast Audio ו-Google Home. |
|
HI_RES_AUDIO_SUPPORTED |
מחרוזת תמיכה באודיו ברזולוציה גבוהה (עד 24-bit / 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 וכו'), אם הוא ידוע. מחרוזת ריקה אם המידע לא ידוע, או "לא Cast" אם זה לא מכשיר Cast. |
|
OS_VERSION |
מחרוזת הגרסה של מערכת ההפעלה שמותקנת במכשיר (למשל: 14.0 וכו'), אם היא ידועה. מחרוזת ריקה אם לא ידוע. |
|
סביבה |
מחרוזת סוג הסביבה שבה המכשיר נמצא (למשל: בית, רכב, מטוס, מלון וכו'), אם ידוע. בדרך כלל "home" ברוב המכשירים. |
|
DEVICE_ID |
מחרוזת המזהה הייחודי של המכשיר המקבל, אם הוא ידוע. הערך יהיה זהה לערך של מזהה המקלט של Cast שחשוף על ידי ה-SDK של השולח. מחרוזת ריקה אם לא ידוע. |
|
METADATA_FROM_FIRMWARE |
מחרוזת אם פרטי המכשיר סופקו על ידי הקושחה. |
DisconnectReason
מחרוזת
מייצג את הסיבה לניתוק.
ערך |
|
|---|---|
|
REQUESTED_BY_SENDER |
מחרוזת אפליקציית השולח ביקשה באופן פעיל לסגור את החיבור (בדרך כלל מופעל על ידי המשתמש). |
|
שגיאה |
מחרוזת הייתה שגיאת פרוטוקול. |
|
UNKNOWN |
מחרוזת לא ידוע אם השולח ביקש להתנתק בצורה תקינה על ידי קריאה ל- |
|
APPLICATION_STOP |
מחרוזת אפליקציית המקלט הפסיקה את עצמה. |
|
ABRUPT_SHUTDOWN |
מחרוזת הפלטפורמה סגרה את האפליקציה בזמן שהשולחים עדיין היו מחוברים. |
|
NO_SENDERS |
מחרוזת האפליקציה נסגרה כשלא היו שולחים מחוברים. |
|
TRANSPORT_CLOSED |
מחרוזת שקע ה-SSL הבסיסי נסגר על ידי השולח בלי סגירה תקינה של החיבור הווירטואלי. |
|
TRANSPORT_ABORTED |
מחרוזת ה-socket הבסיסי של ה-SSL בוטל על ידי הצד השני. |
|
TRANSPORT_TOO_LONG_INACTIVE |
מחרוזת ה-SSL socket הבסיסי נסגר בגלל כשל ב-Heartbeat. |
|
CLOSED_BY_SELF |
מחרוזת החיבור נסגר בצורה מבוקרת על ידי מקלט Cast. |
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. |
|
ענן |
מחרוזת האפליקציה הופעלה על ידי בקשה של Assistant (לדוגמה, על ידי פקודה של Google Assistant). |
MessageType
מחרוזת
סוגי ההודעות בהתאמה אישית.
ערך |
|
|---|---|
|
מחרוזת |
מחרוזת ההודעות הן מחרוזות בפורמט חופשי. האפליקציה אחראית על קידוד ופענוח המידע שמועבר. |
|
JSON |
מחרוזת ההודעות מקודדות ב-JSON. התעבורה הבסיסית תשתמש במחרוזת בקידוד JSON. |
StandbyState
מחרוזת
הערך הזה מייצג את מצב ההמתנה הנוכחי שדווח על ידי הפלטפורמה. יכול להיות שהערך יהיה
UNKNOWN אם פלטפורמת Cast לא יכולה לקבוע את המצב.
ערך |
|
|---|---|
|
המתנה |
מחרוזת |
|
NOT_STANDBY |
מחרוזת |
|
UNKNOWN |
מחרוזת |
SystemState
מחרוזת
זה מייצג את המצב הנוכחי של המערכת.
ערך |
|
|---|---|
|
NOT_STARTED |
מחרוזת עדיין לא התקבלה בקשה להפעיל את האפליקציה. |
|
STARTING_IN_BACKGROUND |
מחרוזת האפליקציה מופעלת אבל לא גלויה למשתמש. |
|
האיסוף מתחיל |
מחרוזת האפליקציה מופעלת. |
|
מוכן |
מחרוזת האפליקציה פועלת בחזית ומוכנה לשלוח ולקבל הודעות. |
|
STOPPING_IN_BACKGROUND |
מחרוזת האפליקציה מפסיקה לפעול כשהיא ברקע. |
|
STOPPING |
מחרוזת האפליקציה מפסיקה לפעול. |
VisibilityState
מחרוזת
הערך הזה מייצג את מצב החשיפה הנוכחי שהפלטפורמה מדווחת עליו. הערך יכול להיות UNKNOWN אם פלטפורמת Cast לא יכולה לקבוע את מצב החשיפה.
ערך |
|
|---|---|
|
גלוי |
מחרוזת |
|
NOT_VISIBLE |
מחרוזת |
|
UNKNOWN |
מחרוזת |
מאפיינים
DeviceCapabilities
מחרוזת
מתאר את היכולות של ההגדרה הנוכחית, שמורכבת מהמכשיר שתומך ב-Cast, ובמקרים הרלוונטיים, ממכשיר התצוגה שאליו הוא מחובר.
ערך |
|
|---|---|
|
AUDIO_ASSISTANT |
מחרוזת תמיכה ב-Audio Assistant. דוגמאות למכשירים שתומכים ב-Cast עם תמיכה ב-Audio Assistant כוללות את Google Home ואת Google Home Mini. |
|
BLUETOOTH_SUPPORTED |
מחרוזת תמיכה ב-Bluetooth. |
|
DISPLAY_SUPPORTED |
מחרוזת תמיכה בפלט תצוגה. דוגמאות למכשירים שתומכים ב-Cast עם תמיכה במסך כוללות את Chromecast וטלוויזיות עם Cast. דוגמאות למכשירים שתומכים ב-Cast אבל לא תומכים במסכים: Chromecast Audio ו-Google Home. |
|
HI_RES_AUDIO_SUPPORTED |
מחרוזת תמיכה באודיו ברזולוציה גבוהה (עד 24-bit / 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 וכו'), אם הוא ידוע. מחרוזת ריקה אם המידע לא ידוע, או "לא Cast" אם זה לא מכשיר Cast. |
|
OS_VERSION |
מחרוזת הגרסה של מערכת ההפעלה שמותקנת במכשיר (למשל: 14.0 וכו'), אם היא ידועה. מחרוזת ריקה אם לא ידוע. |
|
סביבה |
מחרוזת סוג הסביבה שבה המכשיר נמצא (למשל: בית, רכב, מטוס, מלון וכו'), אם ידוע. בדרך כלל "home" ברוב המכשירים. |
|
DEVICE_ID |
מחרוזת המזהה הייחודי של המכשיר המקבל, אם הוא ידוע. הערך יהיה זהה לערך של מזהה המקלט של Cast שחשוף על ידי ה-SDK של השולח. מחרוזת ריקה אם לא ידוע. |
|
METADATA_FROM_FIRMWARE |
מחרוזת אם פרטי המכשיר סופקו על ידי הקושחה. |
DisconnectReason
מחרוזת
מייצג את הסיבה לניתוק.
ערך |
|
|---|---|
|
REQUESTED_BY_SENDER |
מחרוזת אפליקציית השולח ביקשה באופן פעיל לסגור את החיבור (בדרך כלל מופעל על ידי המשתמש). |
|
שגיאה |
מחרוזת הייתה שגיאת פרוטוקול. |
|
UNKNOWN |
מחרוזת לא ידוע אם השולח ביקש להתנתק בצורה תקינה על ידי קריאה ל- |
|
APPLICATION_STOP |
מחרוזת אפליקציית המקלט הפסיקה את עצמה. |
|
ABRUPT_SHUTDOWN |
מחרוזת הפלטפורמה סגרה את האפליקציה בזמן שהשולחים עדיין היו מחוברים. |
|
NO_SENDERS |
מחרוזת האפליקציה נסגרה כשלא היו שולחים מחוברים. |
|
TRANSPORT_CLOSED |
מחרוזת שקע ה-SSL הבסיסי נסגר על ידי השולח בלי סגירה תקינה של החיבור הווירטואלי. |
|
TRANSPORT_ABORTED |
מחרוזת ה-socket הבסיסי של ה-SSL בוטל על ידי הצד השני. |
|
TRANSPORT_TOO_LONG_INACTIVE |
מחרוזת ה-SSL socket הבסיסי נסגר בגלל כשל ב-Heartbeat. |
|
CLOSED_BY_SELF |
מחרוזת החיבור נסגר בצורה מבוקרת על ידי מקלט Cast. |
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. |
|
ענן |
מחרוזת האפליקציה הופעלה על ידי בקשה של Assistant (לדוגמה, על ידי פקודה של Google Assistant). |
MessageType
מחרוזת
סוגי ההודעות בהתאמה אישית.
ערך |
|
|---|---|
|
מחרוזת |
מחרוזת ההודעות הן מחרוזות בפורמט חופשי. האפליקציה אחראית על קידוד ופענוח המידע שמועבר. |
|
JSON |
מחרוזת ההודעות מקודדות ב-JSON. התעבורה הבסיסית תשתמש במחרוזת בקידוד JSON. |
StandbyState
מחרוזת
הערך הזה מייצג את מצב ההמתנה הנוכחי שדווח על ידי הפלטפורמה. יכול להיות שהערך יהיה
UNKNOWN אם פלטפורמת Cast לא יכולה לקבוע את המצב.
ערך |
|
|---|---|
|
המתנה |
מחרוזת |
|
NOT_STANDBY |
מחרוזת |
|
UNKNOWN |
מחרוזת |
SystemState
מחרוזת
זה מייצג את המצב הנוכחי של המערכת.
ערך |
|
|---|---|
|
NOT_STARTED |
מחרוזת עדיין לא התקבלה בקשה להפעיל את האפליקציה. |
|
STARTING_IN_BACKGROUND |
מחרוזת האפליקציה מופעלת אבל לא גלויה למשתמש. |
|
האיסוף מתחיל |
מחרוזת האפליקציה מופעלת. |
|
מוכן |
מחרוזת האפליקציה פועלת בחזית ומוכנה לשלוח ולקבל הודעות. |
|
STOPPING_IN_BACKGROUND |
מחרוזת האפליקציה מפסיקה לפעול כשהיא ברקע. |
|
STOPPING |
מחרוזת האפליקציה מפסיקה לפעול. |
VisibilityState
מחרוזת
הערך הזה מייצג את מצב החשיפה הנוכחי שהפלטפורמה מדווחת עליו. הערך יכול להיות UNKNOWN אם פלטפורמת Cast לא יכולה לקבוע את מצב החשיפה.
ערך |
|
|---|---|
|
גלוי |
מחרוזת |
|
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