AudioScenario enum

Audio scene type

After selecting an audio scene, RTC will automatically apply call volume/media volume based on the client's audio capture playback device and status.
If the preset audio scene type cannot meet your business needs, please contact technical support for customization.

Inheritance

Object
Enum
AudioScenario

Constructors

AudioScenario(): const

Values

music → const AudioScenario

Music scene. Default setting.

This option is suitable for scenes that require musical expression. Such as live music.
Audio capture playback device and capture playback status, the mapping to the volume type is as follows:

	Mic off	Mic on	Remarks
Build-in microphone and speaker/earpiece	Media volume	Call volume	/
Wired headset/ USB headset/ Sound card	Media volume	Media volume
Bluetooth headset	Media volume	Media volume	Media volume	Only the device's build-in microphone can be used for local audio capture, even if the Bluetooth headset has a microphone.

highQualityCommunication → const AudioScenario

High-quality call scene.

This option is suitable for scenarios where musical expression is required but you also want to be able to use the microphone that comes with the Bluetooth headset for audio capture.
This scenario allows for a balanced audio experience when playing out/using Bluetooth headphones and avoids the sudden change in listening experience caused by switching between volume types when using Bluetooth headphones.
Audio capture playback device and capture playback status, the mapping to the volume type is as follows:

	Mic off	Mic on	Remarks
Build-in microphone and speaker/earpiece	Media volume	Call volume	/
Wired headset/ USB headset/ Sound card	Media volume	Media volume	/
Bluetooth headset	Call volume	Call volume	Call volume	The microphone on the Bluetooth headset can be used for audio capture.

communication → const AudioScenario

Call volume-only scene.

This option is suitable for calls or conference scenarios where frequent speaker switching is required.
In this scenario, the call volume is used throughout, regardless of the client audio capture/playback device and capture/playback status.
This scene maintains a uniform audio pattern without sudden volume changes in listening; echoes are eliminated to the greatest extent possible for optimum call clarity.
When using a Bluetooth headset, you can use the microphone that comes with the Bluetooth headset for audio capture.
However, this scene will depress the volume of other audio being played back using the media volume and the sound quality will deteriorate.

media → const AudioScenario

Pure media scene. It is generally not recommended.

In this scenario, regardless of the client side audio acquisition and playback device and the acquisition and playback status, the media volume is used throughout the process. If the audio quality is unsatisfactory when you put on speaker, please contact our technical support team.

gameStreaming → const AudioScenario

Game media scene. Only suitable for game scenes.

In this scenario, the Bluetooth headset uses the call volume, and other devices use the media volume. If the audio quality is unsatisfactory when you put on speaker, please contact our technical support team.

highQualityChat → const AudioScenario

High-quality chatting scenario.

This scenario is the same as highQualityCommunication, but in one case: in this scenario, switching on/off the microphone does not change the volume type. When you talk with the built-in microphone and speaker/earpiece, the call volume is used all the time.

For different audio device and status, the selected volume type is as follows:

	Mic Off	Mic On	Remarks
Build-in microphone and speaker	Call volume	call volume	/
earpiece	Call volume	call volume	/
Wired headset/ USB headset/ external sound card	Media volume	Media Volume	/
Bluetooth Headset	Call Volume	Call Volume	Ability to use the microphone included in the Bluetooth headset for audio capture.

Properties

hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

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<AudioScenario>: A constant List of the values in this enum, in order of their declaration.