UIDictationPhrase Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/UIKit.framework
Availability
Available in iOS 5.1 and later.
Companion guide
Declared in
UITextInput.h

Overview

A dictation phrase object represents the textual interpretation of a spoken phrase as dictated by a user.

Starting in iOS 5.1, when the user chooses dictation input on a supported device, the system automatically inserts recognized phrases into the current text view. You can use an object of the UIDictationPhrase class to obtain a string representing a phrase a user has dictated. In the case of ambiguous dictation results, a dictation phrase object provides an array containing alternative strings. Methods in the UITextInput protocol allow your app to respond to the completion of dictation.

Tasks

Obtaining Textual Interpretations of Spoken Text

Properties

alternativeInterpretations

An array of alternative textual interpretations of a dictated phrase. (read-only)

@property (nonatomic, readonly) NSArray *alternativeInterpretations
Discussion

If the system determines only one textual interpretation of a dictated phrase, the value of this property is nil. If there is more than one interpretation, this property contains an array of strings, with the first being most likely interpretation and the last being the least likely.

Availability
  • Available in iOS 5.1 and later.
Declared In
UITextInput.h

text

The most likely textual interpretation of a dictated phrase. (read-only)

@property (nonatomic, readonly) NSString *text
Availability
  • Available in iOS 5.1 and later.
Declared In
UITextInput.h