Configure audio encoding

Audio quality requirements vary with application scenario. For example. in professional scenarios such as radio stations and singing competitions users are particularly sensitive to audio quality. In such cases, support for dual-channel and high-quality sound is required. High-quality sound means setting a high sampling rate and a high bitrate to achieve realistic audio. Voice SDK enables you to configure audio encoding properties to meet such requirements.

This article shows you how to use Voice SDK to configure appropriate audio encoding properties and application scenarios in your app.

Understand the tech

Voice SDK uses default encoding parameters and a default audio scenario that are suitable for most common applications. If the default settings do not meet your needs, refer to the examples in the implementation section to set appropriate audio encoding properties and an application scenario.

Prerequisites

Ensure that you have implemented the SDK quickstart in your project.

Implementation

This section shows you how to set audio encoding properties and application scenarios for common applications. You use the following APIs to configure audio encoding:

API	Description
`create(config.mAudioScenario)`	While creating an `RtcEngine` instance, set the audio application scenario. The default value is `AUDIO_SCENARIO_DEFAULT`.
`setAudioProfile(profile)`	You can set audio encoding properties before or after joining a channel.
`setAudioScenario`	You can set an application scenario before or after joining a channel.

Refer to the following examples to choose the most appropriate settings for your application.

1-on-1 interactive teaching

This scenario requires ensuring call quality and smooth transmission. Add the following code to your project:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.DEFAULT);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_DEFAULT);

Gaming voice chat

This scene requires the transmission of clear human voice with minimal background noise and at a low bitrate. Agora recommends the following settings:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.CHATROOM);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_SPEECH_STANDARD);

Scripted role play

This scenario requires good sound expression, and no volume or sound quality change when switching microphones. Agora recommends the following settings:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.CHATROOM);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_STANDARD);

KTV

KTV generally requires high sound quality and good expressiveness for music and singing. Use the following code in your project:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.GAME_STREAMING);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY);

Voice radio

Voice radio generally uses professional audio equipment. It requires high sound quality and stereo. Use the following code in your project:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.GAME_STREAMING);
engine = RtcEngine.create(config);
// Set the required audio encoding properties
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO);

Music teaching

This scenario requires high sound quality, and support for the transmission of speaker-played sound effects. Agora recommends the following settings:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.GAME_STREAMING);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_STANDARD_STEREO);

Dual-teacher classroom

This scenario requires high sound quality with rich sound effects, and no volume or sound quality change when switching microphones. Agora recommends the following settings:

// Create the RtcEngine instance with a specific audio application scenario
config.mAudioScenario = Constants.AudioScenario.getValue(Constants.AudioScenario.CHATROOM);
engine = RtcEngine.create(config);
// Define the audio encoding settings
RtcEngine.setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_STANDARD_STEREO);

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For more audio settings, see Achieve high audio quality.