Declaration
@class SPXRecognitionResult : NSObject;
Description
Represents the recognition result base class.
Properties
resultId
@property (readonly, copy, atomic) NSString * _Nonnull resultId;
The result identifier.
reason
@property (readonly, atomic) SPXResultReason reason;
The reason the result was created.
text
@property (readonly, copy, atomic) NSString * _Nullable text;
The recognized text in the result.
duration
@property (readonly, atomic) uint64_t duration;
Duration of recognized speech in ticks. A single tick represents one hundred nanoseconds or one ten-millionth of a second.
offset
@property (readonly, atomic) uint64_t offset;
Offset of recognized speech in milliseconds. A single tick represents one hundred nanoseconds or one ten-millionth of a second.
channel
@property (readonly, atomic) uint32_t channel;
Index of the input audio channel where the speech was recognized. Numbering starts at zero.
commitToken
@property (readonly, atomic) uint32_t commitToken;
The commit token echoed by the service on this result, or 0 if this result is not a commit acknowledgment.
A non-zero value is the token returned by the commit call that requested the boundary this result closes. Match it against that value to identify which commit the result corresponds to.
An acknowledgment may legitimately carry no recognized text: a commit that finalized silence, or one with nothing left outstanding, is acknowledged with an empty result.
properties
@property (readonly, atomic) id<SPXPropertyCollection> _Nullable properties;
The set of properties exposed in the result.