AndroidAuto/com.benomad.msdk.androidauto.callback/AndroidAutoScreenState

AndroidAutoScreenState

enum AndroidAutoScreenState : Enum<AndroidAutoScreenState>

Represents which screen is currently active on Android Auto.

This enum is used to communicate the AA screen state to the phone app, allowing it to show context-appropriate UI. The phone app observes this state via AndroidAutoSurfaceManager.aaScreenState StateFlow.

State Transitions

DISCONNECTED ──→ MAP_VIEW (AA session created, main screen shown)
                    │
                    ├──→ SEARCH (user opens search)
                    │       │
                    │       └──→ ROUTE_PREVIEW (destination selected)
                    │               │
                    │               └──→ NAVIGATION (guidance started)
                    │
                    ├──→ NAVIGATION (quick start from favorites)
                    │
                    └──→ SETTINGS (user opens settings)

Usage

Each AA screen reports its state when it becomes active:

// In AndroidAutoMainScreen
init {
    AndroidAutoSurfaceManager.setAAScreenState(AndroidAutoScreenState.MAP_VIEW)
}

Phone app observes and updates UI accordingly:

val aaScreenState by viewModel.aaScreenState.collectAsState()
when (aaScreenState) {
    DISCONNECTED -> MainMapViewComposable()
    MAP_VIEW -> AAPhoneMapViewScreen()
    SEARCH -> AAPhoneMapViewScreen() // Search is independent
    // ...
}

Entries

DISCONNECTED

Android Auto is not connected or the app is not open on AA.

MAP_VIEW

AA is showing the main map screen (NavigationTemplate).

AA is showing the search screen (SearchTemplate).

ROUTE_PREVIEW

AA is showing the route preview screen (MapWithContentTemplate).

NAVIGATION

AA is in active navigation mode (future).

SETTINGS

AA is showing the settings screen (ListTemplate with toggles).

Properties

entries

val entries: EnumEntries<AndroidAutoScreenState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): AndroidAutoScreenState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<AndroidAutoScreenState>

Returns an array containing the constants of this enum type, in the order they're declared.