開発者コンソール

手順6: アプリの動的機能を報告する


手順6: アプリの動的機能を報告する

動的機能の統合により、ユーザーの状態(ログイン状態やサブスクリプションのレベルなど)に応じてアプリの機能を提供できます。そのため、機能を報告するためにVSK Agentとの統合が必要になります。VSK Agentとの統合を行う方法として推奨されているのは、VSK Agent Client Libraryを使用する方法です。

サンプルアプリに関する注意事項

サンプルアプリでは動的機能がレポートされるため、この手順でコーディングを行う必要はありません。詳細については、サンプルアプリのDynamicCapabilityReporterクラス、AndroidManifest.xml、VSK Agent Client Library、機能ファイル(res/rawにあります)を参照してください。

VSK Agentについて

VSK Agentは、Fire OSのオンデバイスルーティングエージェントです。Fire TV対応アプリでは、VSKAgentClientクラスを使用して、動的機能をVSK Agentにレポートします。これらの機能により、アプリにブロードキャストできるディレクティブの種類をVSK Agentに知らせることができます。VSK Agentは、Androidインターフェース定義言語(AIDL)APIを使用してFire OSとやり取りします。

VSK Agentは、アプリがサポート可能なディレクティブのみを送信します。たとえば、アプリでPlaybackControllerインターフェースをサポートできることを明示していない場合、AlexaからはPlaybackControllerディレクティブは送信されません。

VSK Agentとの統合方法の選択

VSK Agentとの統合には、次の2つの方法があります。

オプション1: VSK Agent Client Library(推奨される方法)

Amazonが提供するVSK Agent Client Libraryを使用する方法が推奨されます。VSK Agent Client Libraryを使用すると、VSK Agentのすべての機能を利用できるだけでなく、Androidのプロセス間通信(IPC)の細部を部分的に簡素化することができます。VSK Agent Client Libraryを使用すると、Fire TVのVSK Agentとの統合のために大量のコードを記述する必要性が低下します。つまり、このサービスへの接続の処理が自動で行われるようになり、通常のJavaのメソッドで呼び出しができるようになります。

VSK Agent Client Libraryを使用すると、動的な機能の追加や削除をいつでも選択的に行うことができます。将来的にアプリのUIの状態やその他の動的な状態の更新を知らせる高度な方法をサポートする予定がある場合は、このオプションを選択する必要があります。アプリでVSKの機能を有効にするには、VSK Agent Client Libraryを利用してVSK Agentと統合するのが、最も簡単で時間のかからない方法です(VSK Agent Client Libraryを使用しても、常にサポートされる機能は、静的機能の統合を行うことにより静的リソースで宣言できることに注意してください)。

VSK Agentでは、アプリの機能を動的にレポートするためのメソッドが2つ用意されています。

  • AddOrUpdateCapabilities() - サポートする機能を宣言するためのメソッドです。
  • sendCapabilityTestDirective() - 統合のテストを行うためのメソッドです。

実装の手順については、後述のオプション1の手順: VSK Agent Client Libraryを使用してVSK Agentサービスと統合するを参照してください。

オプション2: VSKApplicationAgentAPI

VSK Agentに接続するためのもう1つの方法は、サービス定義のみを使用して、この接続のコードを開発者自身で管理する方法です。VSK Agent Client Libraryは、内部でバインドされたサービスと通信します。開発者は必要に応じて、VSKApplicationAgentAPIパッケージを使用して、この内部のサービスと統合することができます。

このVSKApplicationAgentAPIパッケージには、このサービスとやり取りするために必要な.aidlファイル(Androidインターフェース定義ライブラリに含まれます)およびJavaクラスが含まれています。推奨されている方法ではありませんが、特定の状況においては、すべてのコードを開発者自身で管理した方が望ましい場合があることはAmazonでも認識しています。このような方法は、依存関係を排除するため、またはその他の要件があるために、プロジェクトでAmazonのライブラリやコードを使用したくない場合には好ましいと考えられます。

簡単な手順については、オプション2の手順: VSKApplicationAgentAPIパッケージを使用してVSK Agentと統合するを参照してください。VSKApplicationAgentAPIパッケージの詳細な使用方法については、このドキュメントでは扱いません。

オプション1の手順: VSK Agent Client Libraryを使用してVSK Agentサービスと統合する

VSK Agent Client Libraryと統合してVSK Agentと通信する場合(上記オプション1)は、次の手順を実行します。

プロジェクトへのVSK Agent Client Libraryの追加

  1. VSK Agent Client Library(AARファイル)をダウンロードします。

    VSK Agent Client Libraryをダウンロードすると、Amazonのプログラム素材ライセンス契約に同意したものと見なされます。

    (「VSK Agent Client Library」は、クラウド側の統合で使用される「Alexa Client Library」とは異なることに注意してください。)

  2. VSK Agent Client Libraryをプロジェクトに追加します。Android Studioで、[File] > [New] > [Module] の順に選択します。[Import .JAR/.AAR Package] を選択し、VSKApplicationAgentClientLibraryファイルを選択します。

  3. このAARファイルをインポートすると、Android StudioによりVSKApplicationAgentClientLibraryがsettings.gradle (Project Settings)に追加され、アプリのbuild.gradleファイルで依存関係として追加できるようになります。[Gradle Scripts] を展開し、settings.gradle (Project Settings)を開きます。次のように、VSKApplicationAgentClientLibraryがインクルードされていることを確認します。

    include ':VSKApplicationAgentClientLibrary'
    
  4. [Gradle Scripts] を展開し、build.gradle (Module: App)を開きます。次のように、VSKApplicationAgentClientLibraryの依存関係をdependenciesオブジェクトに追加します。

    dependencies {
         implementation project(path: ':VSKApplicationAgentClientLibrary')
    }
    

    VSK Agent Client Libraryは、MavenまたはJCenterでは使用できないことに注意してください。

    サンプルアプリに関する注意事項

    サンプルアプリでは、VSK Agent Client Libraryが組み込まれています。Android Studioで、[Project] ビューに切り替えて、VSKApplicationAgentClientLibraryフォルダを確認してください。

マニフェストの構成

アプリのマニフェスト(AndroidManifest.xml)には、アプリで実行されるアクティビティの宣言が記述されます。アプリのマニフェストで、次のようにパーミッションを追加して、アプリでVSK Agentとの統合ができるようにします。

 <uses-permission android:name="com.amazon.alexa.vsk_app_agent_api.permission.BIND_SERVICE_PERMISSION" />
サンプルアプリに関する注意事項

アプリのマニフェストの例については、サンプルアプリのAndroidManifest.xmlファイル(app/manifestsにあります)を参照してください。

VSK Agent Client Libraryの初期化

次の手順は、コードベース内でVSK Agent Client Libraryを初期化することです。

サンプルアプリに関する注意事項

サンプルアプリでは、この初期化はDynamicCapabilityReporterクラスで実行されます(src/java/com/example/vskfiretv/reporterを参照してください)。DynamicCapabilityReporterは、アプリでサポートする音声機能を報告するクラスです。
  1. VSK Agentクライアントの新しいインスタンスを作成します。

    public DynamicCapabilityReporter(final Context context) {
        this.context = context;
        // VSKAgentClientのインスタンスを作成します
        client = new VSKAgentClient(context);
    }
    
  2. reportDynamicCapabilities()メソッドで機能を宣言し、AddOrUpdateCapabilities()メソッドを使用して機能レポートのリクエストを行います。アプリでは、ユーザーのログイン後にこのメソッドを呼び出します。

      public void reportDynamicCapabilities() {
          // アプリでサポートする機能のリストを作成します。
          final List<AlexaCapability> supportedCapabilities = new ArrayList<>();
          supportedCapabilities.add(getAlexaCapability(R.raw.remote_video_player_capability)); // RemoteVideoPlayer機能
          // supportedCapabilities.add(getAlexaCapability(R.raw.play_back_controller_capability)); // PlaybackController機能 -- PlaybackControllerよりもMedia Sessionが推奨されているため、ここではコメントアウト
          //supportedCapabilities.add(getAlexaCapability(R.raw.channel_controller_capability)); // ChannelController機能(アプリのみの統合では未サポート)
          //supportedCapabilities.add(getAlexaCapability(R.raw.seek_controller_capability)); // SeekController機能
          //supportedCapabilities.add(getAlexaCapability(R.raw.keypad_controller_capability)); // KeypadController機能(アプリのみの統合では未サポート)
    
          // 機能レポートのリクエストを実行します
          final AddOrUpdateCapabilitiesRequest request = new AddOrUpdateCapabilitiesRequest(supportedCapabilities);
        }            
    

    Alexaは、ここに記載されている機能に関連するディレクティブを送信します。たとえば、remote_video_player_capabilityを指定した場合、AlexaはRemoteVideoPlayerインターフェースに関連するディレクティブを送信します。機能を宣言していないと、Alexaは、その機能に関連するディレクティブを送信しません。

  3. 前述のコードでは、Utils.getTextForRawResource(R.raw.remote_video_player)のようにコードでファイルを参照することにより、機能を宣言しています。上記のサンプルコード内の参照は、次のようになっています。

    アプリでサポートするインターフェースに応じて、app/res/rawに必要なファイルを作成し、これらの名前を付け、機能を宣言します。各機能のJSONオブジェクトの詳細については、アプリのみの統合でサポートされる機能を参照してください。

    サンプルアプリに関する注意事項

    サンプルアプリのapp/res/rawでこれらの機能を確認できます。必要に応じて、これらのサンプルのJSONオブジェクトを、開発するアプリにコピーすることができます。
  4. addOrUpdateCapabilities()メソッドを使用して、アプリの動的機能をVSK Agentにレポートします。

    Log.i(TAG, "動的機能をVSK Agentにレポートしています...");
    final boolean reportingStatus = client.addOrUpdateCapabilities(request);
    
    if(reportingStatus) {
        Log.i(TAG, "動的機能をVSK Agentに正常にレポートしました");
        return;
    }
    Log.e(TAG, "動的機能をVSK Agentにレポートできませんでした");
    }
    

    これで、アプリがこれらの機能をサポートしていることが、VSK Agentで認識されます。後でFire TVでアプリを実行し、ログを確認すると(手順10: 発話をテストしてログを確認する)、DynamicCapabilityReporterクラスで、これらの機能がVSK Agentにレポートされていることを確認できます。

    今後の予定: ユーザーの状態に応じたさまざまなカタログの指定

    将来的に、必要な場合は、ユーザーのサブスクリプションや状態に応じてそれぞれ異なるカタログを指定できるようになります。たとえば、1つのカタログID(例:acme_free)では無料コンテンツを提供し、別のカタログ(例:acme_premium)では有料コンテンツを提供することができます。これを実現するには、ユーザーの状態に応じて、異なる機能を報告します。

    たとえば、プレミアムレベルのサブスクリプション登録をしているユーザーの場合は、機能ファイルで別のcatalogsプロパティを指定して機能を報告することができます。これらのユーザー用には、acme_premiumが指定された機能ファイルを使用することができます。ログインしていないユーザー用には、catalogsプロパティにacme_freeを指定した機能ファイルを使用します。catalogsプロパティの詳細については、「アプリのみの統合でサポートされる機能」のRemoteVideoPlayer機能を参照してください。この機能は将来サポート予定であり、現時点ではサポートされていないことに注意してください。

動的機能を報告するためのコード例(全文)

動的機能を報告するためのコード例の全文を以下に示します。

サンプルアプリに関する注意事項

コンテキストに応じた実際の例については、サンプルアプリDynamicCapabilityReporterクラスの例を参照してください。
// -------------------------------\
// MyApplication.java
// -------------------------------/
public class MyApplication extends Application {

  private static MyApplication sTheApp;
  private VSKAgentClient client;
  private HandlerThread vskAgentThread;
  private Handler vskAgentHandler;...

  public static MyApplication getInstance() {
    return sTheApp;
  }

  @Override
  public void onCreate() {

    super.onCreate();
    //...
    vskAgentThread = new HandlerThread("VSKAgentThread");
    vskAgentThread.start()
    vskAgentHandler = new Handler(vskAgentThread.getLooper);
    client = new VSKAgentClient(this);
    reportCapabilities();
    //...
  }
  //...

  public void reportCapabilities() {
    // API呼び出しはバックグラウンドスレッドで実行する必要があります
    vskAgentHandler.post(new Runnable() {
      public void run() {
        reportCapabilitiesInternal()
      }
    });
  }

  private void reportCapabilitiesInternal() {
    // 現在のアプリの状態を基に、現在サポートされている
    // Alexaの機能を判断します。機能のJSONを動的に構築するか、
    // リソースファイルのJSONを参照することができます(ここでは後者)。
    List < AlexaCapability > supportedCapabilities = new ArrayList < >();
    if (accountManager.isLoggedIn()) supportedCapabilities.add(new AlexaCapability(Utils.getTextForRawResource(R.raw.remote_video_player)));
    //supportedCapabilities.add(new AlexaCapability(Utils.getTextForRawResource(R.raw.playback_controller)));
    if (accountManager.geteCurrentCustomer().hasSubscription(Subscription.LIVE_TV) {
      supportedCapabilities.add(new AlexaCapability(Utils.getTextForRawResource(R.raw.channel_controller)));
    }
  }

  AddOrUpdateCapabilitiesRequest request = new AddOrUpdateCapabilitiesRequest(supportedCapabilities);
  boolean success = client.addOrUpdateCapabilities(request);
  if (!success) {
    // エラー処理
  }
}

private String getTextForRawResource(int resId) {
  InputStream inputStream = getResources().openRawResource(resId);
  String line;
  StringBuilder result = new StringBuilder();

  try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
    while ((line = reader.readLine()) != null) {
      result.append(line).append('\n');
    }
    return result.toString();
  } catch(IOException e) {
    // エラー
  }

  return null;
}
}

オプション2の手順: VSKApplicationAgentAPIパッケージを使用してVSK Agentと統合する

VSKApplicationAgentAPIパッケージを使用してVSK Agentとの統合を行う(VSK Agent Client Libraryを使用しない)場合は、以下の手順を実行します。

  1. VSKApplicationAgentAPI(AARファイル)をダウンロードします。

    VSKApplicationAgentAPIをダウンロードすると、Amazonのプログラム素材ライセンス契約に同意したものと見なされます。

  2. VSKApplicationAgentAPIをプロジェクトに追加します。Android Studioで、[File] > [New] > [Module] の順に選択します。[Import .JAR/.AAR Package] を選択し、VSKApplicationAgentAPIファイルを選択します。

  3. このAARファイルをインポートすると、Android Studioによりファイルがsettings.gradle (Project Settings)に追加され、アプリのbuild.gradleファイルで依存関係として追加できるようになります。[Gradle Scripts] を展開し、settings.gradle (Project Settings)ファイルを開きます。次のように、VSKApplicationAgentAPIがインクルードされていることを確認します。

    include ':VSKApplicationAgentAPI'
    
  4. [Gradle Scripts] を展開し、build.gradle (Module: App)を開きます。次のように、VSKApplicationAgentAPIの依存関係をdependenciesオブジェクトに追加します。

    dependencies {
         implementation project(path: ':VSKApplicationAgentAPI')
    }
    
  5. アプリのマニフェストで必要なパーミッションを宣言します。
  6. アプリの作成時に、addOrUpdateCapabilities()メソッドを使用して、現在サポートされている機能を報告します。
  7. アプリの状態の変化により、サポートされる機能に変更が生じる場合は、必ずaddOrUpdateCapabilities()も呼び出します。

次のステップ

次の 手順7: BroadcastReceiverを追加するに進みます。