使用車輛專用 Android App Library

車輛專用 Android App Library 可讓您將導航、搜尋點和物聯網 (IoT) 應用程式移至車上。方法是提供一組範本，以符合駕駛人分心等級的標準，並妥善處理各種細節，例如各種車輛螢幕因素和輸入型態。

本指南提供程式庫主要功能和概念的總覽，並會逐步引導您設定簡易應用程式。如需完整的逐步說明，請參閱瞭解 Car App Library 基礎知識程式碼研究室。

事前準備

1. 查看「Design for Driving」頁面，其中會說明 Car App Library
   • 導航應用程式和其他駕駛相關應用程式類別總覽
   • 「使用範本建構應用程式」總覽
   • 建構模塊：涵蓋範本和範本元件
   • 展示常見的使用者體驗模式的流程範例
   • 範本應用程式規定
2. 請查看下一節的重要詞彙和概念。
3. 熟悉 Android Auto 系統 UI 和 Android Automotive OS 設計。
4. 查看版本資訊。
5. 查看範例。

重要詞彙與概念

模型與範本

使用者介面以模型物件圖表表示，這些物件可以採用不同方式組合，如所屬範本允許。範本是模型的子集，可做為這些圖表的根。模型包含要以文字和圖片形式向使用者顯示的資訊，以及可設定這類資訊視覺外觀的屬性 (例如文字顏色或圖片大小)。主機會將模型轉換為符合駕駛人分心等級標準並處理細節，例如各種車輛螢幕因素和輸入型態。

主機

主機是後端元件，可實作程式庫 API 提供的功能，以便應用程式在車內執行。主機的責任包括探索應用程式及管理生命週期，以及將模型轉換為檢視畫面，以及通知應用程式使用者互動情形。以行動裝置來說，這個主機是由 Android Auto 實作。在 Android Automotive OS 上，這個主機是以系統應用程式的形式安裝。

範本限制

不同的範本會使模型的內容受到限制。例如，清單範本對可向使用者顯示的項目數量設有限制。範本也有一些限制，規範其連結方式可形成工作流程。例如，應用程式最多只能將五個範本推送至螢幕堆疊。詳情請參閱「範本限制」一節。

Screen

Screen 是應用程式實作的程式庫提供的類別，可管理向使用者顯示的使用者介面。Screen 具有生命週期，並提供在螢幕顯示時，讓應用程式傳送範本的機制。您也可以向 Screen 堆疊推送及彈出 Screen 執行個體，確保遵守範本流程限制。

CarAppService

CarAppService 是抽象 Service 類別，應用程式必須實作及匯出，才能讓主機探索及管理。應用程式的 CarAppService 負責使用 createHostValidator 驗證主機連線是否可受信任，然後針對使用 onCreateSession 的每個連線提供 Session 執行個體。

Session

Session 是抽象類別，應用程式必須使用 CarAppService.onCreateSession 實作及傳回。可做為在車輛螢幕上顯示資訊的進入點。它具有生命週期，可通知應用程式目前的狀態，例如應用程式可見或隱藏。

Session 啟動時 (例如應用程式首次啟動時)，主機要求使用 onCreateScreen 方法顯示初始 Screen。

安裝車輛應用程式程式庫

如要瞭解如何將程式庫新增至應用程式，請參閱 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 時，請在意圖篩選器中加入下列一或多個類別值，以宣告應用程式的類別：

• androidx.car.app.category.NAVIGATION：提供即時路線導航路線的應用程式。如需這個類別的其他說明文件，請參閱「建構車用導航應用程式」一文。
• androidx.car.app.category.POI：應用程式提供與搜尋點相關的功能，例如停車場、充電站和加油站。如需這個類別的其他說明文件，請參閱「建構車用搜尋點應用程式」。
• androidx.car.app.category.IOT：可讓使用者在車內對已連結的裝置進行相關操作的應用程式。如需這個類別的其他說明文件，請參閱「建構車用物聯網應用程式」。

請參閱「車用 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 級別

Car App Library 自行定義 API 級別，方便您瞭解車輛的範本主機支援哪些程式庫功能。如要擷取主機支援的最高 Car App API 級別，請使用 getCarAppApiLevel() 方法。

在 AndroidManifest.xml 檔案中宣告應用程式支援的最低 Car App API 級別：

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

如要進一步瞭解如何維持回溯相容性，並宣告使用這項功能所需的最低 API 級別，請參閱 RequiresCarApi 註解的說明文件。如需使用 Car App Library 特定功能所需的 API 級別定義，請參閱 CarAppApiLevels 的參考說明文件。

建立 CarAppService 和工作階段

您的應用程式需要擴充 CarAppService 類別並實作 onCreateSession 方法，以傳回與主機目前連線對應的 Session 執行個體：

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

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

Session 執行個體負責傳回 Screen 執行個體，以便在應用程式首次啟動時使用：

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

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

如要處理車輛應用程式需要從非應用程式主畫面或到達畫面啟動的畫面 (例如處理深層連結)，您可以使用 ScreenManager.push 預先種子堆疊，然後再從 onCreateScreen 傳回。前種子功能可讓使用者從應用程式顯示的第一個畫面返回先前的畫面。

建立您的起始畫面

透過定義擴充 Screen 類別的類別並實作其 onGetTemplate 方法，即可傳回代表 UI 狀態的 Template 執行個體，代表要在車輛螢幕上顯示的 UI 狀態，建立應用程式顯示的畫面。

下列程式碼片段說明如何宣告使用 PaneTemplate 範本顯示簡易「Hello world!」字串的 Screen：

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()
    }
}

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；用於一般應用程式相關功能的 AppManager，例如存取 Surface 物件以繪製導航應用程式地圖，以及與其他{中繼資料}相關導覽應用程式其他 其他相關導覽應用程式所使用的 NavigationManager。

請參閱「存取導覽範本」，取得導航應用程式可用的完整程式庫功能清單。

CarContext 也提供其他功能，例如：使用車輛螢幕的設定載入可繪製資源、使用意圖在車內啟動應用程式，以及指出導航應用程式是否應以深色模式顯示地圖。

實作畫面導覽

應用程式通常會顯示多個不同的畫面，每個畫面可能會使用不同的範本，讓使用者在與畫面顯示的介面互動時能夠瀏覽。

ScreenManager 類別提供螢幕堆疊，可用來推送畫面。當使用者在車輛螢幕上選取返回按鈕，或使用部分車輛提供的硬體返回按鈕時，畫面即可自動彈出。

下列程式碼片段說明如何在訊息範本中新增返回動作，以及在使用者選取時推送新畫面的動作：

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

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 執行個體覆寫此行為。

為確保行車期間應用程式安全無虞，螢幕堆疊的深度上限為五個畫面。詳情請參閱「範本限制」一節。

重新整理範本內容

應用程式可以呼叫 Screen.invalidate 方法，要求使 Screen 的內容失效。主機隨後會呼叫應用程式的 Screen.onGetTemplate 方法，使用新內容擷取範本。

重新整理 Screen 時，請務必瞭解範本中可更新的特定內容，以便主機不會將新範本計入範本配額。詳情請參閱「範本限制」一節。

建議您建構畫面結構，讓 Screen 與透過 onGetTemplate 實作傳回的範本類型之間進行一對一對應。

與使用者互動

您的應用程式可以使用與行動應用程式類似的模式與使用者互動。

處理使用者輸入內容

應用程式可以傳遞適當的事件監聽器給支援這些動作的模型，藉此回應使用者輸入內容。下列程式碼片段說明如何建立 Action 模型，以便設定 OnClickListener 來呼叫應用程式程式碼定義的方法：

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

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

接著，onClickNavigate 方法即可使用 CarContext.startCarApp 方法啟動預設車輛導航應用程式：

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

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

如要進一步瞭解如何啟動應用程式 (包括 ACTION_NAVIGATE 意圖的格式)，請參閱「使用意圖啟動車用應用程式」一節。

有些動作 (例如需要引導使用者繼續在行動裝置上互動的操作) 只能在車輛停妥後執行。您可以使用 ParkedOnlyOnClickListener 來實作這些動作。如果車輛未停妥，主機會向使用者顯示不允許該動作。如果車輛停妥，程式碼會照常執行。下列程式碼片段說明如何使用 ParkedOnlyOnClickListener 在行動裝置上開啟設定畫面：

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

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

顯示通知

傳送至行動裝置的通知只有在使用 CarAppExtender 擴充時，才會顯示在車輛螢幕上。您可以在 CarAppExtender 中設定內容標題、文字、圖示和動作等部分通知屬性，這些屬性會覆寫其在車輛螢幕上顯示的通知屬性。

下列程式碼片段說明如何向車輛螢幕傳送通知，該螢幕的內容與行動裝置上顯示的標題不同：

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

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

通知可能會影響使用者介面的以下部分：

• 系統可能會向使用者顯示抬頭通知 (HUN)。
• 您可以選擇新增通知中心內的項目，選擇在邊欄內顯示標記。
• 如為導航應用程式，通知可能會顯示在邊欄小工具中，如即時路線通知所述。

您可以透過 CarAppExtender 說明文件所述，選擇應用程式通知如何影響各個使用者介面元素，藉此設定通知的優先順序。

如果使用 true 值呼叫 NotificationCompat.Builder.setOnlyAlertOnce，高優先順序通知只會顯示一次抬頭通知。

如要進一步瞭解如何設計車輛應用程式的通知，請參閱有關通知的 Google Design for Driving 指南。

顯示浮動式訊息

應用程式可以使用 CarToast 顯示浮動式訊息，如以下程式碼片段所示：

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

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

要求權限

如果應用程式需要存取受限資料或動作 (例如位置資訊)，則適用 Android 權限的標準規則。如要要求權限，您可以使用 CarContext.requestPermissions() 方法。

在 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>

與使用標準 Android API 相比，使用 CarContext.requestPermissions() 的優勢在於，您不需要啟動自己的 Activity 即可建立權限對話方塊。此外，您可以在 Android Auto 和 Android Automotive OS 上使用同一組程式碼，不必建立與平台相關聯的流程。

透過意圖啟動車輛應用程式

您可以呼叫 CarContext.startCarApp 方法來執行下列任一操作：

• 開啟撥號程式撥打電話。
• 使用預設車輛導航應用程式啟動即時路線導航功能。
• 透過意圖啟動自己的應用程式。

以下範例說明如何建立通知，其中的動作會開啟應用程式，並顯示停車預訂詳細資料的畫面。您利用內容意圖擴充通知執行個體，其中包含 PendingIntent 將明確意圖包裝到應用程式動作：

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())

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：

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)))
        }
    }
}

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 方法會將停車預訂畫面推送到堆疊上，藉此處理這個意圖：

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))
        }
    }
}

@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()));
        }
    }
}

如要進一步瞭解如何處理車輛應用程式的通知，請參閱「顯示通知」一節。

範本限制

主機將指定工作顯示的範本數量上限限制為五個，最後一個範本必須是以下其中一種類型：

• NavigationTemplate
• PaneTemplate
• MessageTemplate

請注意，這項限制適用於範本數量，不適用於堆疊中的 Screen 執行個體數量。例如，如果應用程式在畫面 A 中傳送兩個範本，然後推送畫面 B，現在就能再傳送三個範本。或者，如果每個畫面的結構可傳送單一範本，那麼應用程式就能將五個畫面執行個體推送至 ScreenManager 堆疊。

這些限制會有特殊情況：範本重新整理、返回和重設作業。

更新範本

某些內容更新不會計入範本數量上限。一般而言，如果應用程式推送的新範本類型與先前的範本相同，且包含的主要內容，則新範本不會計入配額。例如，在 ListTemplate 中更新資料列的切換狀態，不會計入配額。請參閱個別範本的說明文件，進一步瞭解哪些類型的內容更新可視為重新整理。

返回作業

如要在工作內啟用子流程，主機會偵測應用程式何時從 ScreenManager 堆疊彈出 Screen，並根據應用程式返回的範本數量更新剩餘配額。

舉例來說，如果應用程式在畫面 A 中傳送兩個範本，然後推送畫面 B 並另外傳送兩個範本，那麼應用程式還剩一個配額。如果應用程式隨後彈回畫面 A，主機會將配額重設為三個，因為應用程式已返回兩個範本。

請注意，應用程式彈回畫面時，應用程式必須傳送與該畫面最後傳送相同的範本。傳送任何其他範本類型會導致錯誤。不過，只要在返回作業期間保持類型不變，應用程式就可以自由修改範本內容，而不會影響配額。

重設作業

某些範本提供特殊語意，代表工作結束。舉例來說，NavigationTemplate 這個檢視畫面應會停留在螢幕上，並更新使用者使用情況的即時路線指示。當達到其中一個範本時，主機會重設範本配額，將該範本視為新任務的第一步。這麼做可讓應用程式開始新工作。請參閱個別範本的說明文件，瞭解哪些範本會在主機上觸發重設。

如果主機收到從通知動作或啟動器啟動應用程式的意圖，也會重設配額。這個機制可讓應用程式從通知啟動新的工作流程，即使應用程式已繫結且在前景也是如此。

如要進一步瞭解如何在車輛螢幕上顯示應用程式通知，請參閱「顯示通知」一節。請參閱「使用意圖啟動車輛應用程式」一節，瞭解如何透過通知動作啟動應用程式。

連線 API

您可以使用 CarConnection API 在執行階段擷取連線資訊，藉此判斷應用程式是在 Android Auto 或 Android Automotive OS 上執行。

舉例來說，在車輛應用程式的 Session 中，初始化 CarConnection 並訂閱 LiveData 更新：

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

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

在觀察器中，您可以回應連線狀態的變更：

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()
}

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：

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

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

接著，您可以查詢擷取的 ConstraintManager 物件以瞭解相關內容限制。舉例來說，如要取得格狀檢視可顯示的項目數量，請使用 CONTENT_LIMIT_TYPE_GRID 呼叫 getContentLimit：

val gridItemLimit = manager.getContentLimit(ConstraintManager.CONTENT_LIMIT_TYPE_GRID)

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

新增登入流程

如果您的應用程式為使用者提供登入體驗，則可以使用 SignInTemplate 和 LongMessageTemplate 等範本搭配 Car App API 級別 2 以上的版本，處理在車用運算主機上登入應用程式的程序。

如要建立 SignInTemplate，請定義 SignInMethod。車輛應用程式程式庫目前支援下列登入方法：

• InputSignInMethod 用於使用者名稱/密碼登入。
• PinSignInMethod 用於 PIN 碼登入，使用者可在這裡使用車用運算主機上顯示的 PIN 碼，在手機上連結自己的帳戶。
• ProviderSignInMethod 用於供應商登入，例如 Google 登入和 One Tap。
• QRCodeSignInMethod 用於 QR code 登入，使用者可透過掃描 QR code 完成登入程序。適用於 Car API 級別 4 以上的版本。

舉例來說，如要實作收集使用者密碼的範本，首先請建立 InputCallback 來處理並驗證使用者輸入內容：

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.
    }
}

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。

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

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

最後，請使用新的 InputSignInMethod 建立 SignInTemplate。

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

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) 可以在車輛上啟用訪客體驗，禁止新增帳戶。

新增文字字串變化版本

不同車輛螢幕顯示的文字量可能有所不同。使用 Car App API 級別 2 以上的版本時，您可以指定多個文字字串變化版本，以配合螢幕大小。如要查看系統接受文字變化版本的位置，請找出接受 CarText 的範本和元件。

您可以使用 CarText.Builder.addVariant() 方法，將文字字串變化版本新增至 CarText：

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

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

接著，您就可以使用此 CarText 做為 GridItem 的主要文字。

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

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

依照優先順序由高至低依序新增字串，例如從最長到最短。主機會根據車輛螢幕上的可用空間大小，挑選合適的長度字串。

為資料列新增內嵌 CarIcon

您可以使用 CarIconSpan 新增內嵌文字的圖示，讓應用程式視覺效果更豐富。如要進一步瞭解如何建立這些 Span，請參閱 CarIconSpan.create 的說明文件。如要瞭解使用 Span 的文字樣式設定運作方式，請參閱「使用 Span 的 Spantastic 文字樣式」一文。

  
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()
  
  

  
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

從 Car App API 級別 3 開始，Car App Library 提供 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 API 顯示的屬性，以及使用這些屬性所需的權限：

舉例來說，如要取得剩餘範圍，請將 CarInfo 物件例項化，然後建立並註冊 OnCarDataAvailableListener：

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)

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 類別可讓您存取車輛的加速計、陀螺儀、指南針和位置資料。這些值的供應情形可能因原始設備製造商 (OEM) 而異。加速計、陀螺儀和指南針的資料格式與您從 SensorManager API 取得的資料相同。舉例來說，如要檢查車輛方向：

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)

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>

你必須在執行階段要求權限，才能錄製影片。如要進一步瞭解如何在車輛應用程式中要求權限，請參閱「要求權限」。

錄音

使用者授予錄製權限後，您可以錄製音訊及處理錄音。

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()
 

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();
 

音訊焦點

使用車輛麥克風錄音時，請先取得音訊焦點，確保所有進行中的媒體均已停止。如果失去音訊焦點，請停止錄音。

以下範例說明如何取得音訊焦點：

 
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

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 App Library 問題

如果您發現程式庫有問題，請使用 Google Issue Tracker 回報問題。請務必在問題範本中填寫所有必要資訊。

建立新問題

提交新問題之前，請先檢查該問題是否列在程式庫的版本資訊中，或是在問題清單中回報。您可以在追蹤程式中按一下該問題的星號，訂閱該問題並投下一票。詳情請參閱訂閱問題一文。