NavigationManager

@ExperimentalCarApi
@RequiresCarApi(value = 9)
fun canSetVoiceAssistantCapabilities(): Boolean

Returns whether the host supports setting voice assistant capabilities.

Third-party navigation apps should call this method before attempting to build or send a NavigationVoiceAssistantCapabilities object, as it is only supported on specific host platforms (e.g., Android Automotive OS).

@MainThread
fun clearNavigationManagerCallback(): Unit

Clears the callback for receiving navigation manager events.

@MainThread
fun navigationEnded(): Unit

Notifies the host that the app has ended active navigation.

Only one app may be actively navigating in the car at any time and ownership is managed by the host. The app must call this method to inform the system that it has ended navigation, for example, in response to the user cancelling navigation or upon reaching the destination.

This method is idempotent.

@MainThread
fun navigationStarted(): Unit

Notifies the host that the app has started active navigation.

Only one app may be actively navigating in the car at any time and ownership is managed by the host. The app must call this method to inform the system that it has started navigation in response to user action.

This function can only called if setNavigationManagerCallback has been called with a non-null value. The callback is required so that a signal to stop navigation from the host can be handled using onStopNavigation.

This method is idempotent.

@MainThread
fun setNavigationManagerCallback(callback: NavigationManagerCallback): Unit

Sets a callback to start receiving navigation manager events. Note that the callback events will be executed on the main thread using getMainLooper. To specify the execution thread, use setNavigationManagerCallback.

@MainThread
fun setNavigationManagerCallback(
    executor: Executor,
    callback: NavigationManagerCallback
): Unit

Sets a callback to start receiving navigation manager events.

@MainThread
@ExperimentalCarApi
@RequiresCarApi(value = 9)
fun setVoiceAssistantCapabilities(
    capabilities: NavigationVoiceAssistantCapabilities
): Unit

Sends the voice assistant capabilities and consent state of the navigation app to the host.

This allows the app to dynamically toggle whether the voice assistant can access the active navigation state, and declares the actions and disruptions the app supports.

@MainThread
fun updateTrip(trip: Trip): Unit

Sends the destinations, steps, and trip estimates to the host.

The data may be rendered at different places in the car such as the instrument cluster screen or the heads-up display.

This method should only be invoked once the navigation app has called navigationStarted, or else the updates will be dropped by the host. Once the app has called navigationEnded or received onStopNavigation it should stop sending updates.

As the location changes, and in accordance with speed and rounded distance changes, the TravelEstimates in the provided Trip should be rebuilt and this method called again. For example, when the next step is greater than 10 kilometers away and the display unit is kilometers, updates should occur roughly every kilometer.

Data provided to the cluster display depends on the vehicle capabilities. In some instances the information may not be shown at all. On some vehicles androidx.car.app.navigation.model.Maneuvers of unknown type may be skipped while on other displays the associated icon may be shown.