VpaMediatorSettingsService

Service providing access to all the VPA-related settings.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val defaultVpa: VpaIdentifier?

The default VPA: this is the VPA that will be invoked when the "Push-To-Talk" button is pressed. If defaultVpa is null, no VPA will be invoked (the "Push-To-Talk" button is disabled).

Link copied to clipboard

true if Privacy mode is enabled for VPAs, false otherwise. When enabled, the user cannot invoke VPAs and VPAs will not proactively start a conversation or send any notifications to the user. The frontend should accompany this by disabling all VPA-related screens (such as Settings) and UI controls (such as 'push-to-talk' if present). This can be used in restricted modes such as valet or for guest drivers.

Link copied to clipboard

The settings for each available VPA known to the system.

Functions

Link copied to clipboard
abstract suspend fun enableDoNotDisturbMode(vpaIdentifier: VpaIdentifier, enable: Boolean)

Asks a VPA to enable or disable "Do Not Disturb" mode. 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
abstract suspend fun enableEarcon(vpaIdentifier: VpaIdentifier, earconType: VpaEarconType, enable: Boolean)

Enables or disables the earcon of type earconType. An earcon sound will be played only if its corresponding VpaEarconType is enabled.

Link copied to clipboard
abstract suspend fun enableLocationSharing(vpaIdentifier: VpaIdentifier, enable: Boolean)

Enables or disable location sharing with a VPA. 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
abstract suspend fun enablePrivacyMode(enable: Boolean)

Enable Privacy mode for all VPAs.

Link copied to clipboard
abstract suspend fun enableSyncVehicleNavigationFavorites(vpaIdentifier: VpaIdentifier, enable: Boolean)

Enables or disables vehicle navigation favorites syncing with a VPA. 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
abstract suspend fun enableWakeUpWord(vpaIdentifier: VpaIdentifier, enable: Boolean)

Asks a VPA to enable or disable Wake Up Word detection.

Link copied to clipboard
abstract suspend fun updateActiveLocales(vpaIdentifier: VpaIdentifier, locales: List<Locale>)

Asks the VPA to update the active locales. These are the languages that will be spoken and recognized by the VPA.

Link copied to clipboard
abstract suspend fun updateAllowedPersonalData(vpaIdentifier: VpaIdentifier, bluetoothDeviceAddress: BluetoothDeviceAddress, allowedPersonalData: EnumSet<PersonalDataType>)

Updates the set of personal data types that the user has allowed to be sent to a VPA service. 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
abstract suspend fun updateDefaultVpa(vpaIdentifier: VpaIdentifier?)

Updates the default VPA, which is the VPA that will be invoked when the user presses the "Push-To-Talk" button. If vpaIdentifier is null, no VPA will be invoked when the user presses the "Push-To-Talk" button.