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

spokenPhrase

The phrase identified by Siri.

Required.

pronunciationHint

A hint at how the spoken phrase is pronounced.

Required.

Getting the Identifier

vocabularyIdentifier

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

Required.

identifier

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

Deprecated

Getting Alternative Matches

alternativeSpeakableMatches

An array of alternative phrases that match the current phrase.

Required.

Relationships

Inherits From

Conforming Types

See Also

String

INSpeakableString

A custom phrase to be resolved by an Intents extension.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software