שיעור: סשן

chrome.העברה.סשן

class   סטטי

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

יצרן

סשן

new Session(sessionId, appId, displayName, appImages, Receiver)

פרמטר
sessionId	מחרוזת מזהה הסשן.
appId	מחרוזת מזהה האפליקציה של המקבל.
displayName	מחרוזת השם המוצג של האפליקציה.
appImages	מערך של chrome.cast.Image שאינו ריק תמונות שמשויכות לאפליקציה. הערך לא יכול להיות ריק.
המקבל	chrome.cast.Receiver המקבל שמפעיל את האפליקציה. הערך לא יכול להיות ריק.

תכונות

appId

מחרוזת

המזהה של אפליקציית Cast. לא להצגה.

appImages

מערך לא ריק של chrome.cast.Image שאינו ריק

מערך של תמונות זמינות שמתארות את האפליקציה.

displayName

מחרוזת

שם קריא (לבני אדם) של אפליקציית Cast. לדוגמה, "YouTube".

media

מערך לא ריק של chrome.cast.media.Media

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

מרחבי שמות

מערך לא ריק של {name: string}

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

המקבל

chrome.cast.Receiver לא ריק

המקבל שמפעיל את האפליקציה.

senderApps

מערך לא ריק של chrome.cast.SenderApplication

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

sessionId

מחרוזת

מזהה באופן ייחודי את המופע הזה של אפליקציית המקבל.

status

chrome.cast.SessionStatus אינו null

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

statusText

מחרוזת שאפשר להזין ללא ערך (null)

טקסט תיאורי של תוכן האפליקציה הנוכחי, למשל "My Families Slides".

transportId

מחרוזת

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

שיטות

addMediaListener

addMediaListener(listener)

הוספת listener שמופעל כששולח מדיה נוצר על ידי שולח אחר.

פרמטר
listener	function(non-null chrome.cast.media.Media) ה-listener שצריך להוסיף.

addMessageListener

addMessageListener(namespace, listener)

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

פרמטר
מרחב שמות	מחרוזת מרחב השמות להאזנה, למשל 'urn:x-cast:com.example.namespace'.
listener	function(string, string) ה-listener שיש להוסיף.

addUpdateListener

addUpdateListener(listener)

הוספת האזנה מופעלת כשהסשן משתנה. שינויים במאפיינים הבאים יפעילו את המאזינים: statusText, מרחבי שמות, סטטוס ועוצמת הקול של המקבל.

מאזינים צריכים לבדוק את המאפיין status של הסשן כדי לקבוע את סטטוס החיבור שלו. הפרמטר הבוליאני isAlive הוצא משימוש והוחלף במאפיין הסשן status. הפרמטר isAlive עדיין מועבר לצורך תאימות לאחור, והוא מוגדר כ-true, אלא אם הוא status = chrome.cast.SessionStatus.STOPPED.

פרמטר
listener	function(boolean) ה-listener שיש להוסיף.

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

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

פרמטר
successCallback	function(non-null chrome.cast.DialLaunchData)
errorCallback	function(non-null chrome.cast.Error)

השאר

out(refundCallback, errorCallback)

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

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

לכל הלקוחות שמנותקים יוזמנו מאזינים לעדכון סשן באמצעות isAlive = true. מאזינים צריכים לבדוק את המאפיין status של הסשן כדי לקבוע את סטטוס החיבור שלו, כי isAlive הוצא משימוש. במקרה הזה, status = chrome.cast.SessionStatus.DISCONNECTED.

פרמטר
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING.

loadMedia

loadMedia(loadRequest, successCallback, errorCallback)

טוען מדיה לאפליקציה פעילה של המקבל.

פרמטר
loadRequest	chrome.cast.media.LoadRequest בקשה לטעון מדיה. הערך לא יכול להיות ריק.
successCallback	function(non-null chrome.cast.media.Media) הופעל עם המדיה שנטענה בהצלחה.
errorCallback	function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING.

queueLoad

queueLoad(queueLoadRequest, successCallback, errorCallback)

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

פרמטר
queueLoadRequest	chrome.cast.media.QueueLoadRequest בקשה לטעינה של תור חדש של פריטי מדיה. הערך לא יכול להיות ריק.
successCallback	function(non-null chrome.cast.media.Media) הופעל עם המדיה שנטענה בהצלחה.
errorCallback	function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING.

הוצא משימוש

משתמשים ב-cast.framework.CastSession#loadMedia ומספק את הערך הרלוונטי של chrome.cast.media.LoadRequest#queueData.

removeMediaListener

removeMediaListener(listener)

מסיר מאזין שנוסף בעבר באמצעות addMediaListener.

פרמטר
listener	function(non-null chrome.cast.media.Media) המאזין להסרה.

removeMessageListener

removeMessageListener(namespace, listener)

הסרת האזנה להודעות שכבר הוספת.

פרמטר
מרחב שמות	מחרוזת מרחב השמות שהמערכת מאזינה לו. למשל, 'urn:x-cast:com.example.namespace'.
listener	function(string, string) ה-listener שיש להסיר.

removeUpdateListener

removeUpdateListener(listener)

מסיר האזנה שנוספה בעבר לסשן הזה.

פרמטר
listener	function(boolean) ה-listener שיש להסיר.

sendMessage

sendMessage(namespace, message, successCallback, errorCallback)

שליחת הודעה לאפליקציה של המקבל במרחב השמות הנתון. הפעלת ה-SuccessCallback מופעלת כשההודעה נשלחת לערוץ העברת ההודעות. המסירה לאפליקציה של המקבל היא כמיטב יכולתה והיא לא מובטחת.

פרמטר
מרחב שמות	מחרוזת מרחב השמות שבו יש לשלוח את ההודעה, למשל 'urn:x-cast:com.example.namespace'.
הודעה	(non-null Object or string)
successCallback	function() מופעלת לאחר שליחת ההודעה.
errorCallback	function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING.

setReceiverMuted

setReceiverMuted(muted, successCallback, errorCallback)

הגדרת עוצמת הקול של המקלט.

פרמטר
מושתק	boolean הסטטוס החדש של ההשתקה.
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) השגיאות האפשריות הן FUNCTION , API_NOT_INITIALIZED , INVALID_PARAMETER , CHANNEL_ERROR , SESSION_ERROR ו-extensions_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel, successCallback, errorCallback)

הגדרת עוצמת הקול של המקלט.

פרמטר
newLevel	מספר עוצמת הקול החדשה בין 0.0 ל-1.0.
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) השגיאות האפשריות הן FUNCTION , API_NOT_INITIALIZED , INVALID_PARAMETER , CHANNEL_ERROR , SESSION_ERROR ו-extensions_MISSING.

עצירת ביניים

stop(SuccessCallback, errorCallback)

מפסיק את אפליקציית המקלט הפעילה המשויכת להפעלה.

פרמטר
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING.