名前空間: cast

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

chrome.キャスト

namespace 静的

これは chrome.cast 名前空間です。

クラス

名前空間

列挙型

AutoJoinPolicy

静的

文字列

自動参加ポリシーでは、API の初期化後に SDK が送信者アプリケーションを既存のセッションに自動的に接続するタイミングを決定します。

値

TAB_AND_ORIGIN_SCOPED

文字列

同じ appId と同じタブとページオリジンで、セッションの開始時に自動的に接続します。

送信元の SCOPED

文字列

タブに関係なく、同じ appId と同じページオリジンでセッションが開始したときに自動的に接続します。

PAGE_SCOPED

文字列

自動接続されていません。

可能な操作

静的

文字列

受信デバイスでサポートされている機能。

値

動画出力

文字列

レシーバーは動画出力をサポートしています。

音声出力

文字列

レシーバーはオーディオ出力をサポートしています。

動画入力

文字列

レシーバーはビデオ入力（カメラ）をサポートしています。

AUDIO_IN（音声）

文字列

音声入力は音声入力（マイク）に対応しています。

MULTIZONE_GROUP

文字列

受信者はマルチゾーン グループを表します。

デフォルトのアクション ポリシー

静的

文字列

デフォルトのアクション ポリシーでは、API の初期化後に SDK がセッションを自動的に作成するタイミングを決定します。これにより、拡張機能のポップアップのタブに対するデフォルトのアクションも制御されます。

値

作成セッション

文字列

API の初期化時にアプリを含むタブがキャストされると、SDK はタブのキャストを停止し、アプリを自動的に起動します。拡張機能のポップアップには、アプリのキャストを求めるメッセージが表示されます。

CAST_THIS_TAB

文字列

タブがキャストされている場合でも、API の初期化後に自動起動は行われません。拡張機能のポップアップにより、タブをキャストするように求められます。

ダイヤルアプリの状態

静的

文字列

DIAL アプリケーションのステータス。

値

実行中

文字列

停止

文字列

エラー

文字列

仕様の一部ではなく、エラーを通知するために使用されます。

ErrorCode

静的

文字列

SDK から返される可能性があるエラー。

値

キャンセル

文字列

ユーザーが操作をキャンセルしました。

TIMEOUT

文字列

オペレーションがタイムアウトしました。

API_NOT_INITIALIZED

文字列

API が初期化されていません。

INVALID_PARAMETER

文字列

オペレーションのパラメータが無効です。

EXTENSION_NOT_COMPATIBLE（拡張不可）

文字列

API スクリプトが、インストール済みの Cast 拡張機能と互換性がない。

EXTENSION_MISSING（拡張機能の欠落）

文字列

Cast 拡張機能は利用できません。

受付不可

文字列

セッション リクエストに対応するレシーバがありませんでした。

SESSION_ERROR（セッション エラー）

文字列

セッションが作成できなかったか、セッションが無効です。

CHANNEL_ERROR（チャネルエラー）

文字列

受信側へのチャネルを利用できません。

LOAD_MEDIA_FAILED（メディアエラー）

文字列

メディアを読み込めませんでした。

受信者アクション

静的

文字列

ユーザーが拡張機能のレシーバーに対して行うことができる操作です。これらを使用して、キャスト アクションが完全に完了（または失敗）する前に、送信側アプリの UI に遷移を表示できます。

値

キャスト

文字列

ユーザーが、送信側アプリを使用してそのキャスティングするレシーバを選択しました。レシーバーの正確な ID が不明になる場合があります。

停止

文字列

ユーザーがレシーバーで実行されているセッションを停止するようリクエストしました。

受信者の可用性

静的

文字列

キャスト レシーバーの可用性を示します。

値

利用可能

文字列

セッション リクエストと互換性のあるレシーバーが少なくとも 1 つ存在する。

現在、提供していません

文字列

利用できるレシーバーがありません。

レシーバー タイプ

静的

文字列

値

キャスト

文字列

キャスト レシーバー（Chromecast など）

DIAL

文字列

DIAL 形式のデバイス（例: スマートテレビ）

ハングアウト

文字列

ブラブラ

カスタム

文字列

クライアントが提供するカスタム レシーバー

送信者プラットフォーム

静的

文字列

送信者のアプリケーション プラットフォームを表します。

値

Chrome

文字列

iOS

文字列

Android

文字列

セッションのステータス

静的

文字列

レシーバー アプリへのキャスト セッションのステータスを示します。

値

統合期

文字列

セッションは受信側アプリケーションに接続されます。

接続解除

文字列

セッションは受信側アプリと切断されます。受信者アプリがまだ実行中の場合もあれば、そうでない場合もあります。

停止

文字列

受信側アプリケーションが停止しました。

VolumeControl タイプ

静的

文字列

音量調節の種類について説明します。

値

減衰

文字列

キャスト デバイスの音量を変更できます。

FIXED

文字列

キャスト デバイスの音量は固定されており、変更できません。

マスター

文字列

マスター システムの音量コントロール（テレビやオーディオ機器の音量の変更）。

プロパティ

AutoJoinPolicy

静的

文字列

自動参加ポリシーでは、API の初期化後に SDK が送信者アプリケーションを既存のセッションに自動的に接続するタイミングを決定します。

値

TAB_AND_ORIGIN_SCOPED

文字列

同じ appId と同じタブとページオリジンで、セッションの開始時に自動的に接続します。

送信元の SCOPED

文字列

タブに関係なく、同じ appId と同じページオリジンでセッションが開始したときに自動的に接続します。

PAGE_SCOPED

文字列

自動接続されていません。

可能な操作

静的

文字列

受信デバイスでサポートされている機能。

値

動画出力

文字列

レシーバーは動画出力をサポートしています。

音声出力

文字列

レシーバーはオーディオ出力をサポートしています。

動画入力

文字列

レシーバーはビデオ入力（カメラ）をサポートしています。

AUDIO_IN（音声）

文字列

音声入力は音声入力（マイク）に対応しています。

MULTIZONE_GROUP

文字列

受信者はマルチゾーン グループを表します。

デフォルトのアクション ポリシー

静的

文字列

デフォルトのアクション ポリシーでは、API の初期化後に SDK がセッションを自動的に作成するタイミングを決定します。これにより、拡張機能のポップアップのタブに対するデフォルトのアクションも制御されます。

値

作成セッション

文字列

API の初期化時にアプリを含むタブがキャストされると、SDK はタブのキャストを停止し、アプリを自動的に起動します。拡張機能のポップアップには、アプリのキャストを求めるメッセージが表示されます。

CAST_THIS_TAB

文字列

タブがキャストされている場合でも、API の初期化後に自動起動は行われません。拡張機能のポップアップにより、タブをキャストするように求められます。

ダイヤルアプリの状態

静的

文字列

DIAL アプリケーションのステータス。

値

実行中

文字列

停止

文字列

エラー

文字列

仕様の一部ではなく、エラーを通知するために使用されます。

ErrorCode

静的

文字列

SDK から返される可能性があるエラー。

値

キャンセル

文字列

ユーザーが操作をキャンセルしました。

TIMEOUT

文字列

オペレーションがタイムアウトしました。

API_NOT_INITIALIZED

文字列

API が初期化されていません。

INVALID_PARAMETER

文字列

オペレーションのパラメータが無効です。

EXTENSION_NOT_COMPATIBLE（拡張不可）

文字列

API スクリプトが、インストール済みの Cast 拡張機能と互換性がない。

EXTENSION_MISSING（拡張機能の欠落）

文字列

Cast 拡張機能は利用できません。

受付不可

文字列

セッション リクエストに対応するレシーバがありませんでした。

SESSION_ERROR（セッション エラー）

文字列

セッションが作成できなかったか、セッションが無効です。

CHANNEL_ERROR（チャネルエラー）

文字列

受信側へのチャネルを利用できません。

LOAD_MEDIA_FAILED（メディアエラー）

文字列

メディアを読み込めませんでした。

isAvailable

静的

boolean

API が読み込まれているかどうかをクライアントが確認するためのフラグ。

受信者アクション

静的

文字列

ユーザーが拡張機能のレシーバーに対して行うことができる操作です。これらを使用して、キャスト アクションが完全に完了（または失敗）する前に、送信側アプリの UI に遷移を表示できます。

値

キャスト

文字列

ユーザーが、送信側アプリを使用してそのキャスティングするレシーバを選択しました。レシーバーの正確な ID が不明になる場合があります。

停止

文字列

ユーザーがレシーバーで実行されているセッションを停止するようリクエストしました。

受信者の可用性

静的

文字列

キャスト レシーバーの可用性を示します。

値

利用可能

文字列

セッション リクエストと互換性のあるレシーバーが少なくとも 1 つ存在する。

現在、提供していません

文字列

利用できるレシーバーがありません。

レシーバー タイプ

静的

文字列

値

キャスト

文字列

キャスト レシーバー（Chromecast など）

DIAL

文字列

DIAL 形式のデバイス（例: スマートテレビ）

ハングアウト

文字列

ブラブラ

カスタム

文字列

クライアントが提供するカスタム レシーバー

送信者プラットフォーム

静的

文字列

送信者のアプリケーション プラットフォームを表します。

値

Chrome

文字列

iOS

文字列

Android

文字列

セッションのステータス

静的

文字列

レシーバー アプリへのキャスト セッションのステータスを示します。

値

統合期

文字列

セッションは受信側アプリケーションに接続されます。

接続解除

文字列

セッションは受信側アプリと切断されます。受信者アプリがまだ実行中の場合もあれば、そうでない場合もあります。

停止

文字列

受信側アプリケーションが停止しました。

timeout

静的

null 以外の chrome.cast.Timeout

API メソッドのデフォルトのタイムアウト値（ミリ秒）。

バージョン

定数 静的

null 以外の数値の配列

API バージョン。1 つ目がメジャー バージョン、2 つ目がマイナー バージョンです。

VolumeControl タイプ

静的

文字列

音量調節の種類について説明します。

値

減衰

文字列

キャスト デバイスの音量を変更できます。

FIXED

文字列

キャスト デバイスの音量は固定されており、変更できません。

マスター

文字列

マスター システムの音量コントロール（テレビやオーディオ機器の音量の変更）。

Methods

addReceiverActionListener

静的

addReceiverActionListener（リスナー）

ユーザーがキャストを開始または停止するために UI を操作したときに呼び出されるリスナー関数を追加します。送信側アプリは、これを使用して、キャスト アクションが完了または失敗する前に、ユーザー インターフェースの遷移を表示します（つまり、ローカルで再生中のメディアを一時停止します）。

  • リスナーは必ず呼び出されるとは限りません。また、リスナーが正常に機能するためには、リスナーに依存しないでください。
  • リスナーは、操作を受けたレシーバーが渡されます（利用可能な場合）。ただし、レシーバーが不明な場合があり、代わりに null が渡されます。
  • ユーザーが操作を行ったら、できるだけ早くリスナーが呼び出されます。これは、API を介して結果の状態変化がアプリに通知される前に呼び出す必要があります。

フレームワーク 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 は、後でいつでも呼び出すことができます。場合によっては複数回呼び出すこともできます。

フレームワーク API を使用している場合は、この関数の代わりに cast.framework.CastContext#setOptions を使用してください。

パラメータ

apiConfig

chrome.cast.ApiConfig

API を初期化するパラメータを持つオブジェクト。

値を null にすることはできません。

successCallback

function()

errorCallback

function（null 以外の chrome.cast.Error）

考えられるエラーは、TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING です。

logMessage

静的

logMessage（メッセージ）

アプリからデバッグ メッセージをログに記録します。ユーザーが明示的にログを含めるよう選択した場合は、このメッセージが Google に送信される場合があります。

パラメータ

メッセージ

文字列

ログに記録するメッセージ。
非推奨
プレゼンテーション API ベースの Cast SDK ではサポートされていません。

プレキャッシュ

静的

precache(data)

データの事前キャッシュ保存リクエストを送信します。セッションが接続されると、直接リクエストが送信されます。それ以外の場合、セッションはネットワーク内のすべてのデバイスに送信されます。

パラメータ

サポート

文字列

プリキャッシュするデータ。

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

function（null 以外の chrome.cast.Error）

考えられるエラーは、TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESSION_ERROR、RECEIVER_UNAVAILABLE、EXTENSION_MISSING です。タイムアウト タイマーは、ユーザーがレシーバーを選択した後、開始されます。レシーバーを選択するには、ユーザーの操作が必要ですが、タイムアウトはありません。セッション リクエストがすでに進行中の場合、ErrorCallback は、INVALID_PARAMETER エラーコードとエラーの説明とともに呼び出されます。

sessionRequest

任意

chrome.cast.SessionRequest

値を null にすることはできません。

requestSessionById

静的

requestSessionById（sessionId）

指定された ID の既存のセッションに参加するためのリクエスト。参加すると、セッションは chrome.cast.initialize によって設定された sessionListener に渡されます。

この関数が呼び出されたときに、指定した sessionId のセッションがすでにわかっている場合は、直ちに sessionListener が呼び出されます。それ以外の場合は、指定された sessionId のセッションが検出されると、sessionListener が呼び出されます。

パラメータ

sessionId

文字列

参加するセッションの ID。

setCustomReceiver

静的

setCustomReceivers（レシーバー、successCallback、errorCallback）

カスタム レシーバー リストを設定します

パラメータ

レシーバー

null 以外の chrome.cast.Receiver の配列

新しいリスト。

値を null にすることはできません。

successCallback

function()

errorCallback

function（null 以外の chrome.cast.Error）

考えられるエラーは、TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR、EXTENSION_MISSRING です。
非推奨
プレゼンテーション API ベースの Cast SDK ではサポートされていません。

setPageContext

静的

setPageContext（win）

iframe に Cast SDK を読み込むページの Cast 機能を初期化します。 SDK の初期化後に呼び出す必要があります。

パラメータ

勝ち

ウィンドウ

ページ ウィンドウ オブジェクト。

値を null にすることはできません。

setReceiverDisplayStatus

静的

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

レシーバー名と表示ステータスを設定します。レシーバーをアイドル状態を表示するには、displayStatus を null に設定します。

CUSTOM レシーバーでのみ有効です。このレシーバーが CAST の場合、レシーバーの displayStatus は無視されます。キャスト レシーバーのステータスは、レシーバー アプリによって更新されます。

パラメータ

レシーバー

chrome.cast.Receiver

受信者。

値を null にすることはできません。

successCallback

function()

ステータスの設定が成功した場合のコールバック。

errorCallback

function（null 以外の chrome.cast.Error）

考えられるエラーは、TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、EXTENSION_MISSING です。
非推奨
プレゼンテーション API ベースの Cast SDK ではサポートされていません。

エスケープなし（# など適宜文脈に応じて）

静的

unescaped(escaped) は文字列を返します。

URI エスケープ文字列のエスケープを解除するユーティリティ メソッド。たとえば、レシーバにとってわかりやすい名前は URI エスケープ文字列として返されます。必要に応じて、このメソッドを使用してその文字列のエスケープを解除します。

パラメータ

エスケープ

文字列

エスケープ解除する文字列
戻り値

string エスケープなしの文字列

抽象型

受信者アクション リスナー

静的

ReceiverActionListener()