One Logo Pool Ball
CarPlay · IOS API REFERENCE

CPVoiceControlTemplate

class · iOS 12.0+ · SDK 27.1

@MainActor class CPVoiceControlTemplate

Members (10)

method · iOS 12.0+

activateVoiceControlState

TypeScript
activateVoiceControlState(identifier: string): Promise<void>
Swift declaration
func activateVoiceControlState(withIdentifier identifier: String)
init · iOS 12.0+

init

TypeScript
static init(voiceControlStates: Array<CPVoiceControlState>): Promise<CPVoiceControlTemplate>
Swift declaration
init(voiceControlStates: [CPVoiceControlState])
get · iOS 12.0+

activeStateIdentifier

TypeScript
get activeStateIdentifier(): Promise<(string) | null>
Swift declaration
var activeStateIdentifier: String? { get }
get · iOS 26.4+

backButton

TypeScript
get backButton(): Promise<(CPBarButton) | null>
Swift declaration
var backButton: CPBarButton? { get set }
set · iOS 26.4+

backButton

TypeScript
setBackButton(value?: (CPBarButton) | null): Promise<void>
Swift declaration
var backButton: CPBarButton? { get set }
get · iOS 26.4+

leadingNavigationBarButtons

TypeScript
get leadingNavigationBarButtons(): Promise<Array<CPBarButton>>
Swift declaration
var leadingNavigationBarButtons: [CPBarButton] { get set }
set · iOS 26.4+

leadingNavigationBarButtons

TypeScript
setLeadingNavigationBarButtons(value: Array<CPBarButton>): Promise<void>
Swift declaration
var leadingNavigationBarButtons: [CPBarButton] { get set }
get · iOS 26.4+

trailingNavigationBarButtons

TypeScript
get trailingNavigationBarButtons(): Promise<Array<CPBarButton>>
Swift declaration
var trailingNavigationBarButtons: [CPBarButton] { get set }
set · iOS 26.4+

trailingNavigationBarButtons

TypeScript
setTrailingNavigationBarButtons(value: Array<CPBarButton>): Promise<void>
Swift declaration
var trailingNavigationBarButtons: [CPBarButton] { get set }
get · iOS 12.0+

voiceControlStates

TypeScript
get voiceControlStates(): Promise<Array<CPVoiceControlState>>
Swift declaration
var voiceControlStates: [CPVoiceControlState] { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CPVoiceControlTemplate.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All CarPlay types →