類別:Session

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

建構函式

Session

新工作階段(sessionId、appId、displayName、appImages、接收器)

參數

工作階段編號

string

工作階段 ID。

appId

string

接收器應用程式識別碼。

displayName

string

應用程式的顯示名稱。

應用程式圖片

非空值的 chrome.cast.Image 陣列

與應用程式相關聯的圖片。

值不得為空值。

接收器

chrome.cast.Receiver

執行應用程式的接收器。

值不得為空值。

屬性

appId

string

Cast 應用程式的 ID。不適用於多媒體廣告。

應用程式圖片

非空值 chrome.cast.Image 中的非空值陣列

用來描述應用程式的圖片陣列。

displayName

string

Cast 應用程式使用者可理解的名稱,例如「YouTube」。

media

非空值的 chrome.cast.media.Media 陣列

屬於這個 Cast 工作階段的媒體,包括其他寄件者載入的媒體。

namespaces

{name: string} 的非空值陣列

接收器應用程式支援的命名空間清單。

接收器

chrome.cast.Receiver 非空值

執行應用程式的接收器。

寄件者應用程式

非空值 chrome.cast.sendApplication 非空值陣列

接收器應用程式支援的寄件者應用程式。這項資訊可能會提示使用者安裝或造訪傳送者應用程式。

工作階段編號

string

唯一識別接收器應用程式的這個執行個體。

狀態

chrome.cast.SessionStatus 非空值

這個投放工作階段傳送給接收端應用程式的狀態。

狀態文字

可為空值的字串

目前應用程式內容的描述性文字,例如「我的結婚投影片」。

傳輸 ID

string

專門用於傳輸作業的工作階段 ID,其用途為傳輸。此為通訊管道的內部專用。

方法

addMediaListener

addMediaListener(listener)

新增一個事件監聽器,由另一個傳送者建立媒體工作階段時叫用。

參數

事件監聽器

function(非空值的 chrome.cast.media.Media)

要新增的事件監聽器。

addMessageListener

addMessageListener(namespace, Listener)

新增接聽程式,系統從接收器應用程式收到訊息時叫用。事件監聽器會以命名空間做為第一個引數,並將訊息作為第二個引數叫用。

參數

命名空間

string

要監聽的命名空間,例如「urn:x-cast:com.example.namespace」。

事件監聽器

function(string, string) (函式 (字串、字串))

要新增的事件監聽器。

addUpdateListener

addUpdateListener(清單)

新增在工作階段變更時叫用的監聽器。變更下列屬性會觸發事件監聽器:statusText、namespace、status 和接收器的音量。

事件監聽器應檢查工作階段的 status 屬性,才能判斷其連線狀態。布林值參數 isAlive 已淘汰,並改用 status 工作階段屬性。為兼顧回溯相容性,系統仍會傳遞 isAlive 參數;除非 status = chrome.cast.SessionStatus.STOPPED 是如此,否則為 true。

參數

事件監聽器

函式(布林值)

要新增的事件監聽器。

getDialAppInfo

getDialAppInfo(successCallback, errorCallback)

取得 DIAL 應用程式資訊。

參數

成功回呼

function(非空值的 chrome.cast.DialLaunchData)

errorCallback

function(非空值的 chrome.cast.Error)

出發

離開(successCallback、errorCallback)

從與工作階段相關聯的執行中接收應用程式離開 (中斷連線)。

在這個用戶端的 AutoJoinPolicy 定義的範圍內,現有的客戶將會中斷連線。未來的客戶不會自動加入剩餘的工作階段。

所有中斷連線的用戶端都會收到呼叫 isAlive = true 的工作階段更新事件監聽器。isAlive 已淘汰,因此事件監聽器應檢查工作階段的 status 屬性,才能判斷其連線狀態。在這種情況下,status = chrome.cast.SessionStatus.DISCONNECTED

參數

成功回呼

function()

errorCallback

function(非空值的 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

載入媒體

loadMedia(loadRequest、successCallback、errorCallback)

將媒體載入正在執行的接收器應用程式。

參數

loadRequest

chrome.cast.media.LoadRequest

要求載入媒體。

值不得為空值。

成功回呼

function(非空值的 chrome.cast.media.Media)

成功透過載入的媒體叫用。

errorCallback

function(非空值的 chrome.cast.Error)

發生錯誤時叫用。可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

queueLoad

queueLoad(queueLoadRequest、successCallback、errorCallback)

載入 (或視需要) 將執行的新媒體項目佇列播放至執行中的接收器應用程式。

參數

佇列載入要求

chrome.cast.media.QueueLoadRequest

要求載入媒體項目的新佇列。

值不得為空值。

成功回呼

function(非空值的 chrome.cast.media.Media)

成功透過載入的媒體叫用。

errorCallback

function(非空值的 chrome.cast.Error)

發生錯誤時叫用。可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

已淘汰
使用 cast.framework.CastSession#loadMedia,並提供相關的 chrome.cast.media.LoadRequest#queueData

移除 MediaListener

removeMediaListener(listener)

移除先前使用 addMediaListener 新增的事件監聽器。

參數

事件監聽器

function(非空值的 chrome.cast.media.Media)

要移除的事件監聽器。

removeMessageListener

removeMessageListener(namespace, Listener)

移除先前為訊息新增的事件監聽器。

參數

命名空間

string

監聽的命名空間,例如「urn:x-cast:com.example.namespace」。

事件監聽器

function(string, string) (函式 (字串、字串))

要移除的事件監聽器。

removeUpdateListener

removeUpdateListener(listener)

移除此工作階段先前新增的事件監聽器。

參數

事件監聽器

函式(布林值)

要移除的事件監聽器。

傳送訊息

sendMessage(namespace, message, successCallback, errorCallback)

向指定命名空間上的接收器應用程式傳送訊息。訊息已提交至訊息管道時,系統會叫用成功呼叫。對接收器應用程式推送是最佳工作,但不保證一定正確。

參數

命名空間

string

用於傳送訊息的命名空間,例如「urn:x-cast:com.example.namespace」。

訊息

(非空值物件或字串)

成功回呼

function()

於訊息送出時叫用。

errorCallback

function(非空值的 chrome.cast.Error)

發生錯誤時叫用。可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

setReceiver 靜音

setReceivermud(muted, successCallback, errorCallback)

設定接收器音量。

參數

已設為靜音。

布林值

新的靜音狀態。

成功回呼

function()

errorCallback

function(非空值的 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

setReceiverVolumeLevel

setReceiverVolumeLevel(newLevel、successCallback、errorCallback)

設定接收器音量。

參數

新關卡

數字

介於 0.0 和 1.0 之間的新音量等級。

成功回呼

function()

errorCallback

function(非空值的 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。

停止

stop(successCallback, errorCallback)

停止與工作階段相關聯的執行中的接收器應用程式。

參數

成功回呼

function()

errorCallback

function(非空值的 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、CHANNEL_ERROR、SESSION_ERROR 和 EXTENSION_MISSING。