IosTextToSpeechAudioCategory enum

Audio session category identifiers for iOS.

See also:

• https://developer.apple.com/documentation/avfaudio/avaudiosession/category

Inheritance

• Object
• Enum
• IosTextToSpeechAudioCategory

Constructors

IosTextToSpeechAudioCategory()

const

Values

ambientSolo → const IosTextToSpeechAudioCategory

The default audio session category.

Your audio is silenced by screen locking and by the Silent switch.

By default, using this category implies that your app’s audio is nonmixable—activating your session will interrupt any other audio sessions which are also nonmixable. To allow mixing, use the ambient category instead.

ambient → const IosTextToSpeechAudioCategory

The category for an app in which sound playback is nonprimary — that is, your app also works with the sound turned off.

This category is also appropriate for “play-along” apps, such as a virtual piano that a user plays while the Music app is playing. When you use this category, audio from other apps mixes with your audio. Screen locking and the Silent switch (on iPhone, the Ring/Silent switch) silence your audio.

playback → const IosTextToSpeechAudioCategory

The category for playing recorded music or other sounds that are central to the successful use of your app.

When using this category, your app audio continues with the Silent switch set to silent or when the screen locks.

By default, using this category implies that your app’s audio is nonmixable—activating your session will interrupt any other audio sessions which are also nonmixable. To allow mixing for this category, use the IosTextToSpeechAudioCategoryOptions.mixWithOthers option.

playAndRecord → const IosTextToSpeechAudioCategory

The category for recording (input) and playback (output) of audio, such as for a Voice over Internet Protocol (VoIP) app.

Your audio continues with the Silent switch set to silent and with the screen locked. This category is appropriate for simultaneous recording and playback, and also for apps that record and play back, but not simultaneously.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<IosTextToSpeechAudioCategory>

A constant List of the values in this enum, in order of their declaration.