Protocol

INSpeakable

Pronunciation hints for strings used in a spoken interface.

Declaration

protocol INSpeakable

Overview

The INSpeakable protocol is adopted by the INSpeakableString class and used to provide pronunciation hints for strings spoken by Siri. You do not need to adopt this protocol in your own classes. Instead, create instances of the INSpeakableString class and use them when resolving parameters in your intent handlers.

Topics

Getting the Spoken Attributes

var spokenPhrase: String

The phrase identified by Siri.

Required.

var pronunciationHint: String?

A hint at how the spoken phrase is pronounced.

Required.

Getting the Identifier

var vocabularyIdentifier: String?

The identifier associated with the string in your app’s custom vocabulary file.

Required.

var identifier: String?

The identifier associated with the string in your app’s custom vocabulary file.

Deprecated

Getting Alternative Matches

var alternativeSpeakableMatches: [INSpeakable]?

An array of alternative phrases that match the current phrase.

Required.

See Also

String

class INSpeakableString

A custom phrase to be resolved by an Intents extension.