AVSpeechUtterance AVSpeechUtterance Class

Definition

A spoken word, statement, or sound. Used with AVSpeechSynthesizer.

[Foundation.Register("AVSpeechUtterance", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class AVSpeechUtterance : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable
type AVSpeechUtterance = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
Inheritance
AVSpeechUtteranceAVSpeechUtterance
Attributes
Implements

Remarks

In its simplest form, text-to-speech can be done with just two classes:


var ss = new AVSpeechSynthesizer();
var su = new AVSpeechUtterance("Microphone check. One, two, one two.") {
	Rate = AVSpeechUtterance.DefaultSpeechRate
};
ss.SpeakUtterance(su);          

The Rate property specifies the speed with which the utterance is said. The rate does not appear to be processor-dependent and a rate of 1.0f is unnatural.

Constructors

AVSpeechUtterance() AVSpeechUtterance()

Default constructor, initializes a new instance of this class.

AVSpeechUtterance(IntPtr) AVSpeechUtterance(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

AVSpeechUtterance(NSAttributedString) AVSpeechUtterance(NSAttributedString)
AVSpeechUtterance(NSCoder) AVSpeechUtterance(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

AVSpeechUtterance(NSObjectFlag) AVSpeechUtterance(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

AVSpeechUtterance(String) AVSpeechUtterance(String)

Properties

AttributedSpeechString AttributedSpeechString
Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DefaultSpeechRate DefaultSpeechRate

Represents the value associated with the constant AVSpeechUtteranceDefaultSpeechRate

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
MaximumSpeechRate MaximumSpeechRate

Represents the value associated with the constant AVSpeechUtteranceMaximumSpeechRate

MinimumSpeechRate MinimumSpeechRate

Represents the value associated with the constant AVSpeechUtteranceMinimumSpeechRate

PitchMultiplier PitchMultiplier

Modifies the pitch of the Voice.

PostUtteranceDelay PostUtteranceDelay

The minimum delay, in seconds, after the last sound before the next enqueued AVSpeechUtterance will begin.

PreUtteranceDelay PreUtteranceDelay

The minimum delay, in seconds, between the start of speech synthesis and the first audible sound.

Rate Rate

The rate at which the utterance is spoken.

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
SpeechString SpeechString

The text to be spoken.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Voice Voice

The AVSpeechSynthesisVoice to be used for synthesis.

Volume Volume

The volume for speech.

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FromString(NSAttributedString) FromString(NSAttributedString)
FromString(String) FromString(String)

Factory method to create an AVSpeechUtterance for the speechString.

GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also