このページは Cloud Translation API によって翻訳されました。

自動車向け Android アプリライブラリを使用する

自動車向け Android アプリライブラリは、ナビゲーションアプリ、スポット（POI）、モノのインターネット（IOT）アプリを車で利用できるようにするためのライブラリです。ドライバーの注意散漫に関する基準に則して設計された一連のテンプレートのセットを提供し、さらに、さまざまな車の画面の要素や入力モダリティなどの細部も考慮されています。

このガイドでは、ライブラリの主な機能とコンセプトについて概説し、基本的なアプリをセットアップする手順を示します。

Codelab

自動車向けアプリライブラリの基本を学ぶ

始める前に

自動車アプリライブラリに関する運転中の設計のページを確認します。
- ナビゲーションアプリとその他の運転関連アプリのカテゴリの概要
- テンプレートを使用してアプリを作成するの概要
- テンプレートとテンプレートコンポーネントに関するビルディングブロック
- 一般的な UX パターンを示すサンプルフロー
- テンプレート化されたアプリの要件
次のセクションの主な用語と概念を確認してください。
Android Auto システム UI と Android Automotive OS の設計について十分に理解しておいてください。
リリースノートを確認してください。
サンプルを確認してください。

主な用語と概念

モデルとテンプレート: ユーザーインターフェースはモデルオブジェクトのグラフで表されます。モデルオブジェクトは、帰属するテンプレートで許可されているさまざまな方法で配置できます。テンプレートとは、これらのグラフでルートとして機能するモデルのサブセットです。モデルには、テキストや画像の形式でユーザーに表示される情報と、このような情報の見た目の各部分を構成する属性（テキストの色や画像サイズなど）が含まれています。ホストは、モデルを、ドライバーの注意散漫に関する基準に則したデザインのビューに変換し、さまざまな車の画面の要素や入力モダリティなど、詳細な処理を行います。
ホスト: ホストは、ライブラリの API によって提供される、アプリを車で実行するための機能を実装するバックエンドコンポーネントです。ホストは、アプリの検出とそのライフサイクルの管理、モデルのビューへの変換、ユーザー操作のアプリへの通知にいたるまで、幅広い役割を担います。モバイルデバイスでは、このホストは Android Auto によって実装されます。Android Automotive OS では、このホストはシステムアプリとしてインストールされます。
テンプレートの制限事項: テンプレートに応じて、そのモデルのコンテンツに制限が課されます。たとえば、リストテンプレートには、ユーザーに提示できるアイテムの数に制限があります。テンプレートには、タスクのフローを形成するためにテンプレートを接続する方法に対しても制限があります。たとえば、アプリが画面スタックにプッシュできるテンプレートは最大 5 つです。詳しくは、テンプレートの制限事項をご覧ください。
Screen: Screen は、ライブラリによって提供されるクラスであり、アプリはこのクラスを実装して、ユーザーに提示されるインターフェースを管理します。Screen にはライフサイクルがあり、画面の表示時に表示されるテンプレートをアプリが送信するメカニズムを提供します。Screen インスタンスを Screen スタックにプッシュ（push）し、ポップ（pop）して、テンプレートフローの制限事項に従わせることもできます
CarAppService: CarAppService は抽象 Service クラスです。アプリがホストによって検出、管理されるためには、このクラスを実装し、エクスポートする必要があります。アプリの CarAppService は、createHostValidator を使用してホスト接続が信頼できることを検証し、次いで、onCreateSession を使用して接続ごとに Session インスタンスを提供します。
Session: Session は抽象クラスであり、アプリは CarAppService.onCreateSession を使用してこのクラスを実装し、結果を返す必要があります。このクラスは、車の画面に情報を表示するためのエントリポイントとして機能します。このクラスは、車の画面にアプリの現在の状態（アプリが表示されているか、非表示になっているかなど）を通知するライフサイクルを持ちます。; Session が開始されると（アプリの初回起動時など）、ホストは onCreateScreen メソッドを使用して、最初の Screen の表示をリクエストします。

Car App Library をインストールする

ライブラリをアプリに追加する方法については、Jetpack ライブラリのリリースページをご覧ください。

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

自動車アプリを作成する前に、アプリのマニフェストファイルを次のように構成します。

CarAppService を宣言する

ホストは CarAppService の実装を通じてアプリに接続します。ホストがアプリを検出して接続できるようにするには、マニフェストでこのサービスを宣言する必要があります。

また、アプリのインテントフィルタの <category> 要素でアプリのカテゴリを宣言する必要もあります。この要素で許可される値については、サポートされているアプリのカテゴリの一覧をご覧ください。

次のコードスニペットは、マニフェストでスポットアプリ用の自動車アプリサービスを宣言する方法を示しています。

<application>
    ...
   <service
       ...
        android:name=".MyCarAppService"
        android:exported="true">
      <intent-filter>
        <action android:name="androidx.car.app.CarAppService"/>
        <category android:name="androidx.car.app.category.POI"/>
      </intent-filter>
    </service>

    ...
<application>

サポートされているアプリのカテゴリ

アプリのカテゴリを宣言するには、前のセクションで説明したように CarAppService を宣言するときに、次のカテゴリ値をインテントフィルタに 1 つ以上追加します。

androidx.car.app.category.NAVIGATION: ターンバイターン方式のナビゲーションの経路を提供するアプリ。自動車向けナビゲーションアプリを作成するをご覧ください。
androidx.car.app.category.POI: 駐車場、充電スタンド、ガソリンスタンドなどのスポットの検索に関連する機能を提供するアプリ。自動車向けスポットアプリを作成するをご覧ください。
androidx.car.app.category.IOT: ユーザーが接続済みデバイスに対して車内から操作を行うことができるアプリ。自動車向けモノのインターネットアプリを作成するをご覧ください。
androidx.car.app.category.WEATHER: ユーザーが現在地やルート沿いに関連する天気情報を確認できるアプリ。自動車向けの天気アプリを作成するをご覧ください。

各カテゴリと、アプリが各カテゴリに属するための条件の詳細については、自動車向け Android アプリの品質をご覧ください。

アプリの名前とアイコンを指定する

ホストがシステム UI でアプリを表すために使用するアプリ名とアイコンを指定する必要があります。

以下のように、CarAppService の label 属性と icon 属性を使用して、アプリを表すために使用されるアプリ名とアイコンを指定できます。

...
<service
   android:name=".MyCarAppService"
   android:exported="true"
   android:label="@string/my_app_name"
   android:icon="@drawable/my_app_icon">
   ...
</service>
...

<service> 要素でラベルまたはアイコンが宣言されていない場合、ホストは <application> 要素に指定された値にフォールバックします。

カスタムテーマを設定する

カーアプリにカスタムテーマを設定するには、マニフェストファイルに <meta-data> 要素を追加します。

<meta-data
    android:name="androidx.car.app.theme"
    android:resource="@style/MyCarAppTheme />

次に、スタイルリソースを宣言して、カスタム自動車アプリのテーマに次の属性を設定します。

<resources>
  <style name="MyCarAppTheme">
    <item name="carColorPrimary">@layout/my_primary_car_color</item>
    <item name="carColorPrimaryDark">@layout/my_primary_dark_car_color</item>
    <item name="carColorSecondary">@layout/my_secondary_car_color</item>
    <item name="carColorSecondaryDark">@layout/my_secondary_dark_car_color</item>
    <item name="carPermissionActivityLayout">@layout/my_custom_background</item>
  </style>
</resources>

自動車向けアプリの API レベル

自動車向けアプリライブラリでは独自に API レベルが定義されるため、車両のテンプレートホストでサポートされているライブラリの機能を確認できます。ホストでサポートされている、自動車向けアプリの最高の API レベルを取得するには、getCarAppApiLevel() メソッドを使用します。

アプリでサポートされる自動車向けアプリの最小 API レベルは、AndroidManifest.xml ファイルで次のように宣言します。

<manifest ...>
    <application ...>
        <meta-data
            android:name="androidx.car.app.minCarApiLevel"
            android:value="1"/>
    </application>
</manifest>

下位互換性を維持し、機能を使用するために必要な最小 API レベルを宣言する方法については、RequiresCarApi アノテーションのドキュメントをご覧ください。自動車向けアプリライブラリの特定の機能を使用するために必要な API レベルの定義については、CarAppApiLevels のリファレンスドキュメントをご確認ください。

CarAppService とセッションを作成する

アプリは、CarAppService クラスを拡張し、その onCreateSession メソッドを実装する必要があります。このメソッドは、ホストへの現在の接続に対応する Session インスタンスを返します。

Kotlin

class HelloWorldService : CarAppService() {
    ...
    override fun onCreateSession(): Session {
        return HelloWorldSession()
    }
    ...
}

Java

public final class HelloWorldService extends CarAppService {
    ...
    @Override
    @NonNull
    public Session onCreateSession() {
        return new HelloWorldSession();
    }
    ...
}

Session インスタンスは、アプリの初回起動時に使用される Screen インスタンスを返す役割を担います。

Kotlin

class HelloWorldSession : Session() {
    ...
    override fun onCreateScreen(intent: Intent): Screen {
        return HelloWorldScreen(carContext)
    }
    ...
}

Java

public final class HelloWorldSession extends Session {
    ...
    @Override
    @NonNull
    public Screen onCreateScreen(@NonNull Intent intent) {
        return new HelloWorldScreen(getCarContext());
    }
    ...
}

自動車アプリがアプリのホーム画面やランディングスクリーンではない画面から起動する必要があるシナリオ（ディープリンクの処理など）を処理する場合は、onCreateScreen から戻る前に ScreenManager.push を使用して、画面のバックスタックを事前にシードできます。事前に埋め込むことで、ユーザーはアプリによって表示された最初の画面から前の画面に戻ることができます。

起動画面を作成する

アプリに表示される画面を作成するには、Screen クラスを拡張するクラスを定義し、その onGetTemplate メソッドを実装します。このメソッドは、車の画面に表示する UI の状態を表す Template インスタンスを返します。

次のスニペットは、PaneTemplate テンプレートを使用してシンプルな「Hello world!」文字列を表示する Screen を宣言する方法を示しています。

Kotlin

class HelloWorldScreen(carContext: CarContext) : Screen(carContext) {
    override fun onGetTemplate(): Template {
        val row = Row.Builder().setTitle("Hello world!").build()
        val pane = Pane.Builder().addRow(row).build()
        return PaneTemplate.Builder(pane)
            .setHeaderAction(Action.APP_ICON)
            .build()
    }
}

Java

public class HelloWorldScreen extends Screen {
    @NonNull
    @Override
    public Template onGetTemplate() {
        Row row = new Row.Builder().setTitle("Hello world!").build();
        Pane pane = new Pane.Builder().addRow(row).build();
        return new PaneTemplate.Builder(pane)
            .setHeaderAction(Action.APP_ICON)
            .build();
    }
}

CarContext クラス

CarContext クラスは、Session インスタンスと Screen インスタンスからアクセスできる ContextWrapper サブクラスです。画面スタックを管理する ScreenManager、地図の描画のために Surface オブジェクトにアクセスするなど、アプリ関連の一般的な機能のための AppManager、ターンバイターンナビゲーションアプリでナビゲーションメタデータやその他のナビゲーション関連イベントをホストと通信するために使用される NavigationManager など、自動車サービスへのアクセスを提供します。

ナビゲーションアプリで利用できるライブラリ機能の全リストについては、ナビゲーションテンプレートにアクセスするをご覧ください。

CarContext は、車の画面の構成を使用してドローアブルリソースを読み込むことを許可する機能、インテントを使用して車内のアプリを起動する機能、アプリがダークモードで地図を表示する必要があるかどうかを通知する機能なども提供します。

アプリでは通常、多くの画面が表示されます。各画面はさまざまなテンプレートを利用し、ユーザーの操作に応じて移り変わるインターフェースを表示します。

ScreenManager クラスは、画面をプッシュしておく画面スタックを提供します。スタックの画面は、ユーザーが車の画面で戻るボタンを選択するか、ハードウェアの戻るボタン（一部の車で提供されています）を使用すると、自動的にポップします。

次のスニペットは、メッセージテンプレートに「戻る」というアクションと、これをユーザーが選択したときに新しい画面をプッシュするアクションを追加する方法を示しています。

Kotlin

val template = MessageTemplate.Builder("Hello world!")
    .setHeaderAction(Action.BACK)
    .addAction(
        Action.Builder()
            .setTitle("Next screen")
            .setOnClickListener { screenManager.push(NextScreen(carContext)) }
            .build())
    .build()

Java

MessageTemplate template = new MessageTemplate.Builder("Hello world!")
    .setHeaderAction(Action.BACK)
    .addAction(
        new Action.Builder()
            .setTitle("Next screen")
            .setOnClickListener(
                () -> getScreenManager().push(new NextScreen(getCarContext())))
            .build())
    .build();

Action.BACK オブジェクトは、自動的に ScreenManager.pop を呼び出す標準的な Action です。この動作は、CarContext から利用可能な OnBackPressedDispatcher インスタンスを使用してオーバーライドできます。

運転中にアプリの安全性を確保するため、画面スタックには最大 5 つまで画面を保持できます。詳しくは、テンプレートの制限事項をご覧ください。

テンプレートのコンテンツを更新する

アプリは、Screen.invalidate メソッドを呼び出すことで、Screen のコンテンツを無効化するようリクエストできます。次に、ホストはアプリの Screen.onGetTemplate メソッドにコールバックして、新しいコンテンツを含むテンプレートを取得します。

Screen を更新するときに、新しいテンプレートがホストによってテンプレートの割り当てにカウントされないように、テンプレート内のどのコンテンツが更新可能かを把握することが重要です。詳しくは、テンプレートの制限事項をご覧ください。

Screen と、onGetTemplate の実装を通じて返されるテンプレートのタイプとが 1 対 1 の関係でマッピングされるように、画面を構成することをおすすめします。

地図を描画する

次のテンプレートを使用するナビゲーションアプリとスポット（POI）アプリは、Surface にアクセスして地図を描画できます。

テンプレート	テンプレートの権限	カテゴリに関するガイダンス
`NavigationTemplate`	`androidx.car.app.NAVIGATION_TEMPLATES`	ナビゲーション
`MapWithContentTemplate`	`androidx.car.app.NAVIGATION_TEMPLATES` または `androidx.car.app.MAP_TEMPLATES`	ナビゲーション、POI、天気
`MapTemplate`（非推奨）	`androidx.car.app.NAVIGATION_TEMPLATES`	ナビゲーション
`PlaceListNavigationTemplate`（非推奨）	`androidx.car.app.NAVIGATION_TEMPLATES`	ナビゲーション
`RoutePreviewNavigationTemplate`（非推奨）	`androidx.car.app.NAVIGATION_TEMPLATES`	ナビゲーション

サーフェス権限を宣言する

サーフェスにアクセスするには、アプリが使用しているテンプレートに必要な権限に加えて、AndroidManifest.xml ファイルで androidx.car.app.ACCESS_SURFACE 権限を宣言する必要があります。

<manifest ...>
  ...
  <uses-permission android:name="androidx.car.app.ACCESS_SURFACE" />
  ...
</manifest>

サーフェスにアクセスする

ホストが提供する Surface にアクセスするには、SurfaceCallback を実装し、その実装を AppManager カーサービスに提供する必要があります。現在の Surface は、onSurfaceAvailable() コールバックと onSurfaceDestroyed() コールバックの SurfaceContainer パラメータで SurfaceCallback に渡されます。

Kotlin

carContext.getCarService(AppManager::class.java).setSurfaceCallback(surfaceCallback)

Java

carContext.getCarService(AppManager.class).setSurfaceCallback(surfaceCallback);

サーフェスの表示可能領域を把握する

ホストはテンプレートのユーザーインターフェース要素を地図上に描画できます。ホストは SurfaceCallback.onVisibleAreaChanged メソッドを呼び出して、遮るものがない、ユーザーに全体が表示されることが確実なサーフェスの領域を伝えます。また、変更回数を最小限に抑えるために、ホストは SurfaceCallback.onStableAreaChanged メソッドを呼び出します。この呼び出しでは現在のテンプレートに基づいて常に表示される最小の長方形が使用されます。

たとえば、ナビゲーションアプリが NavigationTemplate を使用していて、上部にアクションストリップがある場合、ユーザーがしばらく画面を操作しなければアクションストリップ自体を非表示にして、地図用のスペースを確保します。この場合、onStableAreaChanged と onVisibleAreaChanged へのコールバックは同じ長方形で行われます。アクションストリップが非表示になると、onVisibleAreaChanged のみがより大きな領域で呼び出されます。ユーザーが画面を操作すると、最初の長方形で onVisibleAreaChanged のみが再度呼び出されます。

ダークモードをサポートする

条件を満たしているとホストが判断した場合、アプリは自動車向け Android アプリの品質の説明のとおり、適切な暗い色を使用して Surface インスタンスに地図を再描画する必要があります。

暗い色の地図を描画するかどうかの判断には、CarContext.isDarkMode メソッドを使用できます。ダークモードのステータスが変更されるたびに、Session.onCarConfigurationChanged の呼び出しを受け取ります。

ユーザーが地図を操作できるようにする

次のテンプレートを使用する場合は、ユーザーが描画した地図を操作できるようにサポートを追加できます。たとえば、ズームやパンによって地図のさまざまな部分を表示できるようにします。

テンプレート	インタラクティビティをサポートする Car App API レベル
`NavigationTemplate`	2
`PlaceListNavigationTemplate`（非推奨）	4
`RoutePreviewNavigationTemplate`（非推奨）	4
`MapTemplate`（非推奨）	5（テンプレートの導入）
`MapWithContentTemplate`	7（テンプレートの導入）

インタラクティビティコールバックを実装する

SurfaceCallback インターフェースには、前のセクションのテンプレートを使用して作成した地図にインタラクティビティを追加するために実装できるコールバックメソッドがいくつかあります。

操作	`SurfaceCallback` メソッド	サポートする Car App API レベル
タップ	`onClick`	5
ピンチしてズーム	`onScale`	2
シングルタップドラッグ	`onScroll`	2
シングルタップフリング	`onFling`	2
ダブルタップ	`onScale`（スケーリングファクタはテンプレートホストによって決まる）	2
パンモードの回転ナッジ	`onScroll`（距離ファクタはテンプレートホストによって決まる）	2

マップアクションストリップを追加する

これらのテンプレートでは、地図に関連する操作（拡大 / 縮小、センタリング、コンパスの表示など、アプリで可能にする操作）に対応する、マップアクションストリップを設定できます。マップアクションストリップには、タスクの階層を変更することなく更新できる、アイコンのみのボタンを 4 つまで設定できます。このボタンはアイドル状態では非表示になり、アクティブな状態になると再び表示されます。

マップのインタラクティビティコールバックを受け取るようにするには、マップアクションストリップに Action.PAN ボタンを追加する必要があります。次のセクションで説明しているとおり、ユーザーがパンボタンを押すと、ホストはパンモードに入ります。

アプリのマップアクションストリップに Action.PAN ボタンを設定しない場合、SurfaceCallback メソッドからユーザー入力を取得できず、ホストで有効になっていたパンモードが終了します。

パンボタンはタッチスクリーンには表示されません。

パンモードについて

パンモードでは、ノンタッチの入力デバイス（ロータリーコントローラやタッチパッドなど）からのユーザー入力が、テンプレートホストによって適切な SurfaceCallback メソッドに変換されます。パンモードを開始または終了するユーザー操作には、NavigationTemplate.Builder の setPanModeListener メソッドで応答します。ユーザーがパンモードのときは、テンプレートの他の UI コンポーネントを非表示にできます。

ユーザーとやり取りする

アプリは、モバイルアプリと同様のパターンを使用してユーザーとやり取りできます。

ユーザー入力を処理する

アプリは、適切なリスナーをそれらをサポートするモデルに渡すことで、ユーザー入力に応答できます。次のスニペットは、アプリのコードで定義されたメソッドにコールバックする OnClickListener を設定する Action モデルを作成する方法を示しています。

Kotlin

val action = Action.Builder()
    .setTitle("Navigate")
    .setOnClickListener(::onClickNavigate)
    .build()

Java

Action action = new Action.Builder()
    .setTitle("Navigate")
    .setOnClickListener(this::onClickNavigate)
    .build();

次に、onClickNavigate メソッドは CarContext.startCarApp メソッドを使用して、デフォルトのナビゲーション自動車アプリを起動します。

Kotlin

private fun onClickNavigate() {
    val intent = Intent(CarContext.ACTION_NAVIGATE, Uri.parse("geo:0,0?q=" + address))
    carContext.startCarApp(intent)
}

Java

private void onClickNavigate() {
    Intent intent = new Intent(CarContext.ACTION_NAVIGATE, Uri.parse("geo:0,0?q=" + address));
    getCarContext().startCarApp(intent);
}

ACTION_NAVIGATE インテントの形式など、アプリの起動方法について詳しくは、インテントを使用して自動車アプリを起動するをご覧ください。

インタラクションの続きをモバイルデバイスで行うようにユーザーをガイドするアクションなど、特定のアクションは車がパーキング状態にあるときに限り許可されます。このようなアクションの実装には、ParkedOnlyOnClickListener を使用します。車がパーキング状態にない場合、ホストはユーザーにメッセージを表示して、その状態ではアクションが許可されないことを示します。車がパーキング状態にある場合、コードは正常に実行されます。次のスニペットは、ParkedOnlyOnClickListener を使用してモバイルデバイスで設定画面を開く方法を示しています。

Kotlin

val row = Row.Builder()
    .setTitle("Open Settings")
    .setOnClickListener(ParkedOnlyOnClickListener.create(::openSettingsOnPhone))
    .build()

Java

Row row = new Row.Builder()
    .setTitle("Open Settings")
    .setOnClickListener(ParkedOnlyOnClickListener.create(this::openSettingsOnPhone))
    .build();

通知を表示する

モバイルデバイスに送信された通知は、CarAppExtender で拡張された場合にのみ車の画面に表示されます。コンテンツのタイトル、テキスト、アイコン、アクションなど、一部の通知属性は CarAppExtender でも設定でき、車の画面に表示されるときは、この設定が通知の属性をオーバーライドします。

次のスニペットは、モバイルデバイスとは異なるタイトルで、通知を車の画面に送信する方法を示しています。

Kotlin

val notification = NotificationCompat.Builder(context, NOTIFICATION_CHANNEL_ID)
    .setContentTitle(titleOnThePhone)
    .extend(
        CarAppExtender.Builder()
            .setContentTitle(titleOnTheCar)
            ...
            .build())
    .build()

Java

Notification notification = new NotificationCompat.Builder(context, NOTIFICATION_CHANNEL_ID)
    .setContentTitle(titleOnThePhone)
    .extend(
        new CarAppExtender.Builder()
            .setContentTitle(titleOnTheCar)
            ...
            .build())
    .build();

通知は、ユーザーインターフェースの次の部分に影響する場合があります。

ヘッドアップ通知（HUN）がユーザーに表示されることがあります。
通知センターにエントリが追加されたり、必要に応じて、レールにバッジが表示されたりすることがあります。
ナビゲーションアプリの場合、ターンバイターン通知の説明にあるように、レールウィジェットに通知が表示されることがあります。

CarAppExtender ドキュメントの説明のとおり、どのユーザーインターフェース要素に影響する通知にするかを、通知の優先度を使ってアプリの通知を構成できます。

NotificationCompat.Builder.setOnlyAlertOnce を値 true で呼び出した場合、優先度の高い通知は HUN として 1 回だけ表示されます。

自動車アプリの通知を設計する方法について詳しくは、通知に関する Google の運転向け設計ガイドをご覧ください。

トーストを表示する

次のスニペットに示すように、アプリで CarToast を使用してトーストを表示できます。

Kotlin

CarToast.makeText(carContext, "Hello!", CarToast.LENGTH_SHORT).show()

Java

CarToast.makeText(getCarContext(), "Hello!", CarToast.LENGTH_SHORT).show();

権限をリクエストする

アプリが制限付きのデータやアクション（位置情報など）にアクセスする必要がある場合、Android 権限の標準ルールが適用されます。権限をリクエストするには、CarContext.requestPermissions() メソッドを使用します。

標準 Android API ではなく CarContext.requestPermissions() を使用すると、権限ダイアログを作成するだけのために独自の Activity を起動しなくてよいというメリットがあります。さらに、プラットフォームに依存するフローを作成することなく、Android Auto と Android Automotive OS の両方で同じコードを使用できます。

Android Auto の権限ダイアログのスタイルを設定する

Android Auto では、ユーザーの権限ダイアログがスマートフォンに表示されます。デフォルトでは、ダイアログの背後に背景はありません。カスタムバックグラウンドを設定するには、AndroidManifest.xml ファイルで自動車アプリのテーマを宣言し、自動車アプリのテーマの carPermissionActivityLayout 属性を設定します。

<meta-data
    android:name="androidx.car.app.theme"
    android:resource="@style/MyCarAppTheme />

次に、カーアプリのテーマに carPermissionActivityLayout 属性を設定します。

<resources>
  <style name="MyCarAppTheme">
    <item name="carPermissionActivityLayout">@layout/my_custom_background</item>
  </style>
</resources>

インテントを使用して自動車アプリを起動する

CarContext.startCarApp メソッドを呼び出して、次のアクションのいずれかを実行できます。

電話アプリを開いて電話をかける。
デフォルトのナビゲーション自動車アプリで、ターンバイターン方式のナビゲーションを開始する。
インテントを使用して独自のアプリを起動する。

次の例は、駐車予約の詳細を表示する画面でアプリを開く、というアクションを含む通知を作成する方法を示しています。コンテンツインテントを使用して通知インスタンスを拡張します。コンテンツインテントには、アプリのアクションに対する明示的なインテントをラップした PendingIntent が含まれます。

Kotlin

val notification = notificationBuilder
    ...
    .extend(
        CarAppExtender.Builder()
            .setContentIntent(
                PendingIntent.getBroadcast(
                    context,
                    ACTION_VIEW_PARKING_RESERVATION.hashCode(),
                    Intent(ACTION_VIEW_PARKING_RESERVATION)
                        .setComponent(ComponentName(context, MyNotificationReceiver::class.java)),
                    0))
            .build())

Java

Notification notification = notificationBuilder
    ...
    .extend(
        new CarAppExtender.Builder()
            .setContentIntent(
                PendingIntent.getBroadcast(
                    context,
                    ACTION_VIEW_PARKING_RESERVATION.hashCode(),
                    new Intent(ACTION_VIEW_PARKING_RESERVATION)
                        .setComponent(new ComponentName(context, MyNotificationReceiver.class)),
                    0))
            .build());

また、アプリは BroadcastReceiver も宣言する必要があります。このクラスは、ユーザーが通知インターフェースで対応するアクションを選択すると、インテントを処理するために呼び出され、データ URI を含むインテントが記述されている CarContext.startCarApp を呼び出します。

Kotlin

class MyNotificationReceiver : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {
        val intentAction = intent.action
        if (ACTION_VIEW_PARKING_RESERVATION == intentAction) {
            CarContext.startCarApp(
                intent,
                Intent(Intent.ACTION_VIEW)
                    .setComponent(ComponentName(context, MyCarAppService::class.java))
                    .setData(Uri.fromParts(MY_URI_SCHEME, MY_URI_HOST, intentAction)))
        }
    }
}

Java

public class MyNotificationReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        String intentAction = intent.getAction();
        if (ACTION_VIEW_PARKING_RESERVATION.equals(intentAction)) {
            CarContext.startCarApp(
                intent,
                new Intent(Intent.ACTION_VIEW)
                    .setComponent(new ComponentName(context, MyCarAppService.class))
                    .setData(Uri.fromParts(MY_URI_SCHEME, MY_URI_HOST, intentAction)));
        }
    }
}

最後に、アプリの Session.onNewIntent メソッドがこのインテントを処理し、駐車予約画面をスタックにプッシュします（予約画面がまだ一番上にない場合）。

Kotlin

override fun onNewIntent(intent: Intent) {
    val screenManager = carContext.getCarService(ScreenManager::class.java)
    val uri = intent.data
    if (uri != null
        && MY_URI_SCHEME == uri.scheme
        && MY_URI_HOST == uri.schemeSpecificPart
        && ACTION_VIEW_PARKING_RESERVATION == uri.fragment
    ) {
        val top = screenManager.top
        if (top !is ParkingReservationScreen) {
            screenManager.push(ParkingReservationScreen(carContext))
        }
    }
}

Java

@Override
public void onNewIntent(@NonNull Intent intent) {
    ScreenManager screenManager = getCarContext().getCarService(ScreenManager.class);
    Uri uri = intent.getData();
    if (uri != null
        && MY_URI_SCHEME.equals(uri.getScheme())
        && MY_URI_HOST.equals(uri.getSchemeSpecificPart())
        && ACTION_VIEW_PARKING_RESERVATION.equals(uri.getFragment())
    ) {
        Screen top = screenManager.getTop();
        if (!(top instanceof ParkingReservationScreen)) {
            screenManager.push(new ParkingReservationScreen(getCarContext()));
        }
    }
}

自動車アプリの通知処理方法について詳しくは、通知を表示するをご覧ください。

テンプレートの制限事項

ホストは、1 つのタスクに対して表示されるテンプレートの数を最大 5 つに制限します。これらの 5 つのテンプレートのうち、最後のテンプレートは、次のいずれかのタイプである必要があります。

なお、この制限はテンプレートの数に適用されますが、スタック内の Screen インスタンスの数には適用されません。たとえば、アプリが画面 A で 2 つのテンプレートを送信し、次いで画面 B をプッシュした場合、アプリはあと 3 つのテンプレートを送信できます。これに対し、各画面が 1 つのテンプレートを送信するように構成されている場合、アプリは 5 つの画面インスタンスを ScreenManager スタックにプッシュできます。

これらの制限については、テンプレートの更新、戻る操作、リセット操作など、特殊なケースがいくつかあります。

テンプレートの更新

特定のコンテンツの更新は、テンプレートの割り当てに対してカウントされません。一般に、アプリが新しいテンプレートをプッシュしても、そのタイプと、そこに含まれるメインコンテンツが前のテンプレートと同じである限り、その新しいテンプレートは割り当てに対してカウントされません。たとえば、ListTemplate 内で行の切り替え状態を更新しても、割り当てに対するカウントは行われません。どのような種類のコンテンツ更新がテンプレートの更新としてカウントされるかについて詳しくは、個々のテンプレートのドキュメントをご覧ください。

戻る操作

1 つのタスク内でサブフローを有効にできるように、アプリが ScreenManager スタックから Screen をポップすると、ホストがこれを検出し、アプリの戻る操作後のテンプレート数に基づいて残りの割り当てを更新します。

たとえば、アプリが画面 A で 2 つのテンプレートを送信してから、画面 B をプッシュし、さらに 2 つのテンプレートを送信した場合、アプリの残りの割り当ては 1 つになります。アプリが画面 A に戻った場合、ホストは割り当てを 3 にリセットします。これは、アプリが 2 つのテンプレート分前に戻ったためです。

画面に戻るとき、アプリは、その画面で最後に送信したテンプレートと同じタイプのテンプレートを送信する必要があります。それ以外のテンプレートタイプを送信すると、エラーが発生します。ただし、戻る操作時にタイプが同じのままであれば、アプリは割り当てに影響を与えることなくテンプレートのコンテンツを自由に変更できます。

リセット操作

一部のテンプレートには、タスクの終了を示す特別なセマンティクスがあります。たとえば、NavigationTemplate は、画面に継続して残り、ユーザーのための新しいターンバイターン方式の指示で更新される必要があるビューです。このテンプレートが使用されると、ホストはテンプレートの割り当てをリセットし、そのテンプレートを新しいタスクの最初のステップとして扱います。これにより、アプリは新しいタスクを開始できます。ホスト上でリセットがトリガーされるテンプレートについては、個々のテンプレートのドキュメントをご覧ください。

ホストが通知アクションまたはランチャーからアプリを起動するインテントを受け取ると、割り当てもリセットされます。このメカニズムにより、アプリがバインドされてフォアグラウンドで実行されている場合でも、アプリは通知から新しいタスクフローを開始できます。

車の画面にアプリの通知を表示する方法について詳しくは、通知を表示するをご覧ください。通知アクションからアプリを起動する方法については、インテントを使用して自動車アプリを起動するをご覧ください。

Connection API

アプリが Android Auto で実行されているか、Android Automotive OS で実行されているかを判断するには、CarConnection API を使用して実行時に接続情報を取得します。

たとえば、自動車向けアプリの Session で CarConnection を初期化し、LiveData の更新をサブスクライブします。

Kotlin

CarConnection(carContext).type.observe(this, ::onConnectionStateUpdated)

Java

new CarConnection(getCarContext()).getType().observe(this, this::onConnectionStateUpdated);

オブザーバーで、接続状態の変化に対応できます。

Kotlin

fun onConnectionStateUpdated(connectionState: Int) {
  val message = when(connectionState) {
    CarConnection.CONNECTION_TYPE_NOT_CONNECTED -> "Not connected to a head unit"
    CarConnection.CONNECTION_TYPE_NATIVE -> "Connected to Android Automotive OS"
    CarConnection.CONNECTION_TYPE_PROJECTION -> "Connected to Android Auto"
    else -> "Unknown car connection type"
  }
  CarToast.makeText(carContext, message, CarToast.LENGTH_SHORT).show()
}

Java

private void onConnectionStateUpdated(int connectionState) {
  String message;
  switch(connectionState) {
    case CarConnection.CONNECTION_TYPE_NOT_CONNECTED:
      message = "Not connected to a head unit";
      break;
    case CarConnection.CONNECTION_TYPE_NATIVE:
      message = "Connected to Android Automotive OS";
      break;
    case CarConnection.CONNECTION_TYPE_PROJECTION:
      message = "Connected to Android Auto";
      break;
    default:
      message = "Unknown car connection type";
      break;
  }
  CarToast.makeText(getCarContext(), message, CarToast.LENGTH_SHORT).show();
}

Constraints API

車種によって、一度にユーザーに表示できる Item インスタンスの数は異なります。ConstraintManager を使用して、実行時にコンテンツの上限を確認し、テンプレートで適切なアイテム数を設定します。

まず、CarContext から ConstraintManager を取得します。

Kotlin

val manager = carContext.getCarService(ConstraintManager::class.java)

Java

ConstraintManager manager = getCarContext().getCarService(ConstraintManager.class);

取得した ConstraintManager オブジェクトに対してクエリを実行し、関連するコンテンツの上限を確認できます。たとえば、グリッドに表示できるアイテムの数を取得するには、CONTENT_LIMIT_TYPE_GRID で getContentLimit を呼び出します。

Kotlin

val gridItemLimit = manager.getContentLimit(ConstraintManager.CONTENT_LIMIT_TYPE_GRID)

Java

int gridItemLimit = manager.getContentLimit(ConstraintManager.CONTENT_LIMIT_TYPE_GRID);

アプリでユーザーログイン中の操作を提供している場合は、自動車向けアプリの API レベル 2 以上で SignInTemplate や LongMessageTemplate などのテンプレートを使用して、車のヘッドユニットでアプリへのログインを処理できます。

SignInTemplate を作成するには、SignInMethod を定義します。自動車向けアプリライブラリは現在、次の 3 つの方法でのログインが可能です。

InputSignInMethod を使用したユーザー名/パスワードによるログイン。
PinSignInMethod を使用した PIN によるログイン。ユーザーはヘッドユニットに表示された PIN を使用して、スマートフォンからアカウントをリンクします。
ProviderSignInMethod を使用したプロバイダログイン（Google ログイン、ワンタップなど）
QRCodeSignInMethod: QR コードによるログイン。ユーザーが QR コードをスキャンしてスマートフォンでログインを完了します。これは、Car API レベル 4 以降で使用できます。

たとえば、ユーザーのパスワードを収集するテンプレートを実装するには、まず InputCallback を作成してユーザー入力の処理と検証を行います。

Kotlin

val callback = object : InputCallback {
    override fun onInputSubmitted(text: String) {
        // You will receive this callback when the user presses Enter on the keyboard.
    }

    override fun onInputTextChanged(text: String) {
        // You will receive this callback as the user is typing. The update
        // frequency is determined by the host.
    }
}

Java

InputCallback callback = new InputCallback() {
    @Override
    public void onInputSubmitted(@NonNull String text) {
        // You will receive this callback when the user presses Enter on the keyboard.
    }

    @Override
    public void onInputTextChanged(@NonNull String text) {
        // You will receive this callback as the user is typing. The update
        // frequency is determined by the host.
    }
};

InputSignInMethod Builder には InputCallback が必要です。

Kotlin

val passwordInput = InputSignInMethod.Builder(callback)
    .setHint("Password")
    .setInputType(InputSignInMethod.INPUT_TYPE_PASSWORD)
    ...
    .build()

Java

InputSignInMethod passwordInput = new InputSignInMethod.Builder(callback)
    .setHint("Password")
    .setInputType(InputSignInMethod.INPUT_TYPE_PASSWORD)
    ...
    .build();

最後に、新しい InputSignInMethod を使用して SignInTemplate を作成します。

Kotlin

SignInTemplate.Builder(passwordInput)
    .setTitle("Sign in with username and password")
    .setInstructions("Enter your password")
    .setHeaderAction(Action.BACK)
    ...
    .build()

Java

new SignInTemplate.Builder(passwordInput)
    .setTitle("Sign in with username and password")
    .setInstructions("Enter your password")
    .setHeaderAction(Action.BACK)
    ...
    .build();

AccountManager を使用する

認証が必要な Android Automotive OS アプリでは、次の理由により AccountManager を使用する必要があります。

優れたユーザーエクスペリエンスと容易なアカウント管理: ユーザーは、システム設定のアカウントメニューから、すべてのアカウントを簡単に管理（ログイン / ログアウトを含む）できます。
「ゲスト」エクスペリエンス: 自動車は共有デバイスであるため、OEM は車両でゲストエクスペリエンスを有効にして、アカウントの追加が行われないようにできます。

テキスト文字列のバリエーションを追加する

自動車の画面サイズに応じて、表示されるテキストの量は異なります。自動車向けアプリの API レベル 2 以上では、画面に合う最適なテキスト文字列のバリエーションを複数指定できます。テキストのバリエーションを使用できる場所を確認するには、CarText を使用するテンプレートとコンポーネントを探してください。

テキスト文字列のバリエーションを CarText に追加するには、CarText.Builder.addVariant() メソッドを使用します。

Kotlin

val itemTitle = CarText.Builder("This is a very long string")
    .addVariant("Shorter string")
    ...
    .build()

Java

CarText itemTitle = new CarText.Builder("This is a very long string")
    .addVariant("Shorter string")
    ...
    .build();

たとえば、この CarText を GridItem のメインテキストとして使用できます。

Kotlin

GridItem.Builder()
    .addTitle(itemTitle)
    ...
    .build()

Java

new GridItem.Builder()
    .addTitle(itemTitle)
    ...
    build();

文字列は優先度の高い順（たとえば文字列が長い順）に追加します。ホストは車の画面上のスペースに応じて、適切な長さの文字列を選択します。

行にインラインの CarIcon を追加

CarIconSpan を使用して、テキストにアイコンをインラインで追加し、アプリの視覚的な魅力を高めることができます。これらのスパンの作成について詳しくは、CarIconSpan.create のドキュメントをご覧ください。スパンを使用したテキストスタイル設定の仕組みの概要については、Spantastic text styling with Spans をご覧ください。

Kotlin

  
val rating = SpannableString("Rating: 4.5 stars")
rating.setSpan(
    CarIconSpan.create(
        // Create a CarIcon with an image of four and a half stars
        CarIcon.Builder(...).build(),
        // Align the CarIcon to the baseline of the text
        CarIconSpan.ALIGN_BASELINE
    ),
    // The start index of the span (index of the character '4')
    8,
    // The end index of the span (index of the last 's' in "stars")
    16,
    Spanned.SPAN_INCLUSIVE_INCLUSIVE
)

val row = Row.Builder()
    ...
    .addText(rating)
    .build()

Java

  
SpannableString rating = new SpannableString("Rating: 4.5 stars");
rating.setSpan(
        CarIconSpan.create(
                // Create a CarIcon with an image of four and a half stars
                new CarIcon.Builder(...).build(),
                // Align the CarIcon to the baseline of the text
                CarIconSpan.ALIGN_BASELINE
        ),
        // The start index of the span (index of the character '4')
        8,
        // The end index of the span (index of the last 's' in "stars")
        16,
        Spanned.SPAN_INCLUSIVE_INCLUSIVE
);
Row row = new Row.Builder()
        ...
        .addText(rating)
        .build();

カーハードウェア API

自動車向けアプリ API レベル 3 以降では、自動車向けアプリライブラリに、車両のプロパティとセンサーにアクセスするために使用できる API が用意されています。

要件

Android Auto で API を使用するには、まず Android Auto モジュールの build.gradle ファイルに androidx.car.app:app-projected の依存関係を追加します。Android Automotive OS の場合は、Android Automotive OS モジュールの build.gradle ファイルに androidx.car.app:app-automotive の依存関係を追加します。

また、AndroidManifest.xml ファイルで、使用する自動車データをリクエストするために必要な関連する権限を宣言する必要があります。これらの権限は、ユーザーから付与される必要があります。プラットフォームによって異なるフローを作成することなく、Android Auto と Android Automotive OS の両方で同じコードを使用できます。ただし、必要な権限は異なります。

CarInfo

次の表に、CarInfo API によって公開されるプロパティと、それらのプロパティを使用する際にリクエストする必要がある権限を示します。

メソッド	プロパティ	Android Auto の権限	Android Automotive OS の権限	サポートする Car App API レベル
`fetchModel`	メーカー、モデル、年式		`android.car.permission.CAR_INFO`	3
`fetchEnergyProfile`	EV のコネクタの種類、燃料の種類	`com.google.android.gms.permission.CAR_FUEL`	`android.car.permission.CAR_INFO`	3
`fetchExteriorDimensions` このデータは、API 30 以降を搭載した一部の Android Automotive OS 搭載車でのみ利用できます	外寸	なし	`android.car.permission.CAR_INFO`	7
`addTollListener` `removeTollListener`	通行料金カードの状態、通行料金カードの種類			3
`addEnergyLevelListener` `removeEnergyLevelListener`	バッテリー残量、燃料残量、燃料残量が少ない、残りの航続距離	`com.google.android.gms.permission.CAR_FUEL`	`android.car.permission.CAR_ENERGY`、 `android.car.permission.CAR_ENERGY_PORTS`、 `android.car.permission.READ_CAR_DISPLAY_UNITS`	3
`addSpeedListener` `removeSpeedListener`	実際の速度、表示速度（車のクラスタディスプレイに表示）	`com.google.android.gms.permission.CAR_SPEED`	`android.car.permission.CAR_SPEED`、 `android.car.permission.READ_CAR_DISPLAY_UNITS`	3
`addMileageListener` `removeMileageListener`	走行距離計の距離	`com.google.android.gms.permission.CAR_MILEAGE`	Android Automotive OS では、Google Play ストアからインストールされたアプリに対してこのデータを使用できません。	3

たとえば、残りの範囲を取得するには、CarInfo オブジェクトをインスタンス化し、OnCarDataAvailableListener を作成して登録します。

Kotlin

val carInfo = carContext.getCarService(CarHardwareManager::class.java).carInfo

val listener = OnCarDataAvailableListener<EnergyLevel> { data ->
    if (data.rangeRemainingMeters.status == CarValue.STATUS_SUCCESS) {
      val rangeRemaining = data.rangeRemainingMeters.value
    } else {
      // Handle error
    }
  }

carInfo.addEnergyLevelListener(carContext.mainExecutor, listener)
…
// Unregister the listener when you no longer need updates
carInfo.removeEnergyLevelListener(listener)

Java

CarInfo carInfo = getCarContext().getCarService(CarHardwareManager.class).getCarInfo();

OnCarDataAvailableListener<EnergyLevel> listener = (data) -> {
  if(data.getRangeRemainingMeters().getStatus() == CarValue.STATUS_SUCCESS) {
    float rangeRemaining = data.getRangeRemainingMeters().getValue();
  } else {
    // Handle error
  }
};

carInfo.addEnergyLevelListener(getCarContext().getMainExecutor(), listener);
…
// Unregister the listener when you no longer need updates
carInfo.removeEnergyLevelListener(listener);

車からのデータが常に利用可能であるとは限りません。エラーが発生した場合は、リクエストした値のステータスを確認して、リクエストしたデータを取得できなかった理由を把握します。CarInfo クラスの完全な定義については、リファレンスドキュメントをご覧ください。

CarSensors

CarSensors クラスを使用すると、車両の加速度計、ジャイロスコープ、コンパス、位置情報にアクセスできます。これらの値が利用できるかどうかは、OEM によって異なります。加速度計、ジャイロスコープ、コンパスのデータ形式は、SensorManager API から取得するデータと同じです。たとえば、車両の向きをチェックするには:

Kotlin

val carSensors = carContext.getCarService(CarHardwareManager::class.java).carSensors

val listener = OnCarDataAvailableListener<Compass> { data ->
    if (data.orientations.status == CarValue.STATUS_SUCCESS) {
      val orientation = data.orientations.value
    } else {
      // Data not available, handle error
    }
  }

carSensors.addCompassListener(CarSensors.UPDATE_RATE_NORMAL, carContext.mainExecutor, listener)
…
// Unregister the listener when you no longer need updates
carSensors.removeCompassListener(listener)

Java

CarSensors carSensors = getCarContext().getCarService(CarHardwareManager.class).getCarSensors();

OnCarDataAvailableListener<Compass> listener = (data) -> {
  if (data.getOrientations().getStatus() == CarValue.STATUS_SUCCESS) {
    List<Float> orientations = data.getOrientations().getValue();
  } else {
    // Data not available, handle error
  }
};

carSensors.addCompassListener(CarSensors.UPDATE_RATE_NORMAL, getCarContext().getMainExecutor(),
    listener);
…
// Unregister the listener when you no longer need updates
carSensors.removeCompassListener(listener);

自動車の位置情報にアクセスするには、android.permission.ACCESS_FINE_LOCATION 権限を宣言してリクエストすることも必要です。

テスト

Android Auto でテストするときにセンサーデータをシミュレートするには、デスクトップヘッドユニットガイドのセンサーとセンサーの構成のセクションをご覧ください。Android Automotive OS でテストする際にセンサーデータをシミュレートするには、Android Automotive OS エミュレータガイドのハードウェアの状態をシミュレートするセクションをご覧ください。

CarAppService、セッション、画面のライフサイクル

Session クラスと Screen クラスは、LifecycleOwner インターフェースを実装します。ユーザーがアプリを操作すると、Session オブジェクトと Screen オブジェクトのライフサイクルコールバックが呼び出されます。次の図をご覧ください。

CarAppService とセッションのライフサイクル

詳細については、Session.getLifecycle メソッドのドキュメントをご覧ください。

画面のライフサイクル

詳細については、Screen.getLifecycle メソッドのドキュメントをご覧ください。

車のマイクから録音する

アプリの CarAppService と CarAudioRecord API を使用して、アプリにユーザーの自動車のマイクへのアクセス権を付与できます。ユーザーは、車のマイクへのアクセスをアプリに許可する必要があります。アプリは、アプリ内でユーザーの入力を記録して処理できます。

録音の許可

音声を録音する前に、まず AndroidManifest.xml で録音の権限を宣言し、ユーザーに権限を付与するようリクエストする必要があります。

<manifest ...>
   ...
   <uses-permission android:name="android.permission.RECORD_AUDIO" />
   ...
</manifest>

録音する権限は実行時にリクエストする必要があります。自動車アプリで権限をリクエストする方法については、権限をリクエストするをご覧ください。

音声を記録する

ユーザーが録音を許可すると、音声を録音して録音を処理できます。

Kotlin

val carAudioRecord = CarAudioRecord.create(carContext)
        carAudioRecord.startRecording()

        val data = ByteArray(CarAudioRecord.AUDIO_CONTENT_BUFFER_SIZE)
        while(carAudioRecord.read(data, 0, CarAudioRecord.AUDIO_CONTENT_BUFFER_SIZE) >= 0) {
            // Use data array
            // Potentially call carAudioRecord.stopRecording() if your processing finds end of speech
        }
        carAudioRecord.stopRecording()

Java

CarAudioRecord carAudioRecord = CarAudioRecord.create(getCarContext());
        carAudioRecord.startRecording();

        byte[] data = new byte[CarAudioRecord.AUDIO_CONTENT_BUFFER_SIZE];
        while (carAudioRecord.read(data, 0, CarAudioRecord.AUDIO_CONTENT_BUFFER_SIZE) >= 0) {
            // Use data array
            // Potentially call carAudioRecord.stopRecording() if your processing finds end of speech
        }
        carAudioRecord.stopRecording();

音声フォーカス

車のマイクから録音する場合は、まずオーディオフォーカスを取得して、進行中のメディアが停止していることを確認します。音声フォーカスを失った場合は、録音を停止します。

音声フォーカスを取得する方法の例を次に示します。

Kotlin

 
val carAudioRecord = CarAudioRecord.create(carContext)
        
        // Take audio focus so that user's media is not recorded
        val audioAttributes = AudioAttributes.Builder()
            .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
            // Use the most appropriate usage type for your use case
            .setUsage(AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE)
            .build()
        
        val audioFocusRequest =
            AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE)
                .setAudioAttributes(audioAttributes)
                .setOnAudioFocusChangeListener { state: Int ->
                    if (state == AudioManager.AUDIOFOCUS_LOSS) {
                        // Stop recording if audio focus is lost
                        carAudioRecord.stopRecording()
                    }
                }
                .build()
        
        if (carContext.getSystemService(AudioManager::class.java)
                .requestAudioFocus(audioFocusRequest)
            != AudioManager.AUDIOFOCUS_REQUEST_GRANTED
        ) {
            // Don't record if the focus isn't granted
            return
        }
        
        carAudioRecord.startRecording()
        // Process the audio and abandon the AudioFocusRequest when done

Java

CarAudioRecord carAudioRecord = CarAudioRecord.create(getCarContext());
        // Take audio focus so that user's media is not recorded
        AudioAttributes audioAttributes =
                new AudioAttributes.Builder()
                        .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
                        // Use the most appropriate usage type for your use case
                        .setUsage(AudioAttributes.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE)
                        .build();

        AudioFocusRequest audioFocusRequest =
                new AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE)
                        .setAudioAttributes(audioAttributes)
                        .setOnAudioFocusChangeListener(state -> {
                            if (state == AudioManager.AUDIOFOCUS_LOSS) {
                                // Stop recording if audio focus is lost
                                carAudioRecord.stopRecording();
                            }
                        })
                        .build();

        if (getCarContext().getSystemService(AudioManager.class).requestAudioFocus(audioFocusRequest)
                != AUDIOFOCUS_REQUEST_GRANTED) {
            // Don't record if the focus isn't granted
            return;
        }

        carAudioRecord.startRecording();
        // Process the audio and abandon the AudioFocusRequest when done

テストライブラリ

自動車向け Android のテストライブラリは、テスト環境でのアプリの動作検証に使用できる補助クラスを提供します。たとえば、SessionController を使用すると、ホストへの接続をシミュレートして、正しい Screen と Template が作成されて返されることを確認できます。

使用例については、サンプルをご覧ください。

自動車向け Android アプリライブラリに関する問題を報告する

ライブラリに問題が見つかった場合は、Google Issue Tracker を使用して報告します。問題テンプレートに必要な情報をすべて記入してください。

新しい問題を報告する

新しい問題を報告する前に、その問題がライブラリのリリースノートに記載されていないか、すでに問題リスト内で報告されていないかご確認ください。Issue Tracker 内で各問題の横にあるスターアイコンをクリックすると、問題を登録して投票することができます。詳細については、問題を登録する手順をご覧ください。

自動車向け Android アプリ ライブラリを使用する

始める前に

主な用語と概念

Car App Library をインストールする

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

CarAppService を宣言する

サポートされているアプリのカテゴリ

アプリの名前とアイコンを指定する

カスタムテーマを設定する

自動車向けアプリの API レベル

CarAppService とセッションを作成する

Kotlin

Java

Kotlin

Java

起動画面を作成する

Kotlin

Java

CarContext クラス

画面ナビゲーションを実装する

Kotlin

Java

テンプレートのコンテンツを更新する

地図を描画する

サーフェス権限を宣言する

サーフェスにアクセスする

Kotlin

Java

サーフェスの表示可能領域を把握する

ダークモードをサポートする

ユーザーが地図を操作できるようにする

インタラクティビティ コールバックを実装する

マップ アクション ストリップを追加する

パンモードについて

ユーザーとやり取りする

ユーザー入力を処理する

Kotlin

Java

Kotlin

Java

Kotlin

Java

通知を表示する

Kotlin

Java

トーストを表示する

Kotlin

Java

権限をリクエストする

Android Auto の権限ダイアログのスタイルを設定する

インテントを使用して自動車アプリを起動する

Kotlin

Java

Kotlin

Java

Kotlin

Java

テンプレートの制限事項

テンプレートの更新

戻る操作

リセット操作

Connection API

Kotlin

Java

Kotlin

Java

Constraints API

Kotlin

Java

Kotlin

Java

ログインフローを追加する

Kotlin

Java

Kotlin

Java

Kotlin

Java

AccountManager を使用する

テキスト文字列のバリエーションを追加する

自動車向け Android アプリライブラリを使用する

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

インタラクティビティコールバックを実装する

マップアクションストリップを追加する

カーハードウェア API

テストライブラリ

自動車向け Android アプリライブラリに関する問題を報告する