מרחב שמות: cast

chrome.העברה

namespace   סטטי

זהו מרחב השמות chrome.cast.

מחלקות

מרחב שמות

ספירות

AutoJoinPolicy

סטטי

מחרוזת

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

Value

TAB_AND_ORIGIN_SCOPED

מחרוזת

מתבצע חיבור אוטומטי כשהסשן התחיל עם אותו appId, באותה כרטיסייה ובאותו מקור דף.

ORIGIN_SCOPED

מחרוזת

מתבצע קישור אוטומטי כשהסשן התחיל עם אותו appId ואותו מקור דף (ללא קשר לכרטיסייה).

PAGE_SCOPED

מחרוזת

אין חיבור אוטומטי.

פונקציה

סטטי

מחרוזת

יכולות שנתמכות על ידי המכשיר המקבל.

Value

VIDEO_OUT

מחרוזת

המקלט תומך בפלט וידאו.

AUDIO_OUT

מחרוזת

המקלט תומך בפלט אודיו.

VIDEO_IN

מחרוזת

המקלט תומך בקלט וידאו (מצלמה).

AUDIO_IN

מחרוזת

המקלט תומך בקלט אודיו (מיקרופון).

MULTIZONE_GROUP

מחרוזת

המקבל מייצג קבוצה רב-אזורית.

DefaultActionPolicy

סטטי

מחרוזת

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

Value

CREATE_SESSION

מחרוזת

אם הכרטיסייה שמכילה את האפליקציה מועברת (cast) כשה-API מופעל, ה-SDK מפסיק את העברת הכרטיסייה ומפעיל את האפליקציה באופן אוטומטי. החלון הקופץ של התוסף ינחה את המשתמש להעביר את האפליקציה.

CAST_THIS_TAB

מחרוזת

לא מתבצעת הפעלה אוטומטית אחרי אתחול ה-API, גם אם מתבצעת העברה (cast) של הכרטיסייה. החלון הקופץ של התוסף מבקש מהמשתמש להעביר את הכרטיסייה.

DialAppState

סטטי

מחרוזת

מצבים אפשריים של אפליקציית DIAL.

Value

פעילה

מחרוזת

הופסקה

מחרוזת

שגיאה

מחרוזת

לא חלק מהמפרט, משמש לאות שגיאות.

ErrorCode

סטטי

מחרוזת

שגיאות שעשויות להיות מוחזרות על ידי ה-SDK.

Value

ביטול

מחרוזת

המשתמש ביטל את הפעולה.

פגיעות

מחרוזת

תם הזמן שהוקצב לפעולה.

API_NOT_INITIALIZED

מחרוזת

ה-API לא אותחל.

INVALID_PARAMETER

מחרוזת

הפרמטרים לפעולה לא היו חוקיים.

EXTENSION_NOT_COMPATIBLE

מחרוזת

סקריפט ה-API לא תואם לתוסף Cast המותקן.

EXTENSION_MISSING

מחרוזת

תוסף Cast לא זמין.

RECEIVER_UNAVAILABLE

מחרוזת

אף נמען לא היה תואם לבקשת הסשן.

SESSION_ERROR

מחרוזת

לא ניתן היה ליצור סשן, או שהסשן לא היה חוקי.

CHANNEL_ERROR

מחרוזת

אין ערוץ זמין למקבל.

LOAD_MEDIA_FAILED

מחרוזת

טעינת המדיה נכשלה.

ReceiverAction

סטטי

מחרוזת

פעולות שהמשתמש יכול לבצע לגבי מקלט בתוסף. אפשר להשתמש בהם כדי להציג מעבר בממשק המשתמש של אפליקציית השולח לפני שפעולת ההעברה (cast) הושלמה במלואה (או נכשלה).

Value

CAST

מחרוזת

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

עצירה

מחרוזת

המשתמש ביקש להפסיק את הסשן במכשיר המקבל.

ReceiverAvailability

סטטי

מחרוזת

מיועד לתיאור הזמינות של מקלט Cast.

Value

זמין

מחרוזת

יש מקלט אחד לפחות שתואם לבקשת הסשן.

לא זמין

מחרוזת

אין מקלטים זמינים.

ReceiverType

סטטי

מחרוזת

Value

CAST

מחרוזת

מקלט Cast, למשל Chromecast

חיוג

מחרוזת

מכשיר DIAL, למשל טלוויזיה חכמה

Hangout

מחרוזת

בילוי

בהתאמה אישית

מחרוזת

מקבל בהתאמה אישית שסופק על ידי הלקוח

SenderPlatform

סטטי

מחרוזת

מתאר פלטפורמה של אפליקציית שולח.

Value

Chrome

מחרוזת

iOS

מחרוזת

ANDROID

מחרוזת

SessionStatus

סטטי

מחרוזת

מתאר את הסטטוס של סשן העברה לאפליקציית המקבל.

Value

מחובר

מחרוזת

הסשן מקושר לאפליקציה של המקבל.

מנותק

מחרוזת

הסשן נותק מהאפליקציה המקבלת. יכול להיות שהאפליקציה של המקבל עדיין פועלת, ויכול להיות שהיא לא פועלת.

הופסקה

מחרוזת

האפליקציה המקבלת הופסקה.

VolumeControlType

סטטי

מחרוזת

מתאר סוגים של בקרת עוצמת קול.

Value

לתשומת ליבך

מחרוזת

ניתן לשנות את עוצמת הקול של מכשיר ה-CAST.

תוקנה

מחרוזת

עוצמת הקול של מכשיר ה-CAST קבועה ולא ניתן לשנות אותה.

מאסטר

מחרוזת

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

תכונות

AutoJoinPolicy

סטטי

מחרוזת

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

Value

TAB_AND_ORIGIN_SCOPED

מחרוזת

מתבצע חיבור אוטומטי כשהסשן התחיל עם אותו appId, באותה כרטיסייה ובאותו מקור דף.

ORIGIN_SCOPED

מחרוזת

מתבצע קישור אוטומטי כשהסשן התחיל עם אותו appId ואותו מקור דף (ללא קשר לכרטיסייה).

PAGE_SCOPED

מחרוזת

אין חיבור אוטומטי.

פונקציה

סטטי

מחרוזת

יכולות שנתמכות על ידי המכשיר המקבל.

Value

VIDEO_OUT

מחרוזת

המקלט תומך בפלט וידאו.

AUDIO_OUT

מחרוזת

המקלט תומך בפלט אודיו.

VIDEO_IN

מחרוזת

המקלט תומך בקלט וידאו (מצלמה).

AUDIO_IN

מחרוזת

המקלט תומך בקלט אודיו (מיקרופון).

MULTIZONE_GROUP

מחרוזת

המקבל מייצג קבוצה רב-אזורית.

DefaultActionPolicy

סטטי

מחרוזת

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

Value

CREATE_SESSION

מחרוזת

אם הכרטיסייה שמכילה את האפליקציה מועברת (cast) כשה-API מופעל, ה-SDK מפסיק את העברת הכרטיסייה ומפעיל את האפליקציה באופן אוטומטי. החלון הקופץ של התוסף ינחה את המשתמש להעביר את האפליקציה.

CAST_THIS_TAB

מחרוזת

לא מתבצעת הפעלה אוטומטית אחרי אתחול ה-API, גם אם מתבצעת העברה (cast) של הכרטיסייה. החלון הקופץ של התוסף מבקש מהמשתמש להעביר את הכרטיסייה.

DialAppState

סטטי

מחרוזת

מצבים אפשריים של אפליקציית DIAL.

Value

פעילה

מחרוזת

הופסקה

מחרוזת

שגיאה

מחרוזת

לא חלק מהמפרט, משמש לאות שגיאות.

ErrorCode

סטטי

מחרוזת

שגיאות שעשויות להיות מוחזרות על ידי ה-SDK.

Value

ביטול

מחרוזת

המשתמש ביטל את הפעולה.

פגיעות

מחרוזת

תם הזמן שהוקצב לפעולה.

API_NOT_INITIALIZED

מחרוזת

ה-API לא אותחל.

INVALID_PARAMETER

מחרוזת

הפרמטרים לפעולה לא היו חוקיים.

EXTENSION_NOT_COMPATIBLE

מחרוזת

סקריפט ה-API לא תואם לתוסף Cast המותקן.

EXTENSION_MISSING

מחרוזת

תוסף Cast לא זמין.

RECEIVER_UNAVAILABLE

מחרוזת

אף נמען לא היה תואם לבקשת הסשן.

SESSION_ERROR

מחרוזת

לא ניתן היה ליצור סשן, או שהסשן לא היה חוקי.

CHANNEL_ERROR

מחרוזת

אין ערוץ זמין למקבל.

LOAD_MEDIA_FAILED

מחרוזת

טעינת המדיה נכשלה.

isAvailable

סטטי

boolean

מסמנים ללקוחות כדי שיבדקו אם ה-API נטען.

ReceiverAction

סטטי

מחרוזת

פעולות שהמשתמש יכול לבצע לגבי מקלט בתוסף. אפשר להשתמש בהם כדי להציג מעבר בממשק המשתמש של אפליקציית השולח לפני שפעולת ההעברה (cast) הושלמה במלואה (או נכשלה).

Value

CAST

מחרוזת

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

עצירה

מחרוזת

המשתמש ביקש להפסיק את הסשן במכשיר המקבל.

ReceiverAvailability

סטטי

מחרוזת

מיועד לתיאור הזמינות של מקלט Cast.

Value

זמין

מחרוזת

יש מקלט אחד לפחות שתואם לבקשת הסשן.

לא זמין

מחרוזת

אין מקלטים זמינים.

ReceiverType

סטטי

מחרוזת

Value

CAST

מחרוזת

מקלט Cast, למשל Chromecast

חיוג

מחרוזת

מכשיר DIAL, למשל טלוויזיה חכמה

Hangout

מחרוזת

בילוי

בהתאמה אישית

מחרוזת

מקבל בהתאמה אישית שסופק על ידי הלקוח

SenderPlatform

סטטי

מחרוזת

מתאר פלטפורמה של אפליקציית שולח.

Value

Chrome

מחרוזת

iOS

מחרוזת

ANDROID

מחרוזת

SessionStatus

סטטי

מחרוזת

מתאר את הסטטוס של סשן העברה לאפליקציית המקבל.

Value

מחובר

מחרוזת

הסשן מקושר לאפליקציה של המקבל.

מנותק

מחרוזת

הסשן נותק מהאפליקציה המקבלת. יכול להיות שהאפליקציה של המקבל עדיין פועלת, ויכול להיות שהיא לא פועלת.

הופסקה

מחרוזת

האפליקציה המקבלת הופסקה.

פסק זמן

סטטי

chrome.cast.Timeout לא ריק

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

גרסה

קבוע   סטטי

מערך מספרים שאינו אפס

גרסת ה-API. המספר הראשון הוא הגרסה העיקרית, והמספר השני הוא הגרסה המשנית.

VolumeControlType

סטטי

מחרוזת

מתאר סוגים של בקרת עוצמת קול.

Value

לתשומת ליבך

מחרוזת

ניתן לשנות את עוצמת הקול של מכשיר ה-CAST.

תוקנה

מחרוזת

עוצמת הקול של מכשיר ה-CAST קבועה ולא ניתן לשנות אותה.

מאסטר

מחרוזת

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

שיטות

addReceiverActionListener

סטטי

addReceiverActionListener(listener)

הוספה של פונקציית listener שתופעל כשהמשתמש יבצע פעולה בממשק המשתמש כדי להתחיל או להפסיק את ההעברה. אפליקציית השולח יכולה להשתמש באפשרות הזו כדי להציג מעבר בממשק המשתמש שלה (כלומר, להשהות את ההפעלה המקומית של מדיה) לפני שפעולת ההעברה (cast) הושלמה או נכשלה.

  • לא בטוח שה-listener יופעל והאפליקציות לא צריכות להסתמך עליו כדי לפעול כראוי.
  • אם הפעולה זמינה, המאזין יועבר למקבל התשלום. עם זאת, יכול להיות שהנמען לא ידוע, ובמקום זאת תתבצע העברה של null.
  • הקריאה למאזינים תתבצע בהקדם האפשרי לאחר שהמשתמש יבצע פעולה. צריך להפעיל אותו לפני קבלת ההודעה על השינוי במצב שנוצר דרך ה-API.

אם משתמשים ב-framework API, צריך להשתמש ב-cast.framework.CastContext#addEventListener במקום זאת ולהאזין לאירועי cast.framework.CastContextEventType#CAST_STATE_ דרושה.

פרמטר

listener

chrome.cast.ReceiverActionListener

פונקציית ה-listener להוספה. הארגומנט הראשון למאזין הוא המקבל שהפעולה עליו בוצעה. הארגומנט השני של ה-Listener הוא הפעולה המבוקשת (ניתן לעיין בכתובת chrome.cast.ReceiverAction).

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

initialize

סטטי

startize(apiConfig, successfullyCallback, errorCallback)

מפעיל את ה-API. חשוב לזכור שהפעולות הבאות: eventCallback ו-ErrorCallback יופעלו אחרי שה-API יסתיים. לאחר מכן, ניתן להפעיל את sessionListener ו-GetrListener בכל עת.

אם משתמשים ב-framework API, משתמשים ב-cast.framework.CastContext#setOptions במקום בפונקציה הזו.

פרמטר

apiConfig

chrome.cast.ApiConfig

האובייקט עם הפרמטרים לאתחול ה-API.

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

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

השגיאות האפשריות הן OFFSET, INVALID_PARAMETER, extensions_MISSING.

logMessage

סטטי

logMessage(message)

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

פרמטר

הודעה

מחרוזת

ההודעה שצריך לתעד.
הוצא משימוש
אין תמיכה ב-Cast SDK שמבוסס על presentation API.

מטמון מראש

סטטי

precache(data)

שליחת בקשה לנתונים שנשמרו במטמון מראש. אם תחובר סשן, תישלח בקשה ישירה. אחרת, תישלח לכל המכשירים שברשת.

פרמטר

נתונים

מחרוזת

נתונים לשמירה מראש.
הוצא משימוש
אין תמיכה.

removeReceiverActionListener

סטטי

removeReceiverActionListener(listener)

מסירה פונקציית listener שנוספה קודם לכן באמצעות addReceiverActionListener.

פרמטר

listener

chrome.cast.ReceiverActionListener

פונקציית ההאזנה להסרה.

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

requestSession

סטטי

requestSession(successCallback, errorCallback, sessionRequest)

בקשות ליצירת סשן של בקשת הצטרפות או הצטרפות אליו. כברירת מחדל, נעשה שימוש ב-SessionRequest שהועבר ל-API בזמן האתחול. אפשר לעקוף את ה-sessionRequest באמצעות העברה של בקשת ביקור אחרת ב-sessionRequest.

אם משתמשים ב- Framework API, צריך להשתמש ב-cast.framework.CastContext#requestSession במקום בפונקציה הזו.

פרמטר

successCallback

function(non-null chrome.cast.Session)

errorCallback

function(non-null chrome.cast.Error)

השגיאות האפשריות הן FUNCTION, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE ו-extensions_MISSING. חשוב לשים לב שטיימר הזמן הקצוב לתפוגה מתחיל אחרי שהמשתמשים בוחרים מקבל. כדי לבחור מקלט נדרשת פעולה מצד המשתמש, שלא מוגדר לה זמן קצוב לתפוגה. אם בקשת סשן כבר מתבצעת, מופעלת השגיאה errorCallback עם קוד שגיאה INVALID_PARAMETER ותיאור שמסביר את השגיאה.

sessionRequest

אופציונלי

chrome.cast.SessionRequest

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

requestSessionById

סטטי

requestSessionById(sessionId)

שליחת בקשה להצטרף לסשן קיים עם המזהה שציינת. לאחר ההצטרפות, הסשן יועבר אל sessionListener שהוגדר על ידי chrome.cast.initialize.

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

פרמטר

sessionId

מחרוזת

מזהה הסשן שאליו צריך להצטרף.

setCustomReceivers

סטטי

setCustomReceivers(receivers, successCallback, errorCallback)

הגדרת רשימת מקלטים מותאמת אישית

פרמטר

מקלטים

מערך של chrome.cast.Receiver שאינו null

הרשימה החדשה.

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

successCallback

function()

errorCallback

function(non-null chrome.cast.Error)

השגיאות האפשריות הן FUNCTION , API_NOT_INITIALIZED , INVALID_PARAMETER , CHANNEL_ERROR ו-extensions_MISSRING.
הוצא משימוש
אין תמיכה ב-Cast SDK שמבוסס על presentation API.

setPageContext

סטטי

setPageContext(win)

מפעילה את פונקציונליות Cast בדף שטוען SDK של Cast ב-iframe. הקריאה הזו אמורה להתבצע אחרי שה-SDK אותחל.

פרמטר

ניצחון

חלון

אובייקט של חלון הדף.

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

setReceiverDisplayStatus

סטטי

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

מגדיר את שם המקבל ואת סטטוס התצוגה. כדי שהמקלט לא פעיל, צריך להגדיר את displayStatus ל-null.

תקף רק למקבלים CUSTOM. המערכת מתעלמת מ-DisplayStatus של המקבל אם הנמען הזה הוא CAST. הסטטוס של המקבל מתעדכן על ידי האפליקציה של המקבל.

פרמטר

המקבל

chrome.cast.Receiver

המקבל.

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

successCallback

function()

התקשרות חזרה כשהגדרת הסטטוס מצליחה.

errorCallback

function(non-null chrome.cast.Error)

השגיאות האפשריות הן גלוף, INVALID_PARAMETER, API_NOT_INITIALIZED ו-extensions_MISSING.
הוצא משימוש
אין תמיכה ב-Cast SDK שמבוסס על presentation API.

unescape

סטטי

unescape(escaped) מחזיר מחרוזת

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

פרמטר

נמלט

מחרוזת

מחרוזת שצריך לבטל את ה-escape
החזרות

string מחרוזת ללא קוד Escape

סוג מופשט

ReceiverActionListener

סטטי

ReceiverActionListener()