CarPlay · IOS API REFERENCE

CPVoiceControlState

class · iOS 12.0+ · SDK 27.1

class CPVoiceControlState

Members (10)

get · iOS 26.4+

maximumActionButtonCount

TypeScript

static get maximumActionButtonCount(): number

Swift declaration

class var maximumActionButtonCount: Int { get }

init · iOS 27.0+

init

TypeScript

static initIdentifierTitleVariantsImageBackgroundImageRepeats(identifier: string, titleVariants: (Array<string>) | null, image: (_UIKit_UIImage) | null, backgroundImage: (_UIKit_UIImage) | null, repeats: boolean): CPVoiceControlState

Swift declaration

init(identifier: String, titleVariants: [String]?, image: UIImage?, backgroundImage: UIImage?, repeats: Bool)

init · iOS 12.0+

init

TypeScript

static initIdentifierTitleVariantsImageRepeats(identifier: string, titleVariants: (Array<string>) | null, image: (_UIKit_UIImage) | null, repeats: boolean): CPVoiceControlState

Swift declaration

init(identifier: String, titleVariants: [String]?, image: UIImage?, repeats: Bool)

get · iOS 26.4+

actionButtons

TypeScript

get actionButtons(): Array<CPButton>

Swift declaration

var actionButtons: [CPButton] { get set }

set · iOS 26.4+

actionButtons

TypeScript

set actionButtons(value: Array<CPButton>)

Swift declaration

var actionButtons: [CPButton] { get set }

get · iOS 27.0+

backgroundImage

TypeScript

get backgroundImage(): (_UIKit_UIImage) | null

Swift declaration

var backgroundImage: UIImage? { get }

get · iOS 12.0+

identifier

TypeScript

get identifier(): string

Swift declaration

var identifier: String { get }

get · iOS 12.0+

image

TypeScript

get image(): (_UIKit_UIImage) | null

Swift declaration

var image: UIImage? { get }

get · iOS 12.0+

repeats

TypeScript

get repeats(): boolean

Swift declaration

var repeats: Bool { get }

get · iOS 12.0+

titleVariants

TypeScript

get titleVariants(): (Array<string>) | null

Swift declaration

var titleVariants: [String]? { get }

Skipped declarations

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

CPVoiceControlState.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All CarPlay types →