cast.
管理投放工作階段。
建構函式
CastSession
new CastSession(sessionObj, 狀態)
參數 |
|
|---|---|
|
sessionObj |
工作階段資料。 值不得為空值。 |
|
state |
工作階段狀態。 值不得為空值。 |
方法
addEventListener
addEventListener(type, handler)
新增事件監聽器。
參數 |
|
|---|---|
|
類型 |
cast.framework.SessionEventType 這是指活動類型。 值不得為空值。 |
|
處理常式 |
(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)
新增接收方應用程式訊息時叫用的事件監聽器。叫用事件監聽器時，系統會使用命名空間做為第一個引數，並將訊息做為第二個引數。
參數 |
|
|---|---|
|
命名空間 |
字串 要監聽的命名空間，例如「urn:x-cast:com.example.namespace」。 |
|
事件監聽器 |
function(string, string) 要新增的事件監聽器。 |
endSession
endSession(stopCasting)
結束目前的工作階段。
參數 |
|
|---|---|
|
stopCasting |
boolean 是否在結束目前的工作階段時停止接收器應用程式。 |
getActiveInputState
getActiveInputState() 會傳回 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這個工作階段的專屬 ID。
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
將媒體載入執行中的接收器應用程式。
參數 |
|
|---|---|
|
loadRequest |
值不得為空值。 |
- 傳回
-
non-null Promise containing nullable chrome.cast.ErrorCode：表示載入成功或無法傳送至接收端的承諾 (工作階段會傳遞至 media_session 事件)。
removeEventListener
removeEventListener(type, handler)
移除事件監聽器。
參數 |
|
|---|---|
|
類型 |
cast.framework.SessionEventType 這是指活動類型。 值不得為空值。 |
|
處理常式 |
(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」。 |
|
事件監聽器 |
function(string, string) 要移除的事件監聽器。 |
sendMessage
sendMessage(namespace, data) 會傳回包含可為空值的 chrome.cast.ErrorCode
傳送訊息給接收者。
參數 |
|
|---|---|
|
命名空間 |
字串 用於傳送訊息的命名空間，例如「urn:x-cast:com.example.namespace」。 |
|
資料或曾存取這類資料的人員 |
(non-null Object or string) 要傳送的資料。 |
- 傳回
-
non-null Promise containing nullable chrome.cast.ErrorCode已解決訊息傳送時的承諾；如果失敗，則因錯誤代碼而遭拒。
setMute
setMute(isMute) 會傳回包含可為空值的 chrome.cast.ErrorCode
將接收者設為靜音或設為靜音。
參數 |
|
|---|---|
|
isMute |
boolean 新的靜音狀態。 |
- 傳回
-
non-null Promise containing nullable chrome.cast.ErrorCode已解決的承諾接收器已更新，如果失敗，則因錯誤代碼而遭拒。
setVolume
setVolume(Volume) 傳回 Promise，其中包含可為空值的 chrome.cast.ErrorCode
設定接收端音量。
參數 |
|
|---|---|
|
磁碟區 |
號碼 新的音量大小介於 0.0 和 1.0 之間。 |
- 傳回
-
non-null Promise containing nullable chrome.cast.ErrorCode已解決的承諾接收器已更新，如果失敗，則因錯誤代碼而遭拒。