- コンテンツランチャーAPI
- VegaメディアコントロールAPI
- アカウントログインAPI
Vegaメディアコンテンツランチャーの一般的なユースケース
VegaメディアコンテンツランチャーAPIの使用を開始するには、以下の手順を実行します。- 新しい
ContentLauncherServerComponentをインスタンス化します。コールバック関数をカプセル化するハンドラーオブジェクトを作成します。この関数は、ContentLauncherServerComponentインスタンスを使用して作成されたPromiseをILauncherResponseに返す必要があります。検索パラメーターを取得する方法については、このガイド内で後述します。コールバック関数では以下を行う必要があります。- コンテンツの起動リクエストを処理します。
LauncherResponseに適切なステータスを設定します。- リクエストが正常に処理された場合:
ContentLauncherStatusType.SUCCESS - 権限の問題により処理が妨げられる場合:
ContentLauncherStatusType.AUTH_FAILED - その他すべてのシナリオの場合:
ContentLauncherStatusType.URL_NOT_AVAILABLE
- リクエストが正常に処理された場合:
コンテンツランチャーAPIの実装
-
コンテンツランチャーハンドラーを定義します。
新しい
ContentLauncherServerComponentをインスタンス化します。コールバック関数をカプセル化するハンドラーオブジェクトを作成します。ハンドラーはリクエストを処理し、PromiseをILauncherResponseに返して、ContentLauncherServerComponentのインスタンスを使用してPromiseを作成する必要があります。 アプリがリクエストを正常に処理した場合は、LauncherResponseのcontentLauncherStatusのステータスをContentLauncherStatusType.SUCCESSに設定します。認証の問題が原因でアプリがリクエストを処理できない場合は、ステータスをContentLauncherStatusType.AUTH_FAILEDに設定します。それ以外の場合は、ステータスをContentLauncherStatusType.URL_NOT_AVAILABLEに設定します。 -
対話型アプリにVegaメディアコンテンツランチャーを実装します。
IContentLauncherServerAsyncのシングルトンインスタンスを取得します。ContentLauncherServerComponentインスタンスでgetOrMakeServerメソッドを使用してIContentLauncherServerAsyncを実装します。- コンテンツ起動リクエストを処理するために、
IContentLauncherHandlerインターフェイスを実装するハンドラーオブジェクトを作成します。 - IContentLauncherServerAsyncインスタンスのsetHandlerForComponentメソッドを呼び出します。これにより、ハンドラーが正しいコンポーネントに関連付けられます。
- ハンドラーと適切な
IComponentInstanceを渡します。
useComponentInstanceメソッドを使用してIComponentInstanceを取得できます。React Nativeアプリの場合は、useEffectフックを使用してハンドラーを設定します。コンポーネントがマウントされ、IComponentInstanceが利用可能になったらすぐに、Content Launcherを初期化する必要があります。これにより、コンテンツランチャーの機能がコンポーネントのライフサイクルに統合され、アプリでVegaコンテンツランチャーコマンドを処理できるようになります。このセットアップでは、各コンポーネントでIComponentInstanceが使用され、コールバックルーティングの混乱を防ぐことができます。これは複数のコンポーネントを使用するアプリにとって重要です。
実装の詳細
handleLaunchContentコールバック関数には、次の3つのパラメーターがあります。IContentSearchインターフェイスを実装するオブジェクト。autoPlayというブール値。ILaunchContentOptionalFieldsインターフェイスを実装するオブジェクトとして渡される追加フィールド。
IContentLauncherHandlerハンドラーは、再生するコンテンツや検索結果に表示するコンテンツを定義するパラメーターを1つ受け取ります。
autoPlayに基づくアクションの決定
autoPlayパラメーターは、ハンドラーの動作を以下のように制御します:
autoPlayがtrueに設定されている場合: クイック再生のリクエストを示します。ユーザーに追加の操作を求めることなく、指定されたコンテンツの再生をすぐに開始する必要があります。autoPlayがfalseに設定されている場合: ハンドラーは再生を開始することなく、検索結果をユーザーに表示する必要があります。これにより、ユーザーは使用可能なオプションを確認して選択できます。
autoPlay、IContentLauncherHandlerはコンテンツの検出と再生を効率的に管理できます。
検索する値の取得
IContentSearchパラメーターには、検索対象のコンテンツ情報が格納されています。次のスキーマは、IContentSearchに格納されている値用です。
parameterListには1つまたは複数のエントリがあります。contentSearch.getParameterList().lengthはパラメータの数を返します。getParameterList()を使用して完全なリストを取得します(スキーマ内の「1」の行)。- 「1.1」の行は、パラメーターにリストされているエンティティのタイプを表します。たとえば、“type”は
ContentSearchParamType::VIDEO映画やテレビ番組用です。サポートされている値の完全なセットについては、ContentSearchParamType列挙型を参照してください。getParamType()を呼び出してタイプを取得します(スキーマ内の「1.1」の行)。 - 「1.2」の行は、typeで指定されたエンティティの値を表します。このフィールドを取得するには
getValue()を呼び出します(スキーマ内の「1.2」の行)。各パラメーターには0個以上のexternalIdsが含まれます。getExternalIdList().lengthを使用してリストのサイズを取得します。getExternalIdList()は完全なリストを返します(スキーマ内の「1.3」の行)。 - は
getName()によって取得されます。スキーマ内の「1.3.1」の行で認識される2つの名前として、 amzn_id(リクエストされたコンテンツのカタログID)とlaunch_url(Matterキャストなどの外部エクスペリエンスから提供されるディープリンク文字列。再生を開始する場合に直接使用できます)があります。 - は
externalIdの値を表します。値を取得するにはgetValue()を使用します。amzn_idの場合、値はまたはと同じであり、カタログ統合で使用されます。launch_urlの場合、この値はリクエスト元のエクスペリエンスから提供された完全なディープリンクになります。
コンテンツランチャーリクエストの例
以下の例では、いくつかの主要なContent LauncherのユースケースにおけるcontentSearchパラメーター値について説明します。これらの例は、サポートされているすべてのユースケースの一覧です。どのユースケースでも、コンテンツランチャーが呼び出され、アプリが起動します。
以下はstreamz_usのサンプルカタログで、映画Seaboundとテレビ番組The SeaShowのエントリー例が含まれています: The Real Story。
リモコンによるコンテンツの起動
Vega TVのホーム画面から、リモコンを使用して映画Seaboundを起動します。tv.streamz/movie/46720000をLaunchIdとして使用して映画を特定し、直接再生する必要があります。
音声によるクイック再生
音声を使用して映画「Seabound」を再生します。「アレクサ、『Seabound』を再生して」という発話を使用します。 ここではautoPlayはtrueです。次の例にはcontentSearch: IContentSearchの値が含まれています。アプリが起動し、ID1700000725を使用してコンテンツを直接再生します。
音声による特定のエピソードの再生
以下のサンプルカタログは、TV番組「SeaShow:* The Real Story」と、そのシーズンおよびエピソードを表しています。Alexaに「アレクサ、『The SeaShow: *The Real Story』のシーズン2、エピソード5を再生して」という発話を使用すると、アプリが呼び出され、指定されたエピソードが再生されます。 ここではautoPlayはtrueです。contentSearchにはエピソードIDではなく、番組IDが含まれています。アプリは、ID 1700000123、ContentSearchParamType::SEASON、およびContentSearchParamType::EPISODEの値を使用して正確なエピソードを識別する必要があります。

