TypeScript API
Voicecontroltemplate

Class: VoiceControlTemplate

Displays a voice control indicator on the CarPlay screen.

CarPlay navigation apps must show the voice control template during audio input.

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new VoiceControlTemplate(config): VoiceControlTemplate

Parameters

NameType
configTemplateConfig & VoiceControlTemplateConfig

Returns

VoiceControlTemplate

Inherited from

Template.constructor

Defined in

packages/react-native-carplay/src/templates/Template.ts:92 (opens in a new tab)

Properties

config

config: TemplateConfig & VoiceControlTemplateConfig

Inherited from

Template.config

Defined in

packages/react-native-carplay/src/templates/Template.ts:92 (opens in a new tab)


id

id: string

Inherited from

Template.id

Defined in

packages/react-native-carplay/src/templates/Template.ts:86 (opens in a new tab)

Accessors

eventMap

get eventMap(): Object

Returns

Object

Inherited from

Template.eventMap

Defined in

packages/react-native-carplay/src/templates/Template.ts:88 (opens in a new tab)


type

get type(): string

Returns

string

Overrides

Template.type

Defined in

packages/react-native-carplay/src/templates/VoiceControlTemplate.ts:18 (opens in a new tab)

Methods

activateVoiceControlState

activateVoiceControlState(identifier): void

Parameters

NameType
identifierstring

Returns

void

Defined in

packages/react-native-carplay/src/templates/VoiceControlTemplate.ts:22 (opens in a new tab)


parseConfig

parseConfig(config): any

Parameters

NameType
configany

Returns

any

Inherited from

Template.parseConfig

Defined in

packages/react-native-carplay/src/templates/Template.ts:147 (opens in a new tab)


updateTemplate

updateTemplate(config): void

Parameters

NameType
configP

Returns

void

Inherited from

Template.updateTemplate

Defined in

packages/react-native-carplay/src/templates/Template.ts:141 (opens in a new tab)