車輛應用程式

使用手冊程式碼範例

API 參考資料
androidx.car.app
androidx.car.app.model
androidx.car.app.navigation
androidx.car.app.notification
androidx.car.app.serialization
androidx.car.app.validation
androidx.car.app.versioning

建構適合 Android Auto 和 Android Automotive OS 使用的導航和搜尋點應用程式。

最近更新時間	穩定版	候選版	Beta 版	Alpha 版
2023 年 2 月 22 日	1.2.0	1.3.0-rc01	-	1.4.0-alpha01

宣告依附元件

如要為車輛應用程式程式庫新增依附元件，您必須為專案新增 Google Maven 存放區。詳情請參閱 Google 的 Maven 存放區。

在應用程式或模組的 build.gradle 檔案中，新增所需構件的依附元件：

Groovy

dependencies {
    implementation "androidx.car.app:app:1.2.0"

    // For Android Auto specific functionality
    implementation "androidx.car.app:app-projected:1.2.0"

    // For Android Automotive specific functionality
    implementation "androidx.car.app:app-automotive:1.2.0"

    // For testing
    testImplementation "androidx.car.app:app-testing:1.2.0"
}

Kotlin

dependencies {
    implementation("androidx.car.app:app:1.2.0")

    // For Android Auto specific functionality
    implementation("androidx.car.app:app-projected:1.2.0")

    // For Android Automotive specific functionality
    implementation("androidx.car.app:app-automotive:1.2.0")

    // For testing
    testImplementation("androidx.car.app:app-testing:1.2.0")
}

如要進一步瞭解依附元件，請參閱「新增建構依附元件」一文。

意見回饋

您的意見可協助我們改善 Jetpack。如果您發現新問題，或是有改進這個程式庫的建議，請告訴我們。回報新問題前，請先查看這個程式庫的現有問題。只要按一下星號按鈕，即可投票給現有的問題。

建立新問題

詳情請參閱 Issue Tracker 文件。

1.4 版

1.4.0-alpha01 版

2023 年 2 月 22 日

發布了 androidx.car.app:app-*:1.4.0-alpha01。1.4.0-alpha01 版包含以下修訂項目。

API 變更

在 Car App Library 中新增頂層動作至 GridTemplate (Id0191)
在 Car App Library 中新增頂層動作至 ListTemplate (I9efab)
新增額外項目，以連結媒體項目的字幕或其他媒體項目的說明 (Ic84bf)
將資料列動作的 API 級別更新為級別 6。(Ie0a69)
新增訊息回呼至 A4C (Ie3986)

修正錯誤

為 CarMessage 新增缺少的 Java 文件參照。(I5db1c)
覆寫 ConversationItem 和 CarMessage 的 equals() 和 hashCode() (I6fd10)
改善 ConversationItem.mMessages 驗證 (需要非空值、非空白) (Iafc51)
將 @Keep 註解新增至 ConversationItem 欄位 (I5d250)
更新 java 文件以用於列裝飾和次要動作。(I000b6)

1.3 版

1.3.0-rc01 版

2022 年 12 月 7 日

發布了 androidx.car.app:app-*:1.3.0-rc01。1.3.0-rc01 版包含以下修訂項目。

beta01 的小修正錯誤。沒有重大變更。

1.3.0-beta01 版

2022 年 9 月 7 日

發布了 androidx.car.app:app:1.3.0-beta01、androidx.car.app:app-projected:1.3.0-beta01、androidx.car.app:app-automotive:1.3.0-beta01 和 androidx.car.app:app-testing:1.3.0-beta01。1.3.0-beta01 版包含以下修訂版本。

使用這個程式庫的車輛應用程式現在可以使用 API 級別 5 進入 Play 商店 (請參閱開發人員指南)。加上 API 級別 5 及以下註解的功能可相容於 Android Auto 8.1 以上版本和 Google Automotive App Host 1.4 以上版本。

新功能

除了 Car App Library 1.3.0-alpha01 中添加的功能外，下列功能已成為 Beta01 的一部分 (這裡的所有功能都涉及主機端變更，而不含任何 API 變更)：

即使使用者位於 PlaceListNavigationTemplate、RoutePreviewNavigationTemplate 和 MapTemplate 中的地圖式選取畫面中，浮動導覽列仍會繼續顯示。方法是透過 NavigationManager.updateTrip() 更新導航資訊。
啟用含有 FLAG_DEFAULT 的動作按鈕，即可設定逾時動畫。逾時後，系統將根據預設點擊這個按鈕。([API 5 - All Templates])
當車輛停放時，Row 的子文字不會遭到截斷，但開車時會截斷成 2 行。([API 5 - All Templates])
支援 Action、Toggle、Row ([API 5 - All Templates]) 的停用狀態

API 變更

放寬 MapTemplate 清單中的限制，以支援可選取的清單 (I961ed)
移除標頭動作的限制條件來允許自訂圖示。(Iad28f)
將限制 setOnClickListenerAllowed() 新增至 ActionsConstraints。允許 Action 將 OnClickDelegate() 設為標準圖示類型以外的動作。(TYPE_APP_ICON、TYPE_BACK 和 TYPE_PAN) (I3c745)

修正錯誤

新增了 Android Automotive Template Host 1.4 以上版本與曲線螢幕的相容性 ([Host change])

1.3.0-alpha01 版

2022 年 7 月 27 日

發布了 androidx.car.app:app:1.3.0-alpha01、androidx.car.app:app-projected:1.3.0-alpha01、androidx.car.app:app-automotive:1.3.0-alpha01 和 androidx.car.app:app-testing:1.3.0-alpha01。1.3.0-alpha01 版包含以下修訂項目。

加上 API 級別 5 註解的功能可相容於 Android Auto 7.9 以上版本。

新功能

API 級別 5：導航應用程式可以使用新的 MapTemplate 在地圖旁顯示窗格或清單內容 (If5826、If44b8)
API 級別 5：新的 CarAudioRecord API 可以透過主機車輛的麥克風錄製音訊輸入內容 (I5e71a)
API 級別 5：新的 SuggestionManager API 可讓應用程式為主機使用者提供建議事項 (I5c103)
API 級別 5：新的 Alert API 可在 NavigationTemplate 按照內容顯示通知 (I163a7、I5ad70)
API 級別 5：新的 Header 及 MapController 元件可橫跨多範本重新使用內容 (If5826)
新增了 androidx.car.app.category.POI 做為啟用搜尋點應用程式用的類別 (並淘汰 androidx.car.app.category.PARKING 和 androidx.car.app.category.CHARGING) (I59da1)

API 變更

API 級別 5：SurfaceCallback 介面提供新的 onClick 方法，可讓使用者輕觸地圖進行互動 (Ia9777)
API 級別 5：新的旗標 Action.FLAG_IS_PERSISTENT 和 Action.FLAG_DEFAULT 可用來描述 Action (I96318、I5ad70)
API 級別 5：Action、Row 和 Toggle 元件可使用新的啟用/停用狀態 (主機支援約可在 1.3.0-beta01 左右的程式庫版本提供) (ID8a09)
API 級別 5：偏好使用 setHeader 在 PlaceListNavigationTemplate.Builder 和 RoutePreviewNavigationTemplate.Builder 提供的新 Header 元件，並淘汰現有的 setTitle 及 setHeaderAction 方法 (I30e6a)
API 級別 5：PlaceListMapTemplate.Builder 和 PlaceListNavigationTemplate.Builder 上的新 setOnContentRefreshListner 方法可以搭配新的 OnContentRefreshListner 介面實作使用。
API 級別 5：TravelEstimate.Builder 新的 setTripText 和 setTripIcon 可用來自訂預估交通資訊卡片內容 (Idcc6d、Ic620d)
在 PaneTemplate 名稱中加入 CarIconSpan 的支援 (Ia1ee0)
在 Row 名稱及文字中加入 CarIconSpan 的支援 (Ic1e3c)
地圖 ActionStrip 現在最多可以設定四個操作 (If3522)
更新車輛應用程式 API 級別至 5 (I26b8e)
PlaceListMapTemplate、PlaceListNavigationTemplate、RoutePreviewNavigationTemplate、GridTemplate、ListTemplate、LongMessageTemplate、MessageTemplate、PaneTemplate 以及 SignInTemplate 的標頭/名稱已變為選填內容 (I2078d、Icadde)

修正錯誤

更新 PaneTemplate 圖片大小規則為正方形定界框 (Idd72e)
修正了在 State.DESTROYED 之後修改畫面堆疊時發生的例外狀況(I3c8eb)。
新增了接收應用程式圖示的空值檢查 (I3f710)
更新 Car Hardware API，使其使用 STATUS_UNKNOWN 而非預設的 STATUS_UNAVAILABLE (Ic9444)
在建立途徑前檢查是否有螢幕 (Ice027a)
修正和 STATUS_UNIMPLEMENTED 有關的 CarValue.equals() 錯誤 (I24451)

1.2 版

1.2.0 版

2022 年 11 月 9 日

發布了 androidx.car.app:app-*:1.2.0。1.2.0 版包含以下修訂項目。

這是穩定版，與 v1.2.0-rc01 相比沒有任何 API 變更。

1.2.0-rc01 版

2022 年 3 月 23 日

發布了 androidx.car.app:app-*:1.2.0-rc01。1.2.0-rc01 版包含以下修訂項目。

這是穩定版，與 v1.2.0-beta02 相比沒有任何 API 異動。新增實驗功能 (API 級別 5)，預計在 Android Auto 和 Android Automotive 的未來版本中推出。

修正錯誤

修正了在 State.DESTROYED 之後修改畫面堆疊時發生的例外狀況(I3c8eb)。
更新 CarSensors API，表示 AAOS 並未導入這些 API (Idd57b)
更新 PlaceListMapTempalte.Builder#setCurrentLocationEnabled，表示 ACCESS_COARSE_LOCATION 已可滿足未來的需求 (I510c2)
讓有指定角度的環島路駕駛方式可自選出口號碼 (Ife7d1)

1.2.0-beta02 版

2022 年 1 月 26 日

發布了 androidx.car.app:app-*:1.2.0-beta02。1.2.0-beta02 版包含以下修訂項目。

凡是使用這個程式庫版本建立並指定 Android Automotive OS 平台的車輛應用程式，現在都可以發布到 Play 商店公開測試管道了。詳情請參閱開發指南。

加上 API 級別 4 以下註解的功能可相容於 Android Auto 7.2 以上和新的 Android Automotive OS 平台。請參閱下方的 Known Issues 一節，瞭解注意事項。

API 變更

已將實驗性 setOnContentRefreshListener API 新增到搜尋點範本 (I6bf22)

修正錯誤

修正了車輛主機解除繫結時，CarAppService 中的記憶體流失問題。(I5c9ca、b/203594731)
更新 CarAppActivity javadoc，為 singleTask 啟動模式納入相關規定 (Id2f95)
減少繼續使用時的視覺故障。(Iff7e0)

已知問題

PlaceListNavigationTemplate 和 RoutePreviewNavigateTemplate 中的地圖 ActionStrip 將於下一個 Android Auto 和 Android Automotive OS 版本中推出。

1.2.0-alpha02 版

2021 年 12 月 15 日

發布了 androidx.car.app:app-*:1.2.0-alpha02。1.2.0-alpha02 版包含以下修訂項目。

加上 API 級別 4 註解的功能已從實驗版升級為穩定版，包括 PlaceListNavigationTemplate 和 RoutePreviewNavigateTemplate 中的地圖 ActionStrip，Pane 中的 CarIcon 圖片、QRCodeSignInMethod 和在 Action 中設定算繪提示的功能 (例如旗標)。

新功能

在 Android Auto 7.1 以上版本中，Pane 的項目上限已從 2 個增加到 4 個。

API 變更

已將實驗性的 toString() 方法新增至 CarUnit(I36a3b)

修正錯誤

修正了回呼失敗時 CarAppPermissionActivity 中發生的當機問題 (If9823)
已將 Pane 預設清單上限變更為 4 (I0068b)

1.2.0-alpha01 版

2021 年 11 月 3 日

發布了 androidx.car.app:app-*:1.2.0-alpha01。1.2.0-alpha01 版包含以下修訂項目。

所有新的 v1.2.0 功能 (API 4+) 目前都在實驗階段，目標是在未來的 Android Auto 和 Android Automotive OS 版本中推出。詳情請參閱開發指南。

API 變更

AutomotiveCarInfo API 進入實驗階段 (Ia13e5)
新增了 Car App Library API 級別 4 (I2a2e7)
API 級別 4：新增了在 Pane 中設定 CarIcon 的支援功能 (Ifcc12)
API 級別 4：新增了 QR 圖碼登入方法 (Ib623e)
API 級別 4：在 Action 中新增了設定/getFlags (Ic03ab)
API 級別 4：新增了在 PlaceListNavigationTemplate 和 RoutePreviewNavigationTemplate 中支援平移和縮放的功能 (I9d8a3)

修正錯誤

API 級別 4：新增了允許應用程式將位置更新通知傳送至車輛主機的機制 (I3bad3)
修正主機驗證邏輯無法正確尋找 TEMPLATE_RENDERER 權限的問題 (I62618)

1.1.0 版

2021 年 12 月 15 日

發布了 androidx.car.app:app-*:1.1.0。1.1.0 版包含以下修訂項目。

這是穩定版，與 v1.1.0-rc01 相比沒有任何異動。另請參閱 v1.2.0-alpha02 的版本資訊，進一步瞭解車輛應用程式程式庫的新功能。

自 1.0.0 版以來的重要變更

API 級別 2：車輛停放時可用於登入流程的 SignInTemplate 和 LongMessageTemplate
API 級別 2：NavigationTemplate 中的地圖互動支援
API 級別 2：支援多重長度文字，讓應用程式能根據車輛螢幕尺寸提供多個版本的字串以供顯示。
API 級別 3：可用來查詢車輛硬體資料 (例如型號和品牌、油量和其他感應器) 的 CarHardwareManager。

1.1.0-rc01 版

2021 年 11 月 3 日

發布了 androidx.car.app:app-*:1.1.0-rc01。1.1.0-rc01 版包含以下修訂項目。

這是穩定版，與 v1.1.0-beta01 相比沒有任何 API 變更。已新增實驗性功能 (API 級別 4)，可望在 Android Auto 未來的版本中推出。如要進一步瞭解實驗性 API，請參閱 v1.2.0-alpha01 的版本資訊。

1.1.0-beta01 版

2021 年 9 月 1 日

發布了 androidx.car.app:app-*:1.1.0-beta01。1.1.0-beta01 版包含以下修訂項目。

所有 v1.1.0 功能 (API 2+) 都完全相容於 Android Auto 6.7 以上版本。詳情請參閱開發指南。

API 變更

不再以 Manager 做為公開介面 (Ie381b)
新增了為權限要求設定自訂品牌背景的功能 (I74b76)
新增了 ScreenManager.getStackSize (I0b16a)
移除了會明確採用 TestCarContext 的 ScreenController 建構函式 (Iefebc)

修正錯誤

新增了建立 CarHardwareManager 時的 API 級別檢查 (I48f9b)
針對整個 API 的無效 CarSpan 用途新增檢查作業 (I65ae6)
修正了以下問題：如果 Screen 在建立期間標示為完成，會使堆疊處於損毀狀態 (I81b13)
修正以下問題：如果 CarAppExtender 中有含圖示的動作，則 CarNotificationManager.notify 會為 AutomotiveOS 記錄一次錯誤 (I3633d)
為應用程式和主機新增握手方法，以建立 API 版本 (I7d6f8)

1.1.0-alpha02 版

2021 年 7 月 21 日

發布了 androidx.car.app:app-*:1.1.0-alpha02。1.1.0-alpha02 版包含以下修訂項目。

新功能

API 級別 3：新增了 CarHardwareManager，可用來查詢車輛硬體資料，例如型號和品牌、油量和其他感應器。這項功能目前只開放 Android Auto 6.7 以上版本在公開測試頻道中使用。如要在電腦環境中測試這項功能，則需要使用新版 Desktop Head Unit (將另行發布)。請密切關注測試 Android 車輛應用程式網頁，掌握關於新版本推出時間的詳細資訊。
請參閱開發指南和程式庫參考資料瞭解詳情；設計指南則可協助您瞭解如何使用這些相容於 API 級別 3 的車輛主機中的功能。

API 變更

將 SessionController 和 ScreenController 生命週期方法合併至單一 moveToState 方法 (I1ed00)
新增了 CarContext#getHostInfo() (I8977e)
移除已淘汰的欄位 (I67168)
更新 SessionController 和 ScreenController 以直接顯示建構函式 (Iabf22)
移除 PinSignInMethod.Builder 和 ProviderSignInMethod.Builder (I9f0cb)
新增了「setCarAppResult()」以啟用在 AAOS 中使用範本應用程式「for result」的功能 (I37741)
以 @MainThread 為 CarHardware 介面加註。(Ib2f85)
OnCarDataListener 已重新命名為 OnCarDataAvailableListener (I518ca)
更新 CarInfo、Speed、Mileage 方法名稱和 javadoc (I86672)
Toll 已重新命名為 TollCard (I3e7c8)
移除已淘汰的 PinSignInMethod.getPin，替換成 PinSignInMethod.getPinCode (I996ce)
移除 OnInputCompletedListener，替換成 InputCallback (Ib5be1)
PinSignInMethod 改為採用 CharSequence 而非 String (I275d5)

修正錯誤

為車輛硬體修正 Javadoc (I2abbc)

外部貢獻

已知問題

在 SignInTemplate 中，使用 InputSignInMethod 可能會在車輛主機中造成 NullPointerException。我們會在下一個程式庫版本中解決這個問題。如要暫時繞過這個問題，請在您應用程式的 ProGuard 設定中納入這一行：-keep class androidx.car.app.model.signin.InputSignInMethod { *; }

1.1.0-alpha01 版

2021 年 6 月 16 日

發布了 androidx.car.app:app:1.1.0-alpha01、androidx.car.app:app-automotive:1.1.0-alpha01 和 androidx.car.app:app-testing:1.1.0-alpha01。1.1.0-alpha01 版包含以下修訂項目。

新功能

API 級別 2：車輛停放時可用於登入流程的新 SignInTemplate 和 LongMessageTemplate
API 級別 2：NavigationTemplate 中的新地圖互動支援
API 級別 2：支援新的多重長度文字，讓應用程式能根據車輛螢幕尺寸提供多個版本的字串以供顯示。
請參閱開發指南和程式庫 Javadoc 瞭解詳情；設計指南則可協助您瞭解如何使用這些相容於 API 級別 2 的車輛主機中的功能。

API 變更

將所有 *Callback 介面方法設為預設，並將 OnRequestPermissionsCallback 重新命名為 OnRequestPermissionsListener (Ib3ec9)
更新 androidx.car.app.hardware 類別以移除不必要的建構工具和參數類別 (I67beb)
新增了 androidx.car.app.hardware 類別以存取車輛專屬資料，例如燃料、電池和速度 (Iff3c9)
在 MessageTemplate 上新增了 ActionStrip 支援 (Ida657)
將 setLoading 新增至 MessageTemplate。(I2a4b5)
ConnectionToCar 已重新命名為 CarConnection (Ife9bd)
將 NavigationTemplate 變更為會傳回明確的 PanModeDelegate (I13877)
更新 CarContext.requestPermissions 的參數順序 (Ib890a)
更新中繼資料金鑰，將最低車輛 API 級別定義為 androidx.car.api.minCarApiLevel (Ib0d41)
建立允許觀察車輛連線狀態的 API (Ifc935)
新增了可為 Action 設定切換開關的功能，並新增了平移模式 Action 類型 (Ica6af)
建立了 CarNotificationManager 以支援在車上傳送通知的功能 (I10d7a)
新增了 ConstraintManager 以提供主機的清單限制 (I8690e)
在 NavigationTemplate 中新增了平移模式和地圖操作清除 API (I77aa6)
在 SurfaceCallback 中為導航應用程式新增了平移和縮放 API (Id5e9d)
將 CarAppApiLevel 更新為 2 (Ic1540)
新增了可向 CarAppService 要求權限的功能 (I5421e)
將 RequiresCarApi(2) 註解新增至多重文字 API (Iacb62)
在半清單範本標題中允許多種文字變化版本 (Ib8df7)
新增了 LongMessageTemplate (需要 Car API 級別 2) (Ic5cee)

修正錯誤

更新圖片大小規定，以配合較大的車輛螢幕 (I116dc)
不允許在範本內文中加入超過 2 個動作 (I32157)
已確保車輛應用程式程式庫中所有的 PendingIntent 建立作業都會設定旗標。(If84fe、b/186394900)
更新 javadoc，允許 Row 的文字在重新整理時變更 (If3f9c)
androidx.activity:activity:1.2.0 現在是 API 依附元件 (Id1cb9)
將 SignInTemplate 和 LongMessageTemplate 設為在內文中要求僅限停車狀態動作，並更新說明文件，指明只有在車子停好時，才會顯示這兩者 (Iddaa9)
修正了啟動期間彈出 Screen 時發生的例外狀況 (Ifcf40、b/184664896)
允許在 ForegroundCarColorSpan 中自訂文字顏色 (I69e59)
修正了在某個 Screen 的 ON_DESTROY 之後，還會看到 Session 上的 ON_DESTROY 的問題 (I52e01、b/183696617)
更新 javadoc，說明何時允許將 TravelEstimate 的剩餘時間設為不明的時間。(I99610、b/183632456)
更新 Action，以支援標題中的 ForegroundColorSpan 以及任何自訂背景色彩 (I578e4)
如果在執行工具執行前已清除回呼，就不執行 NavigationManagerCallback#onStopNavigation (I7fc5e、b/181143772)
修正了以下問題：要求應用程式必須在 lifecycle-common-java8 上明確採用依附元件 (I8b8c8)

已知問題

在 SignInTemplate 中，當使用者想要確認輸入內容時，螢幕小鍵盤會顯示「搜尋」圖示，而不是「輸入」圖示。輸入欄位成為焦點時，系統會啟動手機鍵盤，使用者可以存取這個鍵盤，當做暫時的因應方法。
在 Android Auto 6.5 版中，某些觸控手勢可能會錯誤叫用 SurfaceCallback 中的平移和縮放回呼。