投射
管理投放会话。
构造函数
投放会话
new CastSession(sessionObj, state)
参数 |
|
|---|---|
|
sessionObj |
会话数据。 值不能为 null。 |
|
state |
会话状态。 值不能为 null。 |
方法
addEventListener
addEventListener(类型, 处理程序)
添加事件侦听器。
参数 |
|
|---|---|
|
类型 |
cast.framework.SessionEventType 事件类型。 值不能为 null。 |
|
handler |
（函数（非 null cast.framework.ApplicationStatusEventData）、函数（非 null cast.framework.ApplicationMetadataEventData）、函数（非 null cast.framework.ActiveInputStateEventData）、函数（非 null cast.framework.MediaSessionEventData）或函数（非 null cast.framework.VolumeEventData） |
addMessageListener
addMessageListener(命名空间, 监听器)
添加从接收方应用收到消息时调用的监听器。调用监听器时，命名空间为第一个参数，消息为第二个参数。
参数 |
|
|---|---|
|
命名空间 |
字符串 要监听的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
监听器 |
函数（字符串、字符串） 要添加的监听器。 |
结束会话
endSession(stopCasting)
结束当前会话。
参数 |
|
|---|---|
|
停止投放 |
布尔值 终止当前会话后接收器应用是否应停止。 |
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() 返回布尔值
- 返回
-
nullable boolean接收方设为静音状态（如有）。
加载媒体
loadMedia(loadRequest) 返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise
将媒体加载到正在运行的接收器应用中。
参数 |
|
|---|---|
|
loadRequest |
值不能为 null。 |
- 返回
-
non-null Promise containing nullable chrome.cast.ErrorCode表示加载成功或失败的接收器（将会话传递到 media_session 事件）。
移除事件监听器
removeEventListener(类型, 处理程序)
移除事件监听器。
参数 |
|
|---|---|
|
类型 |
cast.framework.SessionEventType 事件类型。 值不能为 null。 |
|
handler |
（函数（非 null cast.framework.ApplicationStatusEventData）、函数（非 null cast.framework.ApplicationMetadataEventData）、函数（非 null cast.framework.ActiveInputStateEventData）、函数（非 null cast.framework.MediaSessionEventData）或函数（非 null cast.framework.VolumeEventData） |
移除消息监听器
removeMessageListener(命名空间, 监听器)
移除之前添加的消息监听器。
参数 |
|
|---|---|
|
命名空间 |
字符串 被监听的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
监听器 |
函数（字符串、字符串） 要移除的监听器。 |
sendMessage
sendMessage(namespace, data) 返回包含可为 null chrome.cast.ErrorCode 的 Promise
向接收者发送消息。
参数 |
|
|---|---|
|
命名空间 |
字符串 要发送消息的命名空间，例如“urn:x-cast:com.example.namespace”。 |
|
数据 |
（非 null 对象或字符串） 要发送的数据。 |
- 返回
-
non-null Promise containing nullable chrome.cast.ErrorCode：解析了发送消息时的 promise；如果失败，则拒绝并返回错误代码。
setMute
setMute(isMute) 返回包含可为 null chrome.cast.ErrorCode 的 promise
将接收者静音或静音。
参数 |
|
|---|---|
|
静音 |
布尔值 新的静音状态。 |
- 返回
-
non-null Promise containing nullable chrome.cast.ErrorCode已解决的 promise 接收器已更新，如果失败，则会拒绝并返回错误代码。
setVolume
setVolume(volume) 会返回包含可为 null 的 chrome.cast.ErrorCode 的 Promise
设置接收器音量。
参数 |
|
|---|---|
|
音量 |
number 介于 0.0 和 1.0 之间的新音量。 |
- 返回
-
non-null Promise containing nullable chrome.cast.ErrorCode已解决的 promise 接收器已更新，如果失败，则会拒绝并返回错误代码。