AndroidAuto/com.benomad.msdk.androidauto.navigation/AANavigationCoordinator

AANavigationCoordinator

class AANavigationCoordinator(carContext: CarContext, screenFactory: AAScreenFactory, additionalTransitions: Map<Pair<AANavigationState, AANavigationAction>, AANavigationState> = emptyMap())

Coordinator managing Android Auto screen navigation using a state machine.

This class serves as the single point of control for all screen navigation in Android Auto. It uses AANavigationStateMachine to validate transitions before executing them, ensuring the screen stack remains consistent with the navigation state.

Screen instantiation is delegated to AAScreenFactory, allowing each app to provide its own screen implementations without the SDK knowing about concrete screen types.

Responsibilities

Validate Navigation: Uses state machine to check if a navigation is valid
Execute Navigation: Performs the actual screen push/pop via ScreenManager
Coordinate Callbacks: Notifies phone app of relevant state changes
Provide State: Exposes current state for UI updates

Usage

val factory = MyScreenFactory()
val coordinator = AANavigationCoordinator(carContext, factory)

coordinator.openSearch()                     // Validates and pushes SearchScreen
coordinator.selectDestination("Paris")       // Validates and pushes RoutePreviewScreen
coordinator.startNavigation("Paris", false)  // Validates and pushes NavigationScreen

Parameters

carContext

The CarContext from the Android Auto session

screenFactory

Factory for creating app-specific screen instances

additionalTransitions

Additional state machine transitions for custom screens. Merged with built-in defaults. See AANavigationStateMachine for details.

See also

AANavigationStateMachine

AAScreenFactory

AANavigationState

AANavigationAction

Constructors

AANavigationCoordinator

constructor(carContext: CarContext, screenFactory: AAScreenFactory, additionalTransitions: Map<Pair<AANavigationState, AANavigationAction>, AANavigationState> = emptyMap())

Types

object Companion

Properties

val currentState: StateFlow<AANavigationState>

Observable current navigation state.

Functions

fun cancelRoute(): Boolean

Cancels route preview and returns to map view.

fun canGoBack(): Boolean

Checks if a back navigation is valid from the current state.

getValidActions

fun getValidActions(): List<AANavigationAction>

Gets the list of valid actions from the current state.

fun goBack(): Boolean

Handles back button press.

navigateToCustom

fun navigateToCustom(action: AANavigationAction, screen: Screen): Boolean

Navigates to a custom screen using a custom action.

fun onConnected(): Boolean

Called when Android Auto connects.

fun onDisconnected(): Boolean

Called when Android Auto disconnects.

fun openSearch(): Boolean

Opens the search screen from MapView.

fun reportState(state: AANavigationState, reason: String)

Forces the state machine to a specific state without screen changes.

fun reset()

Resets the coordinator to initial state.

selectDestination

fun selectDestination(destinationTitle: String): Boolean

Selects a destination and opens route preview.

startNavigation

fun startNavigation(destinationTitle: String, useDemoMode: Boolean = false, isSyncPush: Boolean = false): Boolean

Starts navigation from route preview.

fun stopNavigation(): Boolean

Stops navigation and returns to map view.

syncToPhoneState

fun syncToPhoneState(phoneState: AANavigationState, destinationTitle: String = "", useDemoMode: Boolean = false)

Synchronizes the navigation state to match the phone's equivalent state.