chrome.cast。 工作階段
說明目前執行中的 Cast 應用程式狀態。 通常，用戶端不應建立這些物件。
建構函式
議程
new Session(sessionId, appId, displayName, appImages, Receiver)
參數 |
|
|---|---|
|
sessionId |
字串 工作階段 ID。 |
|
appId |
字串 接收端應用程式 ID。 |
|
displayName |
字串 應用程式的顯示名稱。 |
|
appImages |
非空值 chrome.cast.Image 陣列 與應用程式相關聯的圖片。 值不得為空值。 |
|
接收者 |
執行應用程式的接收器。 值不得為空值。 |
屬性
appId
字串
Google Cast 應用程式的 ID。不提供顯示。
appImages
非空值 chrome.cast.Image 非空值陣列
可描述應用程式的圖片陣列。
displayName
字串
Google Cast 應用程式使用者可理解的名稱，例如「YouTube」。
media
非空值 chrome.cast.media.Media 非空值陣列
屬於這個投放工作階段的媒體，包括其他傳送者載入的媒體。
namespaces
{name: string} 的非空值陣列
接收器應用程式支援的命名空間清單。
接收者
執行應用程式的接收器。
senderApps
非空值 chrome.cast.SenderApplication 非空值陣列
接收端應用程式支援的傳送端應用程式。此屬性可能會用於提示使用者安裝或造訪寄件者應用程式。
sessionId
字串
專門用於識別接收器應用程式的執行個體。
資格
這個投放工作階段傳送至接收端應用程式的狀態。
statusText
可為空值字串
目前應用程式內容的說明文字，例如「我的婚禮投影片」。
transportId
字串
專門用來說明此工作階段的 ID，以便用於傳輸目的。此為內部通訊管道。
方法
addMediaListener
addMediaListener(listener)
新增另一個傳送者建立媒體工作階段時叫用的事件監聽器。
參數 |
|
|---|---|
|
事件監聽器 |
function(non-null chrome.cast.media.Media) 要新增的事件監聽器。 |
addMessageListener
addMessageListener(namespace, listener)
新增接收方應用程式訊息時叫用的事件監聽器。叫用事件監聽器時，系統會使用命名空間做為第一個引數，並將訊息做為第二個引數。
參數 |
|
|---|---|
|
命名空間 |
字串 要監聽的命名空間，例如「urn:x-cast:com.example.namespace」。 |
|
事件監聽器 |
function(string, string) 要新增的事件監聽器。 |
addUpdateListener
addUpdateListener(listener)
新增在工作階段變更時叫用的事件監聽器。變更下列屬性會觸發事件監聽器：statusText、命名空間、狀態，以及接收者的音量。
事件監聽器應檢查工作階段的 status 屬性，判斷連線狀態。布林值參數 isAlive 已淘汰，並改用 status 工作階段屬性。系統仍會傳入 isAlive 參數以顧及回溯相容性，除非 status =
chrome.cast.SessionStatus.STOPPED 除外。
參數 |
|
|---|---|
|
事件監聽器 |
function(boolean) 要新增的事件監聽器。 |
getDialAppInfo
getDialAppInfo(successCallback, errorCallback)
取得 DIAL 應用程式資訊。
參數 |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.DialLaunchData) |
|
errorCallback |
function(non-null chrome.cast.Error) |
出發
離開(successCallback, errorCallback)
與工作階段相關聯的執行中接收器應用程式退出 (中斷連結)。
這個用戶端 AutoJOINPolicy 定義範圍內的現有用戶端會中斷連線。未來的客戶不會自動加入先前離開的時段。
所有中斷連線的用戶端都會使用 isAlive = true 呼叫工作階段更新事件監聽器。isAlive ���淘汰，事件監聽器應檢查工作階段的 status 屬性，判斷其連線狀態。在這種情況下，status = chrome.cast.SessionStatus.DISCONNECTED。
參數 |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
loadMedia
loadMedia(loadRequest, successCallback, errorCallback)
將媒體載入執行中的接收器應用程式。
參數 |
|
|---|---|
|
loadRequest |
要求載入媒體。 值不得為空值。 |
|
successCallback |
function(non-null chrome.cast.media.Media) 在成功時由已載入的媒體叫用。 |
|
errorCallback |
function(non-null chrome.cast.Error) 發生錯誤時叫用。可能的錯誤有 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_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) 發生錯誤時叫用。可能的錯誤有 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
removeMediaListener
removeMediaListener(listener)
移除先前使用 addMediaListener 新增的事件監聽器。
參數 |
|
|---|---|
|
事件監聽器 |
function(non-null chrome.cast.media.Media) 要移除的事件監聽器。 |
removeMessageListener
removeMessageListener(namespace, listener)
移除先前新增的訊息事件監聽器。
參數 |
|
|---|---|
|
命名空間 |
字串 監聽的命名空間，例如「urn:x-cast:com.example.namespace」。 |
|
事件監聽器 |
function(string, string) 要移除的事件監聽器。 |
removeUpdateListener
removeUpdateListener(listener)
移除先前為這個工作階段新增的事件監聽器。
參數 |
|
|---|---|
|
事件監聽器 |
function(boolean) 要移除的事件監聽器。 |
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) 發生錯誤時叫用。可能的錯誤有 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
setReceiverMuted
setReceiverMuted(muted, successCallback, errorCallback)
設定接收端音量。
參數 |
|
|---|---|
|
已設為靜音。 |
boolean 新的靜音狀態。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
setReceiverVolumeLevel
setReceiverVolumeLevel(newLevel, successCallback, errorCallback)
設定接收端音量。
參數 |
|
|---|---|
|
newLevel |
號��� 新的音量大小介於 0.0 和 1.0 之間。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |
轉機 1 次
stop(successCallback, errorCallback)
停止與工作階段相關聯的執行中接收器應用程式。
參數 |
|
|---|---|
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。 |