מחלקה: CastSession

cast.מסגרת.CastSession

class   סטטי

ניהול סשן העברה.

יצרן

CastSession

new CastSession(sessionObj, state)

פרמטר

sessionObj

chrome.cast.Session

נתוני סשנים.

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

state

cast.framework.SessionState

מצב הסשן.

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

שיטות

addEventListener

addEventListener(type, handler)

הוספת event listener.

פרמטר

סוג

cast.framework.SessionEventType

סוג האירוע.

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

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

addMessageListener

addMessageListener(namespace, listener)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות להאזנה, למשל 'urn:x-cast:com.example.namespace'.

listener

function(string, string)

ה-listener שיש להוסיף.

endSession

endSession(stopCasting)

סיום הסשן הנוכחי.

פרמטר

stopCasting

boolean

האם יש להפסיק את האפליקציה של המקבל בסיום הסשן הנוכחי.

getActiveInputState

getActiveTakeState() returns cast.framework.ActiveInputState

החזרות

non-null cast.framework.ActiveInputState מצב הקלט הפעיל של המקבל.

getApplicationMetadata

getApplicationMetadata() מחזיר cast.framework.ApplicationMetadata

החזרות

non-null cast.framework.ApplicationMetadata המטא-נתונים של האפליקציה.

getApplicationStatus

getApplicationStatus() המחזירה מחרוזת

החזרות

nullable string מחרוזת סטטוס האפליקציה.

getCastDevice

getCastDevice() מחזיר chrome.cast.Receiver

החזרות

non-null chrome.cast.Receiver מטא-נתונים של מכשיר העברה.

getMediaSession

getMediaSession() מחזיר chrome.cast.media.Media

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

החזרות

nullable chrome.cast.media.Media סשן המדיה הנוכחי.

getSessionId

getSessionId() מחזיר מחרוזת

החזרות

string מזהה ייחודי לסשן הזה.

getSessionObj

getSessionObj() מחזיר chrome.cast.Session

החזרות

non-null chrome.cast.Session נתוני סשנים.

getSessionState

getSessionState() מחזיר cast.framework.SessionState

החזרות

cast.framework.SessionState מצב הסשן הנוכחי.

getVolume

getVolume() מחזיר מספר

החזרות

nullable number עוצמת קול של מקלט, אם היא זמינה.

isMute

ismute() מחזיר בוליאני

החזרות

nullable boolean הסטטוס הושתק על ידי המקלט, אם זמין.

loadMedia

loadMedia(loadRequest) מחזיר Promise המכיל chrome.cast.ErrorCode ערך null

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

פרמטר

loadRequest

chrome.cast.media.LoadRequest

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

non-null Promise containing nullable chrome.cast.ErrorCode הבטחה לציין שהטעינה הסתיימה בהצלחה או שהשליחה נכשלה (הסשן מועבר לאירוע media_session).

removeEventListener

removeEventListener(type, handler)

מסיר event listener.

פרמטר

סוג

cast.framework.SessionEventType

סוג האירוע.

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

handler

(function(non-null cast.framework.ApplicationStatusEventData), function(non-null cast.framework.ApplicationMetadataEventData), function(non-null cast.framework.ActiveInputStateEventData), function(non-null cast.framework.MediaSessionEventData), or function(non-null cast.framework.VolumeEventData))

removeMessageListener

removeMessageListener(namespace, listener)

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

פרמטר

מרחב שמות

מחרוזת

מרחב השמות שהמערכת מאזינה לו. למשל, 'urn:x-cast:com.example.namespace'.

listener

function(string, string)

ה-listener שיש להסיר.

sendMessage

SendMessage(namespace, data) מחזירה הבטחה שמכילה ערך null בכתובת chrome.cast.ErrorCode

תישלח הודעה לצד המקבל.

פרמטר

מרחב שמות

מחרוזת

מרחב השמות שבו יש לשלוח את ההודעה, למשל 'urn:x-cast:com.example.namespace'.

נתונים

(non-null Object or string)

הנתונים לשליחה.
החזרות

non-null Promise containing nullable chrome.cast.ErrorCode הבטחה טופלה כאשר ההודעה נשלחה, או נדחתה עם קוד שגיאה אם נכשלה.

setMute

setהשתקת(ismute) מחזירה הבטחה שמכילה את הערך הריק chrome.cast.ErrorCode

השתקה או השתקה של המקבל.

פרמטר

isMute

boolean

הסטטוס החדש של ההשתקה.
החזרות

non-null Promise containing nullable chrome.cast.ErrorCode מקבל ההבטחה שטופלה עודכן או נדחה עם קוד שגיאה אם הפעולה נכשלה.

setVolume

setVolume(volume) מחזיר Promise המכיל chrome.cast.ErrorCode ערך null

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

פרמטר

עוצמת קול

מספר

עוצמת הקול החדשה בין 0.0 ל-1.0.
החזרות

non-null Promise containing nullable chrome.cast.ErrorCode מקבל ההבטחה שטופלה עודכן או נדחה עם קוד שגיאה אם הפעולה נכשלה.