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