chrome. cast. ApiConfig
מכיל את ההגדרות של ה-API במהלך האתחול.
יצרן
ApiConfig
new ApiConfig(sessionRequest, sessionListener, ReceiverListener, autojoinPolicy, defaultActionPolicy)
פרמטר |
|
---|---|
sessionRequest |
בקשת הסשן. הערך לא יכול להיות ריק. |
sessionListener |
function(non-null chrome.cast.Session) מאזין שיקבל התראה כשסשן זמין לאפליקציה. |
receiverListener |
function(non-null chrome.cast.ReceiverAvailability) מאזינים שיקבלו התראה כשיש מקלט זמין. |
autoJoinPolicy |
אופציונלי מדיניות ההצטרפות האוטומטית של האפליקציה. הערך לא יכול להיות ריק. |
defaultActionPolicy |
אופציונלי chrome.cast.DefaultActionPolicy פעולת ברירת המחדל שצריך לבצע כשהמשתמש כבר מעביר (cast) כאשר האפליקציה מופעלת. הערך לא יכול להיות ריק. |
תכונות
autoJoinPolicy
chrome.cast.AutoJoinPolicy לא ריק
המדיניות קובעת אם ה-SDK יתחבר באופן אוטומטי לסשן פעיל אחרי האתחול.
defaultActionPolicy
לא ריק chrome.cast.DefaultActionPolicy
הפונקציה בודקת אם האפליקציה תופעל באתחול ה-API כשהכרטיסייה כבר מועברת. אפליקציות בתוכן מוטמע (כמו iframes) צריכות להגדיר את השדה הזה כ-CAST_THIS_TAB אם הן לא האפליקציה הראשית בדף. הערך הזה גם מגדיר את התנהגות ברירת המחדל של החלון הקופץ של התוסף עבור הדף.
receiverListener
function(non-null chrome.cast.ReceiverAvailability)
הפונקציה מופעלת כשהזמינות של מקלט Cast שתומך באפליקציה ב-sessionRequest ידועה או משתנה. הפונקציה הזו תמיד תופעל לפחות פעם אחת אחרי שהאתחול יושלם.
sessionListener
function(non-null chrome.cast.Session)
ה מאזין מופעל כאשר סשן נוצר או מחובר על ידי ה-SDK. אפשר להפעיל את הפונקציה הזו אחרי האתחול אם יש סשן שנוצר או מחובר באופן אוטומטי. חשוב לשים לב ששיטת requestSession לא גורמת להפעלת ה-listener הזה כי יש לו קריאה חוזרת (callback) שמוגדרת כהצלחה.
sessionRequest
chrome.cast.SessionRequest לא ריק
מתאר את הסשן שרוצים להפעיל או את הסשן שרוצים להתחבר.