IosTextToSpeechAudioMode enum

Audio session mode identifiers for iOS.

See also:

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

Inheritance

• Object
• Enum
• IosTextToSpeechAudioMode

Constructors

IosTextToSpeechAudioMode()

const

Values

defaultMode → const IosTextToSpeechAudioMode

The default audio session mode.

You can use this mode with every IosTextToSpeechAudioCategory.

gameChat → const IosTextToSpeechAudioMode

A mode that the GameKit framework sets on behalf of an application that uses GameKit’s voice chat service.

This mode is valid only with the IosTextToSpeechAudioCategory.playAndRecord category.

Don’t set this mode directly. If you need similar behavior and aren’t using a GKVoiceChat object, use voiceChat or videoChat instead.

measurement → const IosTextToSpeechAudioMode

A mode that indicates that your app is performing measurement of audio input or output.

Use this mode for apps that need to minimize the amount of system-supplied signal processing to input and output signals. If recording on devices with more than one built-in microphone, the session uses the primary microphone.

For use with the IosTextToSpeechAudioCategory.playback or IosTextToSpeechAudioCategory.playAndRecord category.

Important: This mode disables some dynamics processing on input and output signals, resulting in a lower-output playback level.

moviePlayback → const IosTextToSpeechAudioMode

A mode that indicates that your app is playing back movie content.

When you set this mode, the audio session uses signal processing to enhance movie playback for certain audio routes such as built-in speaker or headphones. You may only use this mode with the IosTextToSpeechAudioCategory.playback category.

spokenAudio → const IosTextToSpeechAudioMode

A mode used for continuous spoken audio to pause the audio when another app plays a short audio prompt.

This mode is appropriate for apps that play continuous spoken audio, such as podcasts or audio books. Setting this mode indicates that your app should pause, rather than duck, its audio if another app plays a spoken audio prompt. After the interrupting app’s audio ends, you can resume your app’s audio playback.

videoChat → const IosTextToSpeechAudioMode

A mode that indicates that your app is engaging in online video conferencing.

Use this mode for video chat apps that use the IosTextToSpeechAudioCategory.playAndRecord category. When you set this mode, the audio session optimizes the device’s tonal equalization for voice. It also reduces the set of allowable audio routes to only those appropriate for video chat.

Using this mode has the side effect of enabling the IosTextToSpeechAudioCategoryOptions.allowBluetooth category option.

videoRecording → const IosTextToSpeechAudioMode

A mode that indicates that your app is recording a movie.

This mode is valid only with the IosTextToSpeechAudioCategory.playAndRecord category. On devices with more than one built-in microphone, the audio session uses the microphone closest to the video camera.

Use this mode to ensure that the system provides appropriate audio-signal processing.

voiceChat → const IosTextToSpeechAudioMode

A mode that indicates that your app is performing two-way voice communication, such as using Voice over Internet Protocol (VoIP).

Use this mode for Voice over IP (VoIP) apps that use the IosTextToSpeechAudioCategory.playAndRecord category. When you set this mode, the session optimizes the device’s tonal equalization for voice and reduces the set of allowable audio routes to only those appropriate for voice chat.

Using this mode has the side effect of enabling the IosTextToSpeechAudioCategoryOptions.allowBluetooth category option.

voicePrompt → const IosTextToSpeechAudioMode

A mode that indicates that your app plays audio using text-to-speech.

Setting this mode allows for different routing behaviors when your app is connected to certain audio devices, such as CarPlay. An example of an app that uses this mode is a turn-by-turn navigation app that plays short prompts to the user.

Typically, apps of the same type also configure their sessions to use the IosTextToSpeechAudioCategoryOptions.duckOthers and IosTextToSpeechAudioCategoryOptions.interruptSpokenAudioAndMixWithOthers options.

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<IosTextToSpeechAudioMode>

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