chrome.
これは chrome.cast 名前空間です。
クラス
ApiConfig
初期化時に API の構成を保持します。
CredentialsData
送信者の認証情報を識別するために使用される認証情報データ。
DialRequest
DIAL アプリを起動するリクエスト。
エラー
API から返されるエラーについて説明します。通常、これらのオブジェクトをクライアントが作成するべきではありません。
Image
受信側のアプリまたはメディア アイテムを説明する画像。たとえば、アプリのアイコン、カバーアート、サムネイルなどがあります。
レシーバー
アプリを実行するレシーバを記述します。通常、これらのオブジェクトをクライアントが作成するべきではありません。
ReceiverDisplayStatus
拡張機能の UI でユーザーに表示されるレシーバーのステータス。 CUSTOM レシーバーに対してのみ有効です。
SenderApplication
送信側アプリケーションを記述します。通常、これらのオブジェクトをクライアントが作成するべきではありません。
セッション
現在実行中の Cast アプリの状態を表します。 通常、これらのオブジェクトをクライアントが作成するべきではありません。
SessionRequest
セッションを開始または接続するためのリクエスト。
タイムアウト
API メソッドのデフォルトのタイムアウト値をミリ秒単位で定義します。
Volume
デバイスまたはメディア ストリームの音量。
Namespace
media
列挙型
AutoJoinPolicy
string
自動参加ポリシーは、API の初期化後に SDK が送信側のアプリケーションを既存のセッションに自動的に接続するタイミングを決定します。
値 |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
string 同じタブとページオリジンで、同じ appId でセッションが開始されると、自動的に接続します。 |
|
ORIGIN_SCOPED |
string セッションが同じ appId とページオリジンで開始されると、（タブに関係なく）自動的に接続します。 |
|
PAGE_SCOPED |
string 自動接続はありません。 |
可能な操作
string
受信デバイスでサポートされている機能。
値 |
|
|---|---|
|
VIDEO_OUT |
string レシーバーが動画出力に対応している。 |
|
AUDIO_OUT |
string レシーバーが音声出力をサポートしている。 |
|
VIDEO_IN |
string レシーバーがビデオ入力（カメラ）に対応している。 |
|
AUDIO_IN |
string レシーバーが音声入力（マイク）をサポートしている。 |
|
MULTIZONE_GROUP |
string レシーバーはマルチゾーン グループを表します。 |
DefaultActionPolicy
string
デフォルトのアクション ポリシーにより、API の初期化後に SDK がセッションを自動的に作成するタイミングを決定します。これにより、拡張機能のポップアップに表示されるタブのデフォルトのアクションも制御されます。
値 |
|
|---|---|
|
CREATE_SESSION |
string API の初期化時にアプリを含むタブがキャストされている場合、SDK はタブのキャストを停止し、アプリを自動的に起動します。拡張機能のポップアップで、ユーザーにアプリのキャストを求めるプロンプトが表示されます。 |
|
CAST_THIS_TAB |
string API の初期化後は、タブがキャストされている場合でも自動起動は行われません。拡張機能のポップアップで、タブをキャストするようユーザーに求めます。 |
DialAppState
string
DIAL アプリの状態。
値 |
|
|---|---|
|
実行中 |
string |
|
停止 |
string |
|
エラー |
string 仕様には含まれていません。エラーを通知するために使用されます。 |
ErrorCode
string
SDK から返される可能性のあるエラーです。
値 |
|
|---|---|
|
キャンセル |
string 操作はユーザーによってキャンセルされました。 |
|
TIMEOUT |
string オペレーションがタイムアウトしました。 |
|
API_NOT_INITIALIZED |
string API が初期化されていません。 |
|
INVALID_PARAMETER |
string オペレーションのパラメータが無効です。 |
|
EXTENSION_NOT_COMPATIBLE |
string API スクリプトが、インストールされている Cast 拡張機能と互換性がない。 |
|
EXTENSION_MISSING |
string Cast 拡張機能は利用できません。 |
|
RECEIVER_UNAVAILABLE |
string セッション リクエストに対応しているレシーバーはありませんでした。 |
|
SESSION_ERROR |
string セッションを作成できなかったか、セッションが無効でした。 |
|
CHANNEL_ERROR |
string 受信側のチャンネルは利用できません。 |
|
LOAD_MEDIA_FAILED |
string メディアを読み込めませんでした。 |
ReceiverAction
string
ユーザーが拡張機能のレシーバーに対して実行できる操作。これを使用して、キャスト アクションが完全に完了（または失敗）する前に、送信側のアプリの UI に遷移を表示できます。
値 |
|
|---|---|
|
CAST |
string ユーザーが送信側アプリでレシーバをキャストするつもりで選択した。受取人の正確な身元が不明な場合があります。 |
|
停止 |
string ユーザーがレシーバーで実行中のセッションの停止をリクエストしました。 |
ReceiverAvailability
string
キャスト レシーバーの提供状況について説明します。
値 |
|
|---|---|
|
利用可能 |
string セッション リクエストと互換性のあるレシーバーが少なくとも 1 つ利用できる。 |
|
UNAVAILABLE |
string 利用できるレシーバーがありません。 |
ReceiverType
string
値 |
|
|---|---|
|
CAST |
string キャスト レシーバー（Chromecast など） |
|
DIAL |
string ダイヤル デバイス（スマートテレビなど） |
|
ハングアウト |
string ブラブラ |
|
カスタム |
string クライアントが提供するカスタム レシーバー |
SenderPlatform
string
送信側アプリケーション プラットフォームを記述します。
値 |
|
|---|---|
|
Chrome |
string |
|
iOS |
string |
|
ANDROID |
string |
SessionStatus
string
キャスト セッションのステータスをレシーバー アプリに通知します。
値 |
|
|---|---|
|
統合期 |
string セッションが受信側アプリケーションに接続されます。 |
|
接続解除 |
string セッションが受信側アプリケーションから切断されます。受信側アプリはまだ実行中の場合と実行されていない場合があります。 |
|
停止 |
string 受信側アプリケーションが停止しました。 |
VolumeControlType
string
音量調整の種類について説明します。
値 |
|
|---|---|
|
減衰 |
string キャスト デバイスの音量は変更できます。 |
|
修正済み |
string キャスト デバイスの音量は固定されており、変更できません。 |
|
マスター |
string マスター システムの音量調節（テレビやオーディオ機器の音量の変更など） |
プロパティ
AutoJoinPolicy
string
自動参加ポリシーは、API の初期化後に SDK が送信側のアプリケーションを既存のセッションに自動的に接続するタイミングを決定します。
値 |
|
|---|---|
|
TAB_AND_ORIGIN_SCOPED |
string 同じタブとページオリジンで、同じ appId でセッションが開始されると、自動的に接続します。 |
|
ORIGIN_SCOPED |
string セッションが同じ appId とページオリジンで開始されると、（タブに関係なく）自動的に接続します。 |
|
PAGE_SCOPED |
string 自動接続はありません。 |
可能な操作
string
受信デバイスでサポートされている機能。
値 |
|
|---|---|
|
VIDEO_OUT |
string レシーバーが動画出力に対応している。 |
|
AUDIO_OUT |
string レシーバーが音声出力をサポートしている。 |
|
VIDEO_IN |
string レシーバーがビデオ入力（カメラ）に対応している。 |
|
AUDIO_IN |
string レシーバーが音声入力（マイク）をサポートしている。 |
|
MULTIZONE_GROUP |
string レシーバーはマルチゾーン グループを表します。 |
DefaultActionPolicy
string
デフォルトのアクション ポリシーにより、API の初期化後に SDK がセッションを自動的に作成するタイミングを決定します。これにより、拡張機能のポップアップに表示されるタブのデフォルトのアクションも制御されます。
値 |
|
|---|---|
|
CREATE_SESSION |
string API の初期化時にアプリを含むタブがキャストされている場合、SDK はタブのキャストを停止し、アプリを自動的に起動します。拡張機能のポップアップで、ユーザーにアプリのキャストを求めるプロンプトが表示されます。 |
|
CAST_THIS_TAB |
string API の初期化後は、タブがキャストされている場合でも自動起動は行われません。拡張機能のポップアップで、タブをキャストするようユーザーに求めます。 |
DialAppState
string
DIAL アプリの状態。
値 |
|
|---|---|
|
実行中 |
string |
|
停止 |
string |
|
エラー |
string 仕様には含まれていません。エラーを通知するために使用されます。 |
ErrorCode
string
SDK から返される可能性のあるエラーです。
値 |
|
|---|---|
|
キャンセル |
string 操作はユーザーによってキャンセルされました。 |
|
TIMEOUT |
string オペレーションがタイムアウトしました。 |
|
API_NOT_INITIALIZED |
string API が初期化されていません。 |
|
INVALID_PARAMETER |
string オペレーションのパラメータが無効です。 |
|
EXTENSION_NOT_COMPATIBLE |
string API スクリプトが、インストールされている Cast 拡張機能と互換性がない。 |
|
EXTENSION_MISSING |
string Cast 拡張機能は利用できません。 |
|
RECEIVER_UNAVAILABLE |
string セッション リクエストに対応しているレシーバーはありませんでした。 |
|
SESSION_ERROR |
string セッションを作成できなかったか、セッションが無効でした。 |
|
CHANNEL_ERROR |
string 受信側のチャンネルは利用できません。 |
|
LOAD_MEDIA_FAILED |
string メディアを読み込めませんでした。 |
isAvailable
boolean
API が読み込まれているかどうかを確認するクライアント用のフラグ。
ReceiverAction
string
ユーザーが拡張機能のレシーバーに対して実行できる操作。これを使用して、キャスト アクションが完全に完了（または失敗）する前に、送信側のアプリの UI に遷移を表示できます。
値 |
|
|---|---|
|
CAST |
string ユーザーが送信側アプリでレシーバをキャストするつもりで選択した。受取人の正確な身元が不明な場合があります。 |
|
停止 |
string ユーザーがレシーバーで実行中のセッションの停止をリクエストしました。 |
ReceiverAvailability
string
キャスト レシーバーの提供状況について説明します。
値 |
|
|---|---|
|
利用可能 |
string セッション リクエストと互換性のあるレシーバーが少なくとも 1 つ利用できる。 |
|
UNAVAILABLE |
string 利用できるレシーバーがありません。 |
ReceiverType
string
値 |
|
|---|---|
|
CAST |
string キャスト レシーバー（Chromecast など） |
|
DIAL |
string ダイヤル デバイス（スマートテレビなど） |
|
ハングアウト |
string ブラブラ |
|
カスタム |
string クライアントが提供するカスタム レシーバー |
SenderPlatform
string
送信側アプリケーション プラットフォームを記述します。
値 |
|
|---|---|
|
Chrome |
string |
|
iOS |
string |
|
ANDROID |
string |
SessionStatus
string
キャスト セッションのステータスをレシーバー アプリに通知します。
値 |
|
|---|---|
|
統合期 |
string セッションが受信側アプリケーションに接続されます。 |
|
接続解除 |
string セッションが受信側アプリケーションから切断されます。受信側アプリはまだ実行中の場合と実行されていない場合があります。 |
|
停止 |
string 受信側アプリケーションが停止しました。 |
timeout
非 null chrome.cast.Timeout
API メソッドのデフォルトのタイムアウト値（ミリ秒単位）。
バージョン
null 以外の数値の配列
API のバージョン。最初の数字はメジャー バージョン、2 番目の数字はマイナー バージョンです。
VolumeControlType
string
音量調整の種類について説明します。
値 |
|
|---|---|
|
減衰 |
string キャスト デバイスの音量は変更できます。 |
|
修正済み |
string キャスト デバイスの音量は固定されており、変更できません。 |
|
マスター |
string マスター システムの音量調節（テレビやオーディオ機器の音量の変更など） |
Methods
addReceiverActionListener
addReceiverActionListener(listener)
ユーザーが UI からキャストを開始または停止したときに呼び出されるリスナー関数を追加します。送信側アプリは、これを使用して、キャスト アクションが完了または失敗する前に、ユーザー インターフェースに遷移を表示できます（つまり、ローカルで再生中のメディアを一時停止します）。
- リスナーが呼び出される保証はありません。アプリがこのリスナーに依存して正しく機能しないようにする必要があります。
- 操作が行われたレシーバがリスナーに渡されます（利用可能な場合）。ただし、レシーバーが不明な場合があり、代わりに null が渡されます。
- リスナーは、ユーザーが操作するとすぐに呼び出されます。このメソッドは、状態の変化が API を通じて通知される前に呼び出す必要があります。
Framework API を使用している場合は、代わりに cast.framework.CastContext#addEventListener を使用し、cast.framework.CastContextEventType#CAST_STATE_CHANGED イベントをリッスンします。
パラメータ |
|
|---|---|
|
リスナー |
chrome.cast.ReceiverActionListener 追加するリスナー関数。リスナーの最初の引数は、操作されたレシーバです。リスナーの 2 つ目の引数は、リクエストされたアクションです（chrome.cast.ReceiverAction をご覧ください）。 値を null にすることはできません。 |
initialize
初期化(apiConfig, successCallback, errorCallback)
API を初期化します。SuccessCallback と errorCallback は、API の初期化が完了すると呼び出されます。sessionListener と receiveListener は後からいつでも呼び出すことができ、複数回呼び出すこともできます。
Framework API を使用している場合は、この関数の代わりに cast.framework.CastContext#setOptions を使用します。
パラメータ |
|
|---|---|
|
apiConfig |
API を初期化するためのパラメータを含むオブジェクト。 値を null にすることはできません。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING です。 |
logMessage
logMessage(message)
アプリからのデバッグ メッセージを記録します。ユーザーが詳細なログを含めることを明示的に選択した場合、このメッセージは、フィードバック レポートとして Google に送信されることがあります。
パラメータ |
|
|---|---|
|
message |
string 記録するメッセージ。 |
- 非推奨
- Presentation API ベースの Cast SDK ではサポートされていません。
プリキャッシュ
precache(data)
データを事前キャッシュするリクエストを送信します。セッションが接続されている場合は、直接リクエストが送信されます。それ以外の場合は、ネットワーク上のすべてのデバイスに送信されます。
パラメータ |
|
|---|---|
|
data |
string プリキャッシュするデータ。 |
- 非推奨
- サポートされていません。
removeReceiverActionListener
removeReceiverActionListener(listener)
以前に addReceiverActionListener で追加されたリスナー関数を削除します。
パラメータ |
|
|---|---|
|
リスナー |
chrome.cast.ReceiverActionListener 削除するリスナー関数。 値を null にすることはできません。 |
requestSession
requestSession(successCallback, errorCallback, sessionRequest)
レシーバー アプリケーション セッションの作成または参加をリクエストします。デフォルトでは、初期化時に API に渡される SessionRequest が使用されますが、sessionRequest で別のセッション リクエストを渡すことでオーバーライドできます。
Framework API を使用している場合は、この関数の代わりに cast.framework.CastContext#requestSession を使用します。
パラメータ |
|
|---|---|
|
successCallback |
function(non-null chrome.cast.Session) |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、 SESSION_ERROR、RECEIVER_UNAVAILABLE、EXTENSION_MISSING です。 タイムアウト タイマーは、ユーザーがレシーバーを選択した後で開始されます。レシーバーの選択にはユーザーの操作が必要です。操作にはタイムアウトはありません。セッション リクエストがすでに進行中の場合、INVALID_PARAMETER エラーコードとエラーの説明とともに errorCallback が呼び出されます。 |
|
sessionRequest |
任意 値を null にすることはできません。 |
requestSessionById
requestSessionById(sessionId)
指定された ID を持つ既存のセッションへの参加をリクエストします。参加後、セッションは chrome.cast.initialize によって設定された sessionListener に渡されます。
この関数が呼び出されたときに、指定された sessionId のセッションがすでにわかっている場合は、すぐに sessionListener が呼び出されます。それ以外の場合は、指定された sessionId を持つセッションが発見されると、sessionListener が呼び出されます。
パラメータ |
|
|---|---|
|
sessionId |
string 参加するセッションの ID。 |
setCustomReceivers
setCustomReceivers(receivers, successCallback, errorCallback)
カスタム レシーバー リストを設定する
パラメータ |
|
|---|---|
|
レシーバー |
null 以外の chrome.cast.Receiver の配列。 新しいリスト。 値を null にすることはできません。 |
|
successCallback |
function() |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、EXTENSION_MISSRING です。 |
- 非推奨
- Presentation API ベースの Cast SDK ではサポートされていません。
setPageContext
setPageContext(win)
iframe 内で Cast SDK を読み込むページのキャスト機能を初期化します。 SDK の初期化後に呼び出す必要があります。
パラメータ |
|
|---|---|
|
勝ち |
ウィンドウ ページ ウィンドウ オブジェクト。 値を null にすることはできません。 |
setReceiverDisplayStatus
setReceiverDisplayStatus(receiver, successCallback, errorCallback)
レシーバー名と表示ステータスを設定します。レシーバーをアイドル状態として表示するには、displayStatus を null に設定します。
CUSTOM レシーバーに対してのみ有効です。このレシーバが CAST の場合、レシーバの displayStatus は無視されます。キャスト レシーバのステータスはレシーバ アプリによって更新されます。
パラメータ |
|
|---|---|
|
レシーバー |
レシーバー。 値を null にすることはできません。 |
|
successCallback |
function() ステータスが正常に設定されたときのコールバック。 |
|
errorCallback |
function(non-null chrome.cast.Error) 発生する可能性のあるエラーは、TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、EXTENSION_MISSING です。 |
- 非推奨
- Presentation API ベースの Cast SDK ではサポートされていません。
unescape
unEsc(escaped) が文字列を返す
URI でエスケープされた文字列のエスケープを解除するユーティリティ メソッド。たとえば、レシーバーにわかりやすい名前は、URI エスケープされた文字列として返されます。必要に応じて、このメソッドを使用してその文字列のエスケープを解除します。
パラメータ |
|
|---|---|
|
エスケープ |
string エスケープを解除する文字列 |
- 戻り値
-
stringエスケープされていない文字列
抽象型
ReceiverActionListener
ReceiverActionListener()