自動車向けメディアアプリを作成する

Android Auto と Android Automotive OS は、メディアアプリのコンテンツを自動車に乗っているユーザーに届けます。自動車向けメディアアプリは、Android Auto と Android Automotive OS、またはメディアブラウザ機能を持つ別のアプリがコンテンツを見つけて表示できるよう、メディアブラウザサービスを提供する必要があります。

このガイドは、音声を再生するメディアアプリがスマートフォンにすでにインストールされており、そのメディアアプリが Android メディアアプリアーキテクチャに準拠していることを前提としています。

このガイドでは、アプリが Android Auto または Android Automotive OS 上で動作するうえで必須のコンポーネントである MediaBrowserService と MediaSession について説明します。核となるメディアインフラストラクチャが完成すると、Android Auto のサポートおよび Android Automotive OS のサポートをメディアアプリに追加できるようになります。

始める前に

Android メディア API のドキュメントを確認してください。
Android Automotive OS アプリの設計ガイドラインと Android Auto アプリの設計ガイドラインを確認してください。
このセクションに記載されている主な用語と概念を確認してください。

主な用語と概念

メディアブラウザサービス

MediaBrowserServiceCompat API に準拠するメディアアプリによって実装される Android サービス。アプリはこのサービスを使用してコンテンツを公開します。

メディアブラウザ

メディアブラウザサービスを見つけてコンテンツを表示するためにメディアアプリで使用される API。Android Auto と Android Automotive OS は、アプリのメディアブラウザサービスを見つけるためにメディアブラウザを使用します。

メディアアイテム

メディアブラウザはそのコンテンツを MediaItem オブジェクトのツリーにまとめます。メディアアイテムには、次のフラグのいずれかまたは両方を含めることができます。

FLAG_PLAYABLE: アイテムがコンテンツツリーのリーフであることを示します。アイテムは、単一のサウンドストリーム（アルバムの曲、オーディオブックのチャプター、ポッドキャストのエピソードなど）を表します。
FLAG_BROWSABLE: アイテムがコンテンツツリーのノードであり、子があることを示します（たとえば、アイテムがアルバムを表し、その子がアルバムの曲である場合など）。

ブラウズと再生の両方が可能なメディアアイテムは、プレイリストのような役割を果たします。アイテム自体を選択してそのすべての子を再生することも、アイテムの子をブラウズすることもできます。

自動車向け最適化

Android Automotive OS 設計ガイドラインに従った Android Automotive OS アプリのアクティビティ。このアクティビティのインターフェースは Android Automotive OS によって描画されないため、アプリが設計ガイドラインに従うように注意する必要があります。設計ガイドラインには通常、タップターゲットとフォントサイズを大きくする、日中モードと夜間モードをサポートする、コントラスト比を大きくする、といったものがあります。

自動車向けに最適化されたユーザーインターフェースは、自動車ユーザーエクスペリエンス制限（CUXR）が作動中でない場合にのみ表示できます。これらのインターフェースがユーザーに対して、長時間の注意や対話を求めることがあるためです。CUXR は、車が停止または駐車しているときは作動しませんが、車が動いているときは常に作動しています。

Android Auto はメディアブラウザサービスからの情報を使用して、独自の自動車向け最適化インターフェースを描画するため、Android Auto 用のアクティビティを設計する必要はありません。

アプリのマニフェストファイルを構成する

メディアブラウザサービスを作成するには、アプリのマニフェストファイルを事前に構成しておく必要があります。

メディアブラウザサービスを宣言する

Android Auto と Android Automotive OS はどちらも、メディアアイテムをブラウズするために、メディアブラウザサービスを介してアプリに接続します。マニフェストでメディアブラウザサービスを宣言し、Android Auto と Android Automotive OS がサービスを検出してアプリに接続できるようにします。

次のコードスニペットは、マニフェストでメディアブラウザサービスを宣言する方法を示しています。このコードは、Android Automotive OS モジュールのマニフェストファイルと、スマートフォンアプリのマニフェストファイルに追加する必要があります。

<application>
    ...
    <service android:name=".MyMediaBrowserService"
             android:exported="true">
        <intent-filter>
            <action android:name="android.media.browse.MediaBrowserService"/>
        </intent-filter>
    </service>
    ...
</application>

アプリアイコンを指定する

Android Auto と Android Automotive OS がシステム UI でアプリを表示するためのアプリアイコンを指定する必要があります。次の 2 つのアイコンタイプが必要です。

ランチャーアイコン
アトリビューションアイコン

ランチャーアイコン

ランチャーアイコンは、ランチャーやアイコンのトレイなどのシステム UI で、アプリを表すアイコンです。次のマニフェスト宣言を使用することで、モバイルアプリのアイコンを使用して自動車メディアアプリを表すように指定できます。

<application
    ...
    android:icon="@mipmap/ic_launcher"
    ...
/>

モバイルアプリとは異なるアイコンを使用するには、マニフェストでメディアブラウザサービスの <service> 要素に android:icon プロパティを設定します。

<application>
    ...
    <service
        ...
        android:icon="@mipmap/auto_launcher"
        ...
    />
</application>

アトリビューションアイコン

図 1. メディアカードのアトリビューションアイコン。

アトリビューションアイコンは、メディアカードなど、メディアコンテンツが優先される場所で使用されます。通知用の小さなアイコンを再利用することを検討してください。このアイコンはモノクロにする必要があります。次のマニフェスト宣言を使用して、アプリを表すために使用するアイコンを指定できます。

<application>
    ...
    <meta-data
        android:name="androidx.car.app.TintableAttributionIcon"
        android:resource="@drawable/ic_status_icon" />
    ...
</application>

メディアブラウザサービスを作成する

メディアブラウザサービスを作成するには、MediaBrowserServiceCompat クラスを拡張します。これにより、Android Auto と Android Automotive OS の両方で、サービスを使用して次の処理を実行できます。

アプリのコンテンツ階層を参照して、ユーザーにメニューを表示する。
アプリの MediaSessionCompat オブジェクトのトークンを取得して、音声の再生を制御する。

メディアブラウザサービスを使用して、他のクライアントがアプリからメディアコンテンツにアクセスできるようにすることも可能です。このメディアクライアントは、ユーザーのスマートフォン上の他のアプリでも、他のリモートクライアントでもかまいません。

メディアブラウザサービスのワークフロー

このセクションでは、一般的なユーザーワークフローで Android Automotive OS と Android Auto がメディアブラウザサービスと対話する仕組みについて説明します。

ユーザーが Android Automotive OS または Android Auto でアプリを起動します。
Android Automotive OS または Android Auto は、onCreate() メソッドを使用してアプリのメディアブラウザサービスにコンタクトします。onCreate() メソッドの実装では、MediaSessionCompat オブジェクトとそのコールバックオブジェクトを作成して登録する必要があります。
Android Automotive OS または Android Auto は、サービスの onGetRoot() メソッドを呼び出して、コンテンツ階層のルートのメディアアイテムを取得します。ルートのメディアアイテムは表示されませんが、アプリからより多くのコンテンツを取得するために使用されます。
Android Automotive OS または Android Auto は、サービスの onLoadChildren() メソッドを呼び出して、ルートのメディアアイテムの子を取得します。Android Automotive OS と Android Auto は、これらのメディアアイテムを最上位のコンテンツアイテムとして表示します。このレベルでシステムが表示するコンテンツについて詳しくは、このページのルートメニューを構造化するをご覧ください。
ユーザーがブラウズ可能なメディアアイテムを選択すると、サービスの onLoadChildren() メソッドが再度呼び出され、選択されたメニューアイテムの子が取得されます。
ユーザーが再生可能なメディアアイテムを選択すると、Android Automotive OS または Android Auto は、適切なメディアセッションコールバックメソッドを呼び出して、その操作を実行します。
アプリでサポートされていれば、ユーザーはコンテンツを検索することもできます。この場合、Android Automotive OS または Android Auto は、サービスの onSearch() メソッドを呼び出します。

コンテンツ階層を構築する

Android Auto と Android Automotive OS は、アプリのメディアブラウザサービスを呼び出して、利用可能なコンテンツを見つけます。これをサポートするには、メディアブラウザサービスに onGetRoot() と onLoadChildren() の 2 つのメソッドを実装する必要があります。

onGetRoot を実装する

サービスの onGetRoot() メソッドは、コンテンツ階層のルートノードに関する情報を返します。Android Auto と Android Automotive OS はこのルートノードを使用して、onLoadChildren() メソッドで残りのコンテンツをリクエストします。

次のコードスニペットは、onGetRoot() メソッドの単純な実装を示しています。

Kotlin

override fun onGetRoot(
    clientPackageName: String,
    clientUid: Int,
    rootHints: Bundle?
): BrowserRoot? =
    // Verify that the specified package is allowed to access your
    // content. You'll need to write your own logic to do this.
    if (!isValid(clientPackageName, clientUid)) {
        // If the request comes from an untrusted package, return null.
        // No further calls will be made to other media browsing methods.

        null
    } else MediaBrowserServiceCompat.BrowserRoot(MY_MEDIA_ROOT_ID, null)

Java

@Override
public BrowserRoot onGetRoot(String clientPackageName, int clientUid,
    Bundle rootHints) {

    // Verify that the specified package is allowed to access your
    // content. You'll need to write your own logic to do this.
    if (!isValid(clientPackageName, clientUid)) {
        // If the request comes from an untrusted package, return null.
        // No further calls will be made to other media browsing methods.

        return null;
    }

    return new MediaBrowserServiceCompat.BrowserRoot(MY_MEDIA_ROOT_ID, null);
}

このメソッドの詳細な例については、GitHub の Universal Android Music Player サンプルアプリの onGetRoot() メソッドをご覧ください。

onGetRoot() のパッケージ検証を追加する

サービスの onGetRoot() メソッドが呼び出されると、呼び出し元のパッケージは識別情報をサービスに渡します。サービスはこの情報を使用して、そのパッケージがコンテンツにアクセスできるかどうかを判断できます。たとえば、clientPackageName を許可リストと照合して、パッケージの APK の署名に使用される証明書を確認することにより、アプリのコンテンツへのアクセスを承認されたパッケージのリストに限定できます。パッケージを検証できない場合は、null を返してコンテンツへのアクセスを拒否します。

システムアプリ（Android Auto や Android Automotive OS など）にコンテンツへのアクセスを許可するには、システムアプリが onGetRoot() メソッドを呼び出すときに、常にサービスが null でない BrowserRoot を返す必要があります。Android Automotive OS システムアプリの署名は自動車のメーカーやモデルによって異なる可能性があるため、確実に Android Automotive OS をサポートできるように、すべてのシステムアプリからの接続を許可する必要があります。

次のコードスニペットは、呼び出し元のパッケージがシステムアプリであることをサービスが検証する方法を示しています。

fun isKnownCaller(
    callingPackage: String,
    callingUid: Int
): Boolean {
    ...
    val isCallerKnown = when {
       // If the system is making the call, allow it.
       callingUid == Process.SYSTEM_UID -> true
       // If the app was signed by the same certificate as the platform
       // itself, also allow it.
       callerSignature == platformSignature -> true
       // ... more cases
    }
    return isCallerKnown
}

このコードスニペットは、GitHub の Universal Android Music Player サンプルアプリの PackageValidator クラスからの抜粋です。サービスの onGetRoot() メソッドのパッケージ検証を実装する方法の詳細な例については、このクラスを参照してください。

システムアプリを許可するだけでなく、Google アシスタントが MediaBrowserService に接続できるようにする必要もあります。Google アシスタントには、スマートフォン（Android Auto を含む）用と Android Automotive OS 用の個別のパッケージ名があります。

onLoadChildren() を実装する

Android Auto と Android Automotive OS は、ルートノードのオブジェクトを受け取った後、そのオブジェクトで onLoadChildren() を呼び出してその子を取得することにより、最上位メニューを構築します。クライアントアプリは、子ノードのオブジェクトを使用してこの同じメソッドを呼び出すことにより、サブメニューを構築します。

コンテンツ階層の各ノードは、MediaBrowserCompat.MediaItem オブジェクトで表されます。これらの各メディアアイテムは、一意の ID 文字列によって識別されます。クライアントアプリは、このような ID 文字列を不透明なトークンとして扱います。クライアントアプリがサブメニューのブラウズまたはメディアアイテムの再生を行いたいときは、トークンを渡します。トークンを適切なメディアアイテムに関連付ける処理はアプリが行います。

次のコードスニペットは、onLoadChildren() メソッドの単純な実装を示しています。

Kotlin

override fun onLoadChildren(
    parentMediaId: String,
    result: Result<List<MediaBrowserCompat.MediaItem>>
) {
    // Assume for example that the music catalog is already loaded/cached.

    val mediaItems: MutableList<MediaBrowserCompat.MediaItem> = mutableListOf()

    // Check whether this is the root menu:
    if (MY_MEDIA_ROOT_ID == parentMediaId) {

        // Build the MediaItem objects for the top level
        // and put them in the mediaItems list.
    } else {

        // Examine the passed parentMediaId to see which submenu we're at
        // and put the children of that menu in the mediaItems list.
    }
    result.sendResult(mediaItems)
}

Java

@Override
public void onLoadChildren(final String parentMediaId,
    final Result<List<MediaBrowserCompat.MediaItem>> result) {

    // Assume for example that the music catalog is already loaded/cached.

    List<MediaBrowserCompat.MediaItem> mediaItems = new ArrayList<>();

    // Check whether this is the root menu:
    if (MY_MEDIA_ROOT_ID.equals(parentMediaId)) {

        // Build the MediaItem objects for the top level
        // and put them in the mediaItems list.
    } else {

        // Examine the passed parentMediaId to see which submenu we're at
        // and put the children of that menu in the mediaItems list.
    }
    result.sendResult(mediaItems);
}

このメソッドの完全な例については、GitHub の Universal Android Music Player サンプルアプリの onLoadChildren() メソッドをご覧ください。

図 2. ナビゲーションタブとして表示されるルートコンテンツ。

Android Auto と Android Automotive OS には、ルートメニューの構造に関する特定の制約があります。これらの制約はルートヒントを介して MediaBrowserService に伝えられます。ルートヒントは、onGetRoot() に渡される Bundle 引数を介して読み取ることができます。これらのヒントに従うことで、システムはルートコンテンツをナビゲーションタブとして最適に表示できます。これらのヒントに従わないと、一部のルートコンテンツが破棄されたり、システムによって検出されにくくなったりすることがあります。次の 2 つのヒントが送信されます。

ルートの子の上限数: ほとんどの場合、この数は 4 になります。つまり、5 つ以上のタブを表示することはできません。
ルートの子でサポートされるフラグ: この値は MediaItem#FLAG_BROWSABLE になります。つまり、ブラウズ可能なアイテムのみをタブとして表示できます。再生可能なアイテムを表示することはできません。

関連するルートヒントを読み取るには、次のコードを使用します。

Kotlin

import androidx.media.utils.MediaConstants

// Later, in your MediaBrowserServiceCompat.
override fun onGetRoot(
    clientPackageName: String,
    clientUid: Int,
    rootHints: Bundle
): BrowserRoot {

  val maximumRootChildLimit = rootHints.getInt(
      MediaConstants.BROWSER_ROOT_HINTS_KEY_ROOT_CHILDREN_LIMIT,
      /* defaultValue= */ 4)
  val supportedRootChildFlags = rootHints.getInt(
      MediaConstants.BROWSER_ROOT_HINTS_KEY_ROOT_CHILDREN_SUPPORTED_FLAGS,
      /* defaultValue= */ MediaItem.FLAG_BROWSABLE)

  // Rest of method...
}

Java

import androidx.media.utils.MediaConstants;

// Later, in your MediaBrowserServiceCompat.
@Override
public BrowserRoot onGetRoot(
    String clientPackageName, int clientUid, Bundle rootHints) {

    int maximumRootChildLimit = rootHints.getInt(
        MediaConstants.BROWSER_ROOT_HINTS_KEY_ROOT_CHILDREN_LIMIT,
        /* defaultValue= */ 4);
    int supportedRootChildFlags = rootHints.getInt(
        MediaConstants.BROWSER_ROOT_HINTS_KEY_ROOT_CHILDREN_SUPPORTED_FLAGS,
        /* defaultValue= */ MediaItem.FLAG_BROWSABLE);

    // Rest of method...
}

特に、階層の値が Android Auto と Android Automotive OS の外部の MediaBrowser 統合によって異なる場合に、これらのヒントの値に基づいてコンテンツ階層の構造のロジックを分岐することもできます。たとえば、ルートの再生可能なアイテムを通常どおり表示する場合、サポートされるフラグヒントの値に従って、ルートのブラウズ可能なアイテムの下にネストできます。

タブを適切に表示するには、ルートヒントとは別に次のガイドラインにも従う必要があります。

各タブアイテムに、モノクロのアイコン（白を推奨）を付けます。
各タブアイテムに、簡潔でわかりやすいラベルを付けます。ラベルを短くすることにより、文字列が切り捨てられる可能性が低くなります。

メディアのアートワークを表示する

メディアアイテムのアートワークは、ContentResolver.SCHEME_CONTENT または ContentResolver.SCHEME_ANDROID_RESOURCE を使用してローカル URI として渡す必要があります。このローカル URI は、アプリのリソースでビットマップまたはベクター型ドローアブルに解決される必要があります。コンテンツ階層内のアイテムを表す MediaDescriptionCompat オブジェクトの場合は、setIconUri() を介して URI を渡します。現在再生中のアイテムを表す MediaMetadataCompat オブジェクトの場合は、putString() を介して、次のいずれかのキーを使用して URI を渡します。

ウェブ URI からアートをダウンロードして、ローカル URI で公開する手順は次のとおりです。より詳細な例については、openFile() の実装と Universal Android Music Player サンプルアプリの関連メソッドをご覧ください。

ウェブ URI に対応する content:// URI を作成します。メディアブラウザサービスとメディアセッションは、このコンテンツ URI を Android Auto と Android Automotive OS に渡します。

Kotlin

fun Uri.asAlbumArtContentURI(): Uri {
  return Uri.Builder()
    .scheme(ContentResolver.SCHEME_CONTENT)
    .authority(CONTENT_PROVIDER_AUTHORITY)
    .appendPath(this.getPath()) // Make sure you trust the URI
    .build()
}

Java

public static Uri asAlbumArtContentURI(Uri webUri) {
  return new Uri.Builder()
    .scheme(ContentResolver.SCHEME_CONTENT)
    .authority(CONTENT_PROVIDER_AUTHORITY)
    .appendPath(webUri.getPath()) // Make sure you trust the URI!
    .build();
}

ContentProvider.openFile() の実装で、対応する URI のファイルが存在するかどうかを確認します。存在しない場合、画像ファイルをダウンロードしてキャッシュに保存します。次のコードスニペットでは Glide を使用しています。

Kotlin

override fun openFile(uri: Uri, mode: String): ParcelFileDescriptor? {
  val context = this.context ?: return null
  val file = File(context.cacheDir, uri.path)
  if (!file.exists()) {
    val remoteUri = Uri.Builder()
        .scheme("https")
        .authority("my-image-site")
        .appendPath(uri.path)
        .build()
    val cacheFile = Glide.with(context)
        .asFile()
        .load(remoteUri)
        .submit()
        .get(DOWNLOAD_TIMEOUT_SECONDS, TimeUnit.SECONDS)

    cacheFile.renameTo(file)
    file = cacheFile
  }
  return ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY)
}

Java

@Nullable
@Override
public ParcelFileDescriptor openFile(@NonNull Uri uri, @NonNull String mode)
    throws FileNotFoundException {
  Context context = this.getContext();
  File file = new File(context.getCacheDir(), uri.getPath());
  if (!file.exists()) {
    Uri remoteUri = new Uri.Builder()
        .scheme("https")
        .authority("my-image-site")
        .appendPath(uri.getPath())
        .build();
    File cacheFile = Glide.with(context)
        .asFile()
        .load(remoteUri)
        .submit()
        .get(DOWNLOAD_TIMEOUT_SECONDS, TimeUnit.SECONDS);

    cacheFile.renameTo(file);
    file = cacheFile;
  }
  return ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY);
}

コンテンツプロバイダについて詳しくは、コンテンツプロバイダの作成をご覧ください。

コンテンツスタイルを適用する

ブラウズ可能または再生可能なアイテムでコンテンツ階層を構築した後、コンテンツスタイルを適用できます。自動車内でアイテムがどのように表示されるかは、このコンテンツスタイルによって決まります。

使用可能なコンテンツスタイルは次のとおりです。

リストアイテム: このコンテンツスタイルは、画像よりもタイトルとメタデータを優先します。
グリッドアイテム: このコンテンツスタイルは、タイトルとメタデータよりも画像を優先します。

デフォルトのコンテンツスタイルを設定する

サービスの onGetRoot() メソッドの BrowserRoot エクストラバンドルに特定の定数を含めることにより、メディアアイテムをどのように表示するかに関するグローバルなデフォルトを設定できます。Android Auto と Android Automotive OS はこのバンドルを読み取り、そうした定数を見つけて、適切なスタイルを決定します。

次のエクストラはバンドルでキーとして使用できます。

DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE: ブラウズツリー内のすべてのブラウズ可能なアイテムのプレゼンテーションヒントを示します。
DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE: ブラウズツリー内のすべての再生可能なアイテムのプレゼンテーションヒントを示します。

キーは、次の整数定数値にマッピングして、こうしたアイテムの表示に影響を与えます。

DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_LIST_ITEM: 対応するアイテムはリストアイテムとして表示されます。
DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_GRID_ITEM: 対応するアイテムはグリッドアイテムとして表示されます。
DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_CATEGORY_LIST_ITEM: 対応するアイテムは、「カテゴリ」リストアイテムとして表示されます。これらは通常のリストアイテムと同じですが、アイテムのアイコンは小さい方が見栄えがよいため、周囲に余白を付けます。アイコンは、着色可能なベクター型ドローアブルにする必要があります。このヒントはブラウズ可能なアイテムに対してのみ提供されます。
DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_CATEGORY_GRID_ITEM: 対応するアイテムは、「カテゴリ」グリッドアイテムとして表示されます。これらは通常のグリッドアイテムと同じですが、アイテムのアイコンは小さい方が見栄えがよいため、周囲に余白を付けます。アイコンは、着色可能なベクター型ドローアブルにする必要があります。このヒントはブラウズ可能なアイテムに対してのみ提供されます。

次のコードスニペットは、ブラウズ可能なアイテムと再生可能なアイテムのデフォルトのコンテンツスタイルを、それぞれグリッドとリストに設定する方法を示しています。

Kotlin

import androidx.media.utils.MediaConstants

@Nullable
override fun onGetRoot(
    @NonNull clientPackageName: String,
    clientUid: Int,
    @Nullable rootHints: Bundle
): BrowserRoot {
    val extras = Bundle()
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_GRID_ITEM)
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_LIST_ITEM)
    return BrowserRoot(ROOT_ID, extras)
}

Java

import androidx.media.utils.MediaConstants;

@Nullable
@Override
public BrowserRoot onGetRoot(
    @NonNull String clientPackageName,
    int clientUid,
    @Nullable Bundle rootHints) {
    Bundle extras = new Bundle();
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_GRID_ITEM);
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_LIST_ITEM);
    return new BrowserRoot(ROOT_ID, extras);
}

アイテムごとのコンテンツスタイルを設定する

Content Style API を使用すると、ブラウズ可能なメディアアイテムの子やメディアアイテム自体の、デフォルトのコンテンツスタイルをオーバーライドできます。

ブラウズ可能なメディアアイテムの子のデフォルトをオーバーライドするには、そのメディアアイテムの MediaDescription にエクストラバンドルを作成し、前述のヒントを追加します。DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE はそのアイテムの再生可能な子に適用され、DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE はそのアイテムのブラウズ可能な子に適用されます。

特定のメディアアイテム自体（子ではない）のデフォルトをオーバーライドするには、そのメディアアイテムの MediaDescription にエクストラバンドルを作成し、キー DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_SINGLE_ITEM を使用してヒントを追加します。そのアイテムの表示を指定するには、前述の値と同じ値を使用します。

次のコードスニペットは、自身と子のデフォルトのコンテンツスタイルをオーバーライドするブラウズ可能な MediaItem を作成する方法を示しています。自身をカテゴリリストアイテムとして、ブラウズ可能な子をリストアイテムとして、再生可能な子をグリッドアイテムとしてスタイル設定します。

Kotlin

import androidx.media.utils.MediaConstants

private fun createBrowsableMediaItem(
    mediaId: String,
    folderName: String,
    iconUri: Uri
): MediaBrowser.MediaItem {
    val mediaDescriptionBuilder = MediaDescription.Builder()
    mediaDescriptionBuilder.setMediaId(mediaId)
    mediaDescriptionBuilder.setTitle(folderName)
    mediaDescriptionBuilder.setIconUri(iconUri)
    val extras = Bundle()
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_SINGLE_ITEM,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_CATEGORY_LIST_ITEM)
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_LIST_ITEM)
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_GRID_ITEM)
    mediaDescriptionBuilder.setExtras(extras)
    return MediaBrowser.MediaItem(
        mediaDescriptionBuilder.build(), MediaBrowser.MediaItem.FLAG_BROWSABLE)
}

Java

import androidx.media.utils.MediaConstants;

private MediaBrowser.MediaItem createBrowsableMediaItem(
    String mediaId,
    String folderName,
    Uri iconUri) {
    MediaDescription.Builder mediaDescriptionBuilder = new MediaDescription.Builder();
    mediaDescriptionBuilder.setMediaId(mediaId);
    mediaDescriptionBuilder.setTitle(folderName);
    mediaDescriptionBuilder.setIconUri(iconUri);
    Bundle extras = new Bundle();
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_SINGLE_ITEM,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_CATEGORY_LIST_ITEM);
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_BROWSABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_LIST_ITEM);
    extras.putInt(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_PLAYABLE,
        MediaConstants.DESCRIPTION_EXTRAS_VALUE_CONTENT_STYLE_GRID_ITEM);
    mediaDescriptionBuilder.setExtras(extras);
    return new MediaBrowser.MediaItem(
        mediaDescriptionBuilder.build(), MediaBrowser.MediaItem.FLAG_BROWSABLE);
}

タイトルのヒントを使用してアイテムをグループ化する

関連するメディアアイテムをグループ化するには、アイテムごとにヒントを使用します。グループ内のすべてのメディアアイテムで、キー DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE と同一の文字列値を持つマッピングを含む MediaDescription でエクストラバンドルを宣言する必要があります。グループのタイトルとして使用されるこの文字列をローカライズします。

次のコードスニペットは、サブグループの見出しが "Songs" の MediaItem を作成する方法を示しています。

Kotlin

import androidx.media.utils.MediaConstants

private fun createMediaItem(
    mediaId: String,
    folderName: String,
    iconUri: Uri
): MediaBrowser.MediaItem {
    val mediaDescriptionBuilder = MediaDescription.Builder()
    mediaDescriptionBuilder.setMediaId(mediaId)
    mediaDescriptionBuilder.setTitle(folderName)
    mediaDescriptionBuilder.setIconUri(iconUri)
    val extras = Bundle()
    extras.putString(
        MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE,
        "Songs")
    mediaDescriptionBuilder.setExtras(extras)
    return MediaBrowser.MediaItem(
        mediaDescriptionBuilder.build(), /* playable or browsable flag*/)
}

Java

import androidx.media.utils.MediaConstants;

private MediaBrowser.MediaItem createMediaItem(String mediaId, String folderName, Uri iconUri) {
   MediaDescription.Builder mediaDescriptionBuilder = new MediaDescription.Builder();
   mediaDescriptionBuilder.setMediaId(mediaId);
   mediaDescriptionBuilder.setTitle(folderName);
   mediaDescriptionBuilder.setIconUri(iconUri);
   Bundle extras = new Bundle();
   extras.putString(
       MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE,
       "Songs");
   mediaDescriptionBuilder.setExtras(extras);
   return new MediaBrowser.MediaItem(
       mediaDescriptionBuilder.build(), /* playable or browsable flag*/);
}

アプリは、連続したブロックとしてグループ化するメディアアイテムをすべて渡す必要があります。たとえば、メディアアイテムの 2 つのグループ「Songs」と「Albums」をこの順序で表示するために、アプリで 5 つのメディアアイテムを次の順序で渡したとします。

メディアアイテム A（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム B（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Albums") を使用）
メディアアイテム C（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム D（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム E（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Albums") を使用）

「Songs」グループと「Albums」グループのメディアアイテムは連続したブロックにならないため、Android Auto と Android Automotive OS はこれを次の 4 つのグループと解釈します。

メディアアイテム A を含む「Songs」というグループ 1
メディアアイテム B を含む「Albums」というグループ 2
メディアアイテム C と D を含む「Songs」というグループ 3
メディアアイテム E を含む「Albums」というグループ 4

これらのアイテムを 2 つのグループで表示するには、アプリで次の順序でメディアアイテムを渡す必要があります。

メディアアイテム A（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム C（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム D（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Songs") を使用）
メディアアイテム B（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Albums") を使用）
メディアアイテム E（extras.putString(MediaConstants.DESCRIPTION_EXTRAS_KEY_CONTENT_STYLE_GROUP_TITLE, "Albums") を使用）

追加のメタデータインジケーターを表示する

追加のメタデータインジケーターを設定して、メディアブラウザツリー内に、またはメディアの再生中に、コンテンツが一目でわかる情報を提供できます。ブラウザツリー内では、Android Auto と Android Automotive OS はアイテムに関連付けられたエクストラを読み取り、特定の定数を見つけて、表示するインジケーターを決定します。メディアの再生中には、Android Auto と Android Automotive OS はメディアセッションのメタデータを読み取り、特定の定数を見つけて、表示するインジケーターを決定します。

図 3. メタデータで曲とアーティストを識別する再生ビューと、明示的なコンテンツを示すアイコン。

図 4. 1 つ目のアイテムに未再生コンテンツのドットが表示され、2 つ目のアイテムに再生途中のコンテンツの進行状況バーが表示されているブラウズビュー。

次の定数は、MediaItem ディスクリプションエクストラと MediaMetadata エクストラの両方で使用できます。

EXTRA_DOWNLOAD_STATUS: アイテムのダウンロードステータスを示します。この定数をキーとして使用します。有効な値は次の long 定数のいずれかです。
- STATUS_DOWNLOADED: アイテムは完全にダウンロードされています。
- STATUS_DOWNLOADING: アイテムはダウンロード中です。
- STATUS_NOT_DOWNLOADED: アイテムはダウンロードされていません。
METADATA_KEY_IS_EXPLICIT: アイテムに露骨な表現のコンテンツが含まれているかどうかを示します。アイテムが露骨な表現であることを示すには、この定数をキーとして使用し、long 型の METADATA_VALUE_ATTRIBUTE_PRESENT を値として使用します。

次の定数は、MediaItem ディスクリプションエクストラでしか使用できません。

DESCRIPTION_EXTRAS_KEY_COMPLETION_STATUS: 長編コンテンツ（ポッドキャストのエピソードやオーディオブックなど）の完了状態を示します。この定数をキーとして使用します。有効な値は次の整数定数のいずれかです。
- DESCRIPTION_EXTRAS_VALUE_COMPLETION_STATUS_NOT_PLAYED: アイテムはまったく再生されていません。
- DESCRIPTION_EXTRAS_VALUE_COMPLETION_STATUS_PARTIALLY_PLAYED: アイテムは部分的に再生され、現在の位置は中間のどこかです。
- DESCRIPTION_EXTRAS_VALUE_COMPLETION_STATUS_FULLY_PLAYED: アイテムは完了しました。
DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE: 長編コンテンツの完了進捗度を 0.0 以上 1.0 以下の double 型の値で示します。このエクストラは、PARTIALLY_PLAYING 状態に関する詳細情報を提供します。これにより、Android Auto または Android Automotive OS は、わかりやすい進行状況インジケーター（進行状況バーなど）を表示できます。このエクストラを使用する場合は、初回インプレッション後にインジケーターを最新の状態に保つ方法について、このガイドのコンテンツの再生中にブラウズビューの進行状況バーを更新するをご覧ください。

ユーザーがメディアブラウズツリーをブラウジングしているときにインジケーターを表示するには、上の定数を 1 つ以上含むエクストラバンドルを作成し、そのバンドルを MediaDescription.Builder.setExtras() メソッドに渡します。

次のコードスニペットは、70% 完了した露骨な表現のメディアアイテムのインジケーターを表示する方法を示しています。

Kotlin

import androidx.media.utils.MediaConstants

val extras = Bundle()
extras.putLong(
    MediaConstants.METADATA_KEY_IS_EXPLICIT,
    MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT)
extras.putInt(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_STATUS,
    MediaConstants.DESCRIPTION_EXTRAS_VALUE_COMPLETION_STATUS_PARTIALLY_PLAYED)
extras.putDouble(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE, 0.7)
val description =
    MediaDescriptionCompat.Builder()
        .setMediaId(/*...*/)
        .setTitle(resources.getString(/*...*/))
        .setExtras(extras)
        .build()
return MediaBrowserCompat.MediaItem(description, /* flags */)

Java

import androidx.media.utils.MediaConstants;

Bundle extras = new Bundle();
extras.putLong(
    MediaConstants.METADATA_KEY_IS_EXPLICIT,
    MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT);
extras.putInt(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_STATUS,
    MediaConstants.DESCRIPTION_EXTRAS_VALUE_COMPLETION_STATUS_PARTIALLY_PLAYED);
extras.putDouble(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE, 0.7);
MediaDescriptionCompat description =
    new MediaDescriptionCompat.Builder()
        .setMediaId(/*...*/)
        .setTitle(resources.getString(/*...*/))
        .setExtras(extras)
        .build();
return new MediaBrowserCompat.MediaItem(description, /* flags */);

現在再生中のメディアアイテムのインジケーターを表示するには、METADATA_KEY_IS_EXPLICIT または EXTRA_DOWNLOAD_STATUS の Long 形式の値を mediaSession の MediaMetadataCompat で宣言します。再生ビューに DESCRIPTION_EXTRAS_KEY_COMPLETION_STATUS または DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE インジケーターを表示することはできません。

次のコードスニペットは、再生ビュー内の現在の曲が露骨な表現であり、かつダウンロードされていることを示す方法を示しています。

Kotlin

import androidx.media.utils.MediaConstants

mediaSession.setMetadata(
    MediaMetadataCompat.Builder()
        .putString(
            MediaMetadataCompat.METADATA_KEY_DISPLAY_TITLE, "Song Name")
        .putString(
            MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "Artist name")
        .putString(
            MediaMetadataCompat.METADATA_KEY_ALBUM_ART_URI,
            albumArtUri.toString())
        .putLong(
            MediaConstants.METADATA_KEY_IS_EXPLICIT,
            MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT)
        .putLong(
            MediaDescriptionCompat.EXTRA_DOWNLOAD_STATUS,
            MediaDescriptionCompat.STATUS_DOWNLOADED)
        .build())

Java

import androidx.media.utils.MediaConstants;

mediaSession.setMetadata(
    new MediaMetadataCompat.Builder()
        .putString(
            MediaMetadataCompat.METADATA_KEY_DISPLAY_TITLE, "Song Name")
        .putString(
            MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "Artist name")
        .putString(
            MediaMetadataCompat.METADATA_KEY_ALBUM_ART_URI,
            albumArtUri.toString())
        .putLong(
            MediaConstants.METADATA_KEY_IS_EXPLICIT,
            MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT)
        .putLong(
            MediaDescriptionCompat.EXTRA_DOWNLOAD_STATUS,
            MediaDescriptionCompat.STATUS_DOWNLOADED)
        .build());

コンテンツの再生中にブラウズビューの進行状況バーを更新する

前述のように、DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE エクストラを使用することで、再生途中のコンテンツの進行状況バーをブラウズビューに表示できます。ただし、ユーザーが Android Auto または Android Automotive OS から再生途中のコンテンツを再生し続けると、時間の経過とともにインジケーターが不正確になります。

Android Auto と Android Automotive OS で進行状況バーを最新の状態に保つために、MediaMetadataCompat と PlaybackStateCompat で追加情報を提供し、ブラウズビューで進行中のコンテンツをメディアアイテムにリンクできます。メディアアイテムで進行状況バーを自動更新するには、次の要件を満たす必要があります。

作成した MediaItem は、エクストラで DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE を 0.0 以上 1.0 以下の値で送信する必要があります。
MediaMetadataCompat は、MediaItem に渡されるメディア ID と等しい文字列値で METADATA_KEY_MEDIA_ID を送信する必要があります。
PlaybackStateCompat は、MediaItem に渡されるメディア ID と等しい文字列値にマッピングされるキー PLAYBACK_STATE_EXTRAS_KEY_MEDIA_ID のエクストラを含む必要があります。

次のコードスニペットは、現在再生中のアイテムがブラウズビューのアイテムにリンクされていることを示す方法を表しています。

Kotlin

import androidx.media.utils.MediaConstants

// When the MediaItem is constructed to show in the browse view.
// Suppose the item was 25% complete when the user launched the browse view.
val mediaItemExtras = Bundle()
mediaItemExtras.putDouble(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE, 0.25)
val description =
    MediaDescriptionCompat.Builder()
        .setMediaId("my-media-id")
        .setExtras(mediaItemExtras)
        // ...and any other setters.
        .build()
return MediaBrowserCompat.MediaItem(description, /* flags */)

// Elsewhere, when the user has selected MediaItem for playback.
mediaSession.setMetadata(
    MediaMetadataCompat.Builder()
        .putString(MediaMetadata.METADATA_KEY_MEDIA_ID, "my-media-id")
        // ...and any other setters.
        .build())

val playbackStateExtras = Bundle()
playbackStateExtras.putString(
    MediaConstants.PLAYBACK_STATE_EXTRAS_KEY_MEDIA_ID, "my-media-id")
mediaSession.setPlaybackState(
    PlaybackStateCompat.Builder()
        .setExtras(playbackStateExtras)
        // ...and any other setters.
        .build())

Java

import androidx.media.utils.MediaConstants;

// When the MediaItem is constructed to show in the browse view.
// Suppose the item was 25% complete when the user launched the browse view.
Bundle mediaItemExtras = new Bundle();
mediaItemExtras.putDouble(
    MediaConstants.DESCRIPTION_EXTRAS_KEY_COMPLETION_PERCENTAGE, 0.25);
MediaDescriptionCompat description =
    new MediaDescriptionCompat.Builder()
        .setMediaId("my-media-id")
        .setExtras(mediaItemExtras)
        // ...and any other setters.
        .build();
return MediaBrowserCompat.MediaItem(description, /* flags */);

// Elsewhere, when the user has selected MediaItem for playback.
mediaSession.setMetadata(
    new MediaMetadataCompat.Builder()
        .putString(MediaMetadata.METADATA_KEY_MEDIA_ID, "my-media-id")
        // ...and any other setters.
        .build());

Bundle playbackStateExtras = new Bundle();
playbackStateExtras.putString(
    MediaConstants.PLAYBACK_STATE_EXTRAS_KEY_MEDIA_ID, "my-media-id");
mediaSession.setPlaybackState(
    new PlaybackStateCompat.Builder()
        .setExtras(playbackStateExtras)
        // ...and any other setters.
        .build());

ブラウズ可能な検索結果を表示する

図 5. ユーザーの音声検索に関連するメディアアイテムを表示できる「検索結果」オプションが表示された再生ビュー

アプリは、ユーザーが検索クエリを開始したときに表示されるコンテキスト検索結果を提供できます。Android Auto と Android Automotive OS は、検索結果を、検索クエリインターフェースや、セッション内で前に実行されたクエリにピボットされたアフォーダンスに表示します。詳細については、このガイドの音声操作をサポートするをご覧ください。

ブラウズ可能な検索結果を表示するには、定数キー BROWSER_SERVICE_EXTRAS_KEY_SEARCH_SUPPORTED をサービスの onGetRoot() メソッドのエクストラバンドルに含めて、ブール値 true にマッピングします。

次のコードスニペットは、onGetRoot() メソッドでサポートを有効にする方法を示しています。

Kotlin

import androidx.media.utils.MediaConstants

@Nullable
fun onGetRoot(
    @NonNull clientPackageName: String,
    clientUid: Int,
    @Nullable rootHints: Bundle
): BrowserRoot {
    val extras = Bundle()
    extras.putBoolean(
        MediaConstants.BROWSER_SERVICE_EXTRAS_KEY_SEARCH_SUPPORTED, true)
    return BrowserRoot(ROOT_ID, extras)
}

Java

import androidx.media.utils.MediaConstants;

@Nullable
@Override
public BrowserRoot onGetRoot(
    @NonNull String clientPackageName,
    int clientUid,
    @Nullable Bundle rootHints) {
    Bundle extras = new Bundle();
    extras.putBoolean(
        MediaConstants.BROWSER_SERVICE_EXTRAS_KEY_SEARCH_SUPPORTED, true);
    return new BrowserRoot(ROOT_ID, extras);
}

検索結果の提供を開始するには、メディアブラウザサービスの onSearch() メソッドをオーバーライドします。Android Auto と Android Automotive OS は、ユーザーが検索クエリインターフェースまたは「検索結果」アフォーダンスを呼び出すたびに、ユーザーの検索キーワードをこのメソッドに転送します。

サービスの onSearch() メソッドによる検索結果をタイトルアイテムで整理し、よりブラウズしやすくすることが可能です。たとえば、アプリで音楽を再生する場合、アルバム、アーティスト、曲ごとに検索結果をまとめます。

次のコードスニペットは、onSearch() メソッドの単純な実装を示しています。

Kotlin

fun onSearch(query: String, extras: Bundle) {
  // Detach from results to unblock the caller (if a search is expensive).
  result.detach()
  object:AsyncTask() {
    internal var searchResponse:ArrayList
    internal var succeeded = false
    protected fun doInBackground(vararg params:Void):Void {
      searchResponse = ArrayList()
      if (doSearch(query, extras, searchResponse))
      {
        succeeded = true
      }
      return null
    }
    protected fun onPostExecute(param:Void) {
      if (succeeded)
      {
        // Sending an empty List informs the caller that there were no results.
        result.sendResult(searchResponse)
      }
      else
      {
        // This invokes onError() on the search callback.
        result.sendResult(null)
      }
      return null
    }
  }.execute()
}
// Populates resultsToFill with search results. Returns true on success or false on error.
private fun doSearch(
    query: String,
    extras: Bundle,
    resultsToFill: ArrayList
): Boolean {
  // Implement this method.
}

Java

@Override
public void onSearch(final String query, final Bundle extras,
                        Result<List<MediaItem>> result) {

  // Detach from results to unblock the caller (if a search is expensive).
  result.detach();

  new AsyncTask<Void, Void, Void>() {
    List<MediaItem> searchResponse;
    boolean succeeded = false;
    @Override
    protected Void doInBackground(Void... params) {
      searchResponse = new ArrayList<MediaItem>();
      if (doSearch(query, extras, searchResponse)) {
        succeeded = true;
      }
      return null;
    }

    @Override
    protected void onPostExecute(Void param) {
      if (succeeded) {
       // Sending an empty List informs the caller that there were no results.
       result.sendResult(searchResponse);
      } else {
        // This invokes onError() on the search callback.
        result.sendResult(null);
      }
    }
  }.execute()
}

/** Populates resultsToFill with search results. Returns true on success or false on error. */
private boolean doSearch(String query, Bundle extras, ArrayList<MediaItem> resultsToFill) {
    // Implement this method.
}

再生コントロールを有効にする

Android Auto と Android Automotive OS は、サービスの MediaSessionCompat を介して再生コントロールコマンドを送信します。セッションを登録し、関連するコールバックメソッドを実装する必要があります。

メディアセッションを登録する

メディアブラウザサービスの onCreate() メソッドで MediaSessionCompat を作成し、setSessionToken() を呼び出してメディアセッションを登録します。

次のコードスニペットは、メディアセッションを作成して登録する方法を示しています。

Kotlin

override fun onCreate() {
    super.onCreate()
    ...
    // Start a new MediaSession.
    val session = MediaSessionCompat(this, "session tag").apply {
        // Set a callback object that implements MediaSession.Callback
        // to handle play control requests.
        setCallback(MyMediaSessionCallback())
    }
    sessionToken = session.sessionToken
    ...
}

Java

public void onCreate() {
    super.onCreate();
    ...
    // Start a new MediaSession.
    MediaSessionCompat session = new MediaSessionCompat(this, "session tag");
    setSessionToken(session.getSessionToken());

    // Set a callback object that implements MediaSession.Callback
    // to handle play control requests.
    session.setCallback(new MyMediaSessionCallback());
    ...
}

メディアセッションオブジェクトを作成する際に、再生コントロールリクエストの処理に使用されるコールバックオブジェクトを設定します。このコールバックオブジェクトを作成するには、アプリの MediaSessionCompat.Callback クラスの実装を提供します。次のセクションで、このオブジェクトを実装する方法を説明します。

再生コマンドを実装する

ユーザーがアプリにメディアアイテムの再生をリクエストすると、Android Automotive OS と Android Auto は、アプリの MediaSessionCompat オブジェクト（アプリのメディアブラウザサービスから取得したオブジェクト）の MediaSessionCompat.Callback クラスを使用します。ユーザーがコンテンツ再生を制御する場合（再生の一時停止や次のトラックへのスキップなど）、Android Auto と Android Automotive OS は、コールバックオブジェクトのメソッドのひとつを呼び出します。

コンテンツ再生を処理するには、アプリで MediaSessionCompat.Callback 抽象クラスを拡張して、アプリがサポートするメソッドを実装する必要があります。

アプリが提供するコンテンツの種類に応じて、以下のコールバックメソッドをすべて実装します。

onPrepare(): メディアソースが変更されたときに呼び出されます。Android Automotive OS は、起動直後にもこのメソッドを呼び出します。メディアアプリは、このメソッドを実装する必要があります。
onPlay(): ユーザーが特定のアイテムを選択せずに再生を選択したときに呼び出されます。アプリはデフォルトのコンテンツを再生する必要があります。また、onPause() で再生が一時停止されていた場合、アプリは再生を再開します。
注: Android Automotive OS または Android Auto がメディアブラウザサービスに接続したとき、アプリは自動的に音楽の再生を開始してはなりません。詳細については、最初の PlaybackState を設定するをご覧ください。
onPlayFromMediaId(): ユーザーが特定のアイテムの再生を選択したときに呼び出されます。このメソッドには、メディアブラウザサービスがコンテンツ階層内のメディアアイテムに割り当てた ID が渡されます。
onPlayFromSearch(): ユーザーが検索クエリからの再生を選択したときに呼び出されます。アプリは、渡された検索文字列に基づいて適切な選択を行う必要があります。
onPause(): ユーザーが再生の一時停止を選択したときに呼び出されます。
onSkipToNext(): ユーザーが次のアイテムへのスキップを選択したときに呼び出されます。
onSkipToPrevious(): ユーザーが前のアイテムへのスキップを選択したときに呼び出されます。
onStop(): ユーザーが再生の停止を選択したときに呼び出されます。

アプリでこれらのメソッドをオーバーライドして、必要な機能を提供します。メソッドの機能がアプリでサポートされていなければ、そのメソッドを実装する必要はありません。たとえば、アプリがライブストリーム（スポーツ放送など）を再生する場合、onSkipToNext() メソッドを実装する必要はありません。代わりに onSkipToNext() のデフォルト実装を使用できます。

アプリには、車載スピーカーからコンテンツを再生するための特別なロジックは不要です。アプリは、コンテンツの再生リクエストを受信したとき、ユーザーのスマートフォンのスピーカーまたはヘッドフォンでコンテンツを再生する場合と同じ方法で音声を再生できます。Android Auto と Android Automotive OS は、音声コンテンツを車載システムに自動的に送信して、車載スピーカーで再生します。

音声コンテンツの再生の詳細については、MediaPlayer の概要、オーディオアプリの概要、ExoPlayer の概要をご覧ください。

標準の再生操作を設定する

Android Auto と Android Automotive OS は、PlaybackStateCompat オブジェクトで有効化されている操作に基づいて再生コントロールを表示します。

デフォルトでは、アプリは次の操作をサポートする必要があります。

アプリのコンテンツに関連する場合、アプリは次の操作もサポートできます。

さらに、ユーザーに表示できる再生キューの作成も可能ですが、必須ではありません。そのためには、setQueue() メソッドと setQueueTitle() メソッドを呼び出し、ACTION_SKIP_TO_QUEUE_ITEM 操作を有効にして、コールバック onSkipToQueueItem() を定義します。

また、現在再生中の曲のインジケーターである「この曲なに？」アイコンのサポートも追加します。そのためには、setActiveQueueItemId() メソッドを呼び出し、現在再生しているアイテムの ID をキューに渡します。キューが変更されるたびに setActiveQueueItemId() を更新する必要があります。

Android Auto と Android Automotive OS は、有効化された操作ごとにボタンを表示し、再生キューを表示します。ボタンがクリックされると、システムは MediaSessionCompat.Callback から対応するコールバックを呼び出します。

未使用のスペースを予約する

Android Auto と Android Automotive OS は、ACTION_SKIP_TO_PREVIOUS アクションと ACTION_SKIP_TO_NEXT アクション用に UI のスペースを予約します。アプリがこれらの機能のいずれかをサポートしていない場合、Android Auto と Android Automotive OS はこのスペースを使用して、デベロッパーが作成したカスタムアクションを表示します。

このスペースにカスタムアクションを表示しない場合、アプリが対応する機能をサポートしていないときは常に Android Auto と Android Automotive OS がスペースを空白のままにしておくように、スペースを予約できます。そのためには、予約された各機能に対応する定数を含むエクストラバンドルを指定して、setExtras() メソッドを呼び出します。SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_NEXT は ACTION_SKIP_TO_NEXT に対応し、SESSION_EXTRAS_KEY_SLOT_RESERVATION_SKIP_TO_PREV は ACTION_SKIP_TO_PREVIOUS に対応します。これらの定数をバンドルのキーとして使用し、値にブール値 true を使用します。

最初の PlaybackState を設定する

Android Auto と Android Automotive OS がメディアブラウザサービスと通信する際、メディアセッションは PlaybackStateCompat を使用してコンテンツ再生のステータスをやり取りします。Android Automotive OS または Android Auto がメディアブラウザサービスに接続したとき、アプリは自動的に音楽の再生を開始してはなりません。Android Auto と Android Automotive OS に処理をまかせ、車の状態またはユーザーの操作に基づいて再生を再開または開始してください。

そのためには、メディアセッションの最初の PlaybackStateCompat を、STATE_STOPPED、STATE_PAUSED、STATE_NONE、STATE_ERROR のいずれかに設定します。

Android Auto と Android Automotive OS のメディアセッションは運転している間だけ持続するため、ユーザーはこれらのセッションの開始と停止を頻繁に行うことになります。運転再開時のエクスペリエンスをよりシームレスなものにするには、ユーザーの以前のセッションの状態（最後に再生したメディアアイテム、PlaybackStateCompat、キューなど）を追跡して、メディアアプリが再開リクエストを受け取ったときに、再生を中断したところから自動的に再開できるようにします。

カスタム再生操作を追加する

カスタム再生操作を追加して、メディアアプリがサポートする追加の操作を表示できます。スペースに余裕がある（予約されていない）場合、Android はトランスポートコントロールにカスタム操作を追加します。それ以外の場合、カスタム操作はオーバーフローメニューに表示されます。カスタムアクションは、PlaybackStateCompat に追加された順序で表示されます。

カスタム操作は、標準操作とは異なる動作を提供するために使用します。標準の操作の置き換えや複製には使用しないでください。

これらの操作は、PlaybackStateCompat.Builder クラスの addCustomAction() メソッドを使用して追加できます。

次のコードスニペットは、カスタムの「ラジオチャンネルの開始」操作を追加する方法を示しています。

Kotlin

stateBuilder.addCustomAction(
    PlaybackStateCompat.CustomAction.Builder(
        CUSTOM_ACTION_START_RADIO_FROM_MEDIA,
        resources.getString(R.string.start_radio_from_media),
        startRadioFromMediaIcon
    ).run {
        setExtras(customActionExtras)
        build()
    }
)

Java

stateBuilder.addCustomAction(
    new PlaybackStateCompat.CustomAction.Builder(
        CUSTOM_ACTION_START_RADIO_FROM_MEDIA,
        resources.getString(R.string.start_radio_from_media),
        startRadioFromMediaIcon)
    .setExtras(customActionExtras)
    .build());

このメソッドの詳細な例については、GitHub の Universal Android Music Player サンプルアプリの setCustomAction() メソッドをご覧ください。

カスタム操作を作成した場合、メディアセッションは onCustomAction() メソッドをオーバーライドすることで操作に応答できます。

次のコードスニペットは、アプリが「ラジオチャンネルの開始」操作に応答する方法を示しています。

Kotlin

override fun onCustomAction(action: String, extras: Bundle?) {
    when(action) {
        CUSTOM_ACTION_START_RADIO_FROM_MEDIA -> {
            ...
        }
    }
}

Java

@Override
public void onCustomAction(@NonNull String action, Bundle extras) {
    if (CUSTOM_ACTION_START_RADIO_FROM_MEDIA.equals(action)) {
        ...
    }
}

このメソッドの詳細な例については、GitHub の Universal Android Music Player サンプルアプリの onCustomAction メソッドをご覧ください。

カスタム操作のアイコン

作成する各カスタム操作には、アイコンリソースが必要です。車載アプリはさまざまな画面サイズと密度で実行される可能性があるので、提供するアイコンはベクター型ドローアブルでなければなりません。ベクター型ドローアブルを使用すると、細部を犠牲にすることなくアセットを拡大 / 縮小できます。また、低い解像度でも、アイコンの端と隅をピクセル境界に簡単に合わせられます。

カスタム操作がステートフルである場合（再生設定のオンとオフを切り替える場合など）は、ユーザーが操作を選択したときに変化に気付けるように、状態ごとに別々のアイコンを提供します。

無効な操作に対して代替アイコンスタイルを提供する

現在のコンテキストでカスタム操作を使用できない場合は、カスタム操作のアイコンを、操作が無効であることを示す代替アイコンに切り替えます。

図 6. カスタム操作がオフになっていることを示すアイコンスタイルのサンプル。

音声操作をサポートする

メディアアプリでは、ドライバーが注意散漫になる危険を最小限に抑える安全で便利なエクスペリエンスを提供するために、音声操作をサポートする必要があります。たとえば、アプリがあるメディアアイテムを再生しているときに、ユーザーが車載ディスプレイを見たり触れたりせずに、声（「[曲名] を再生して」など）で別の曲の再生をアプリに指示できるようにします。ユーザーは、ハンドル上の該当するボタンをクリックするか起動ワード（「OK Google」）を言うことで、クエリを開始できます。

Android Auto または Android Automotive OS が音声操作を検出して解釈すると、その音声操作は onPlayFromSearch() を介してアプリに配信されます。このコールバックを受け取ると、アプリは query 文字列に一致するコンテンツを見つけて再生を開始します。

ユーザーは、ジャンル、アーティスト、アルバム、曲名、ラジオ局、プレイリストなど、クエリにさまざまなカテゴリの用語を指定できます。検索のサポートを構築する際は、アプリに適したすべてのカテゴリを考慮してください。Android Auto または Android Automotive OS は、クエリが特定のカテゴリに当てはまることを検出すると、extras パラメータにエクストラを付加します。送信される可能性のあるエクストラは次のとおりです。

空の query 文字列を考慮に入れます。ユーザーが検索キーワードを指定しなかった場合、Android Auto または Android Automotive OS によってこの文字列が送信されることがあります（ユーザーが「音楽を再生して」と言った場合など）。アプリはその場合、最近再生したトラックまたは新しく提案されたトラックを開始するよう選択できます。

検索の処理に時間がかかる場合は、onPlayFromSearch() でブロックしないでください。代わりに、再生状態を STATE_CONNECTING に設定し、非同期スレッドで検索を行います。

再生が開始されたら、メディアセッションのキューに関連コンテンツを入力することを検討してください。たとえば、ユーザーがアルバムの再生をリクエストした場合、アプリはそのアルバムのトラックリストをキューに入力する可能性があります。ブラウズ可能な検索結果のサポートを実装することも検討してください。これにより、ユーザーはクエリと一致する別のトラックを選択できます。

「再生」クエリに加えて、Android Auto と Android Automotive OS は、「音楽を一時停止」や「次の曲」のような再生制御のための音声クエリを認識します。また、これらのコマンドを onPause() や onSkipToNext() のような該当するメディアセッションコールバックと照合します。

音声対応の再生操作をアプリに実装する方法の詳細な例については、Google アシスタントとメディアアプリをご覧ください。

注意散漫に対する安全保護対策を実装する

Android Auto の使用中、ユーザーのスマートフォンは車載スピーカーに接続されているため、ドライバーの注意散漫を防止するために追加の予防措置を講じる必要があります。

車内でのアラームを抑制する

Android Auto メディアアプリは、ユーザーが再生を開始した場合（再生ボタンを押した場合など）を除き、車載スピーカーで音声の再生を開始してはなりません。メディアアプリでユーザーがアラームをスケジュールした場合であっても、それによって車載スピーカーで音楽を再生してはいけません。

この要件を満たすために、アプリは音声を再生する前に、シグナルとして CarConnection を使用できます。アプリは、自動車の接続タイプの LiveData を監視し、CONNECTION_TYPE_PROJECTION と合致するかどうかを確認することで、スマートフォンが車載ディスプレイに投影されているかどうかを確認できます。

ユーザーのスマートフォンが投影されている場合、アラームをサポートするメディアアプリは次のいずれかを行う必要があります。

アラームを無効にする。
STREAM_ALARM でアラームを再生し、アラームを無効にする UI をスマートフォン画面に表示する。

メディア広告を処理する

デフォルトでは、Android Auto は、音声再生セッション中にメディアメタデータが変更されると、通知を表示します。メディアアプリが音楽の再生から広告の掲載に切り替えたときに通知を表示すると、ユーザーの注意が散漫になります。この場合に Android Auto が通知を表示しないようにするには、次のコードスニペットに示すように、メディアメタデータのキー METADATA_KEY_IS_ADVERTISEMENT を METADATA_VALUE_ATTRIBUTE_PRESENT に設定する必要があります。

Kotlin

import androidx.media.utils.MediaConstants

override fun onPlayFromMediaId(mediaId: String, extras: Bundle?) {
    MediaMetadataCompat.Builder().apply {
        if (isAd(mediaId)) {
            putLong(
                MediaConstants.METADATA_KEY_IS_ADVERTISEMENT,
                MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT)
        }
        // ...add any other properties you normally would.
        mediaSession.setMetadata(build())
    }
}

Java

import androidx.media.utils.MediaConstants;

@Override
public void onPlayFromMediaId(String mediaId, Bundle extras) {
    MediaMetadataCompat.Builder builder = new MediaMetadataCompat.Builder();
    if (isAd(mediaId)) {
        builder.putLong(
            MediaConstants.METADATA_KEY_IS_ADVERTISEMENT,
            MediaConstants.METADATA_VALUE_ATTRIBUTE_PRESENT);
    }
    // ...add any other properties you normally would.
    mediaSession.setMetadata(builder.build());
}

一般的なエラーを処理する

アプリでエラーが発生した場合は、再生状態を STATE_ERROR に設定し、setErrorMessage() メソッドを使用してエラーメッセージを提供します。エラーメッセージはユーザー向けであるため、ユーザーの現在のロケールに合わせてローカライズする必要があります。これにより、Android Auto と Android Automotive OS はユーザーにエラーメッセージを表示できます。

エラー状態の詳細については、メディアセッションの使用: 状態とエラーをご覧ください。

Android Auto ユーザーがエラーを解決するためにスマートフォンアプリを開く必要がある場合は、メッセージ内でユーザーにその情報を提供します。たとえば、エラーメッセージは、「ログインしてください」ではなく、「[アプリ名] にログインしてください」とします。

その他のリソース

Android Auto のサポートを追加する

自動車向けメディアアプリを作成する

始める前に

主な用語と概念

アプリのマニフェスト ファイルを構成する

メディア ブラウザ サービスを宣言する

アプリアイコンを指定する

ランチャー アイコン

アトリビューション アイコン

メディア ブラウザ サービスを作成する

メディア ブラウザ サービスのワークフロー

コンテンツ階層を構築する

onGetRoot を実装する

Kotlin

Java

onGetRoot() のパッケージ検証を追加する

onLoadChildren() を実装する

Kotlin

Java

ルートメニューを構造化する

Kotlin

Java

メディアのアートワークを表示する

Kotlin

Java

Kotlin

Java

コンテンツ スタイルを適用する

デフォルトのコンテンツ スタイルを設定する

Kotlin

Java

アイテムごとのコンテンツ スタイルを設定する

Kotlin

Java

タイトルのヒントを使用してアイテムをグループ化する

Kotlin

Java

追加のメタデータ インジケーターを表示する

Kotlin

Java

Kotlin

Java

コンテンツの再生中にブラウズビューの進行状況バーを更新する

Kotlin

Java

ブラウズ可能な検索結果を表示する

Kotlin

Java

Kotlin

Java

再生コントロールを有効にする

メディア セッションを登録する

Kotlin

Java

再生コマンドを実装する

標準の再生操作を設定する

未使用のスペースを予約する

最初の PlaybackState を設定する

カスタム再生操作を追加する

Kotlin

Java

Kotlin

Java

カスタム操作のアイコン

無効な操作に対して代替アイコン スタイルを提供する

音声操作をサポートする

注意散漫に対する安全保護対策を実装する

車内でのアラームを抑制する

メディア広告を処理する

Kotlin

Java

一般的なエラーを処理する

その他のリソース

アプリのマニフェストファイルを構成する

メディアブラウザサービスを宣言する

ランチャーアイコン

アトリビューションアイコン

メディアブラウザサービスを作成する

メディアブラウザサービスのワークフロー

コンテンツスタイルを適用する

デフォルトのコンテンツスタイルを設定する

アイテムごとのコンテンツスタイルを設定する

追加のメタデータインジケーターを表示する

メディアセッションを登録する

無効な操作に対して代替アイコンスタイルを提供する