CarConnection
class CarConnection
A class that allows retrieval of information about connection to a car head unit.
Summary
Constants |
|
|---|---|
const String! |
ACTION_CAR_CONNECTION_UPDATED = "androidx.car.app.connection.action.CAR_CONNECTION_UPDATED"Broadcast action that notifies that the car connection has changed and needs to be updated. |
const String! |
CAR_CONNECTION_STATE = "CarConnectionState"Defines current car connection state. |
const Int |
Natively running on a head unit (Android Automotive OS). |
const Int |
Not connected to any car head unit. |
const Int |
Connected to a car head unit by projecting to it. |
Public constructors |
|---|
@MainThreadConstructs a |
Public functions |
|
|---|---|
LiveData<Int!> |
getType()Returns a |
Constants
ACTION_CAR_CONNECTION_UPDATED
const val ACTION_CAR_CONNECTION_UPDATED = "androidx.car.app.connection.action.CAR_CONNECTION_UPDATED": String!
Broadcast action that notifies that the car connection has changed and needs to be updated.
CAR_CONNECTION_STATE
const val CAR_CONNECTION_STATE = "CarConnectionState": String!
Defines current car connection state.
This is used for communication with the car host's content provider on queries for connection type.
CONNECTION_TYPE_NATIVE
const val CONNECTION_TYPE_NATIVE = 1: Int
Natively running on a head unit (Android Automotive OS).
CONNECTION_TYPE_NOT_CONNECTED
const val CONNECTION_TYPE_NOT_CONNECTED = 0: Int
Not connected to any car head unit.
CONNECTION_TYPE_PROJECTION
const val CONNECTION_TYPE_PROJECTION = 2: Int
Connected to a car head unit by projecting to it.
Public constructors
CarConnection
@MainThread
CarConnection(context: Context)
Constructs a CarConnection that can be used to get connection information.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
Public functions
getType
fun getType(): LiveData<Int!>
Returns a LiveData that can be observed to get current connection type.
The recommended pattern is to observe the LiveData with the activity's lifecycle in order to get updates on the state change throughout the activity's lifetime.
Connection types are: