VpaSettings

data class VpaSettings(    val wakeUpWordEnabled: Boolean,     val activeLocales: List<Locale>,     val enabledEarcons: EnumSet<VpaEarconType>,     val doNotDisturbModeEnabled: Boolean,     val locationSharingEnabled: Boolean,     val syncVehicleNavigationFavoritesEnabled: Boolean,     val allowedPersonalData: BluetoothAddressToAllowedPersonalDataMap = emptyMap()) : Parcelable

Holds the current state of all the settings for a VPA.

Constructors

Link copied to clipboard
fun VpaSettings(    wakeUpWordEnabled: Boolean,     activeLocales: List<Locale>,     enabledEarcons: EnumSet<VpaEarconType>,     doNotDisturbModeEnabled: Boolean,     locationSharingEnabled: Boolean,     syncVehicleNavigationFavoritesEnabled: Boolean,     allowedPersonalData: BluetoothAddressToAllowedPersonalDataMap = emptyMap())

Properties

Link copied to clipboard
val activeLocales: List<Locale>

The Locales that this VPA is currently using. This corresponds to the languages that are currently spoken and recognized by the VPA. It is either a single element out of the VpaProperties.supportedLocales or one of the VpaProperties.supportedLocaleCombinations. The order in the list defines the priority of the language used by the VPA, if the VPA supports prioritization of active locales.

Link copied to clipboard

The set of personal data types, stored on a phone, that the user has allowed to be sent to this VPA. The VPA could typically use this information to, for example, recognise contact names for hands free calling and to read messages aloud.

Link copied to clipboard
val doNotDisturbModeEnabled: Boolean

true if "Do Not Disturb" mode is enabled for this VPA, false otherwise. When "Do Not Disturb" mode is enabled, the device will not receive VPA notifications but will still allow both alerts (such as alarms and timers) and user-initiated VPA responses to be played.

Link copied to clipboard
val enabledEarcons: EnumSet<VpaEarconType>

The set of enabled earcons for this VPA. An earcon sound will be played only if its corresponding VpaEarconType is enabled.

Link copied to clipboard
val locationSharingEnabled: Boolean

true if location sharing with this VPA is enabled, false otherwise. If location sharing is enabled, the vehicle's current location is shared with a VPA to, for example, get smarter responses for nearby restaurants, local weather, navigation requests and more.

Link copied to clipboard
val syncVehicleNavigationFavoritesEnabled: Boolean

true if vehicle navigation favorites syncing with this VPA is enabled, false otherwise. If vehicle navigation favorites syncing is enabled, the VPA can, for example, help navigate to the favorite locations stored in the vehicle. Favorites will be uploaded to the VPA service.

Link copied to clipboard
val wakeUpWordEnabled: Boolean

true if this VPA is listening for the Wake Up Word from the user, false otherwise. The user can then speak to the VPA by first saying its Wake Up Word.

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)