cast. framework. CastSession
キャスト セッションを管理します。
コンストラクタ
CastSession
new CastSession(sessionObj, state)
パラメータ |
|
---|---|
sessionObj |
セッション データ。 値を null にすることはできません。 |
state |
セッション状態。 値を null にすることはできません。 |
Methods
addEventListener
addEventListener(type, ハンドラ)
イベント リスナーを追加します。
パラメータ |
|
---|---|
type |
cast.framework.SessionEventType イベントの種類です。 値を null にすることはできません。 |
handler |
(function(null 以外)cast.framework.ApplicationStatusEventData、function(null 以外の cast.framework.ApplicationMetadataEventData)、function(null 以外の cast.framework.ActiveInputStateEventData)、function(非 null cast.framework.MediaSessionEventData)、または関数(null 以外の cast.framework.VolumeEventData) |
addMessageListener
addMessageListener(namespace, listener)
レシーバ アプリケーションからメッセージを受信したときに呼び出されるリスナーを追加します。リスナーは、最初の引数として名前空間を使用し、2 番目の引数としてメッセージとともに呼び出されます。
パラメータ |
|
---|---|
名前空間 |
文字列 リッスンする名前空間(例: urn:x-cast:com.example.namespace)。 |
リスナー |
function(string, string) 追加するリスナー。 |
終了セッション
endSession(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
レシーバーの音量(利用可能な場合)
is ミュート
is サイレント()はブール値を返します
- 戻り値
-
nullable boolean
レシーバーのミュート ステータス(利用可能な場合)
loadMedia
loadMedia(loadRequest) は、null 値許容の chrome.cast.ErrorCode を含む Promise を返します。
実行中のレシーバ アプリケーションにメディアを読み込みます。
パラメータ |
|
---|---|
loadRequest |
値を null にすることはできません。 |
- 戻り値
-
non-null Promise containing nullable chrome.cast.ErrorCode
読み込みが正常に行われたか、受信側に送信できなかったことを示すことを約束します(セッションは media_session イベントに渡されます)。
removeEventListener
removeEventListener(type, ハンドラ)
イベント リスナーを削除します。
パラメータ |
|
---|---|
type |
cast.framework.SessionEventType イベントの種類です。 値を null にすることはできません。 |
handler |
(function(null 以外)cast.framework.ApplicationStatusEventData、function(null 以外の cast.framework.ApplicationMetadataEventData)、function(null 以外の cast.framework.ActiveInputStateEventData)、function(非 null cast.framework.MediaSessionEventData)、または関数(null 以外の cast.framework.VolumeEventData) |
removeMessageListener
removeMessageListener(namespace, listener)
以前に追加されたメッセージのリスナーを削除します。
パラメータ |
|
---|---|
名前空間 |
文字列 リッスンする名前空間(例: urn:x-cast:com.example.namespace)。 |
リスナー |
function(string, string) 削除するリスナー。 |
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
set ミュート(isPush)は、null 値許容の chrome.cast.ErrorCode を含む Promise を返します。
レシーバーをミュートまたはミュートする
パラメータ |
|
---|---|
is ミュート |
boolean 新しくミュートされたステータス。 |
- 戻り値
-
non-null Promise containing nullable chrome.cast.ErrorCode
Promise レシーバが更新され、失敗した場合はエラーコードで拒否されました。
setVolume
setVolume(volume) は、null 値許容の chrome.cast.ErrorCode を含む Promise を返します。
レシーバーの音量を設定します。
パラメータ |
|
---|---|
Volume |
数値 新しい音量レベル。0.0 ~ 1.0。 |
- 戻り値
-
non-null Promise containing nullable chrome.cast.ErrorCode
Promise レシーバが更新され、失敗した場合はエラーコードで拒否されました。