Configure audio encoding
Updated
Configure audio encoding properties and scenarios for Video Calling apps.
Audio quality requirements vary with application use-case. For example, in professional use-cases 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. RTC SDK enables you to configure audio encoding properties to meet such requirements.
This article shows you how to use RTC SDK to configure appropriate audio encoding properties and application scenarios in your app.
Understand the tech
RTC 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 |
|---|---|
initialize(RtcEngineContext context) | While initializing an IRtcEngine instance, set up the audio application scenario. The default value is AudioScenarioDefault. |
setAudioProfile(profile) | You can set audio encoding properties before or after joining a channel. |
setAudioScenario(scenario) | 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 use-case requires ensuring call quality and smooth transmission. Add the following code to your project:
// Initialize the IRtcEngine instance with a specific audio application scenario
const engine = createAgoraRtcEngine();
engine.initialize({
appId,
...,
audioScenario: AudioScenarioType.AudioScenarioDefault,
});
// Define the audio encoding settings
engine.setAudioProfile(AudioProfileType.AudioProfileDefault);KTV
KTV generally requires high sound quality and good expressiveness for music and singing. Use the following code in your project:
// Initialize the IRtcEngine instance with a specific audio application scenario
const engine = createAgoraRtcEngine();
engine.initialize({
appId,
...,
audioScenario: AudioScenarioType.AudioScenarioDefault,
});
// Define the audio encoding settings
engine.setAudioProfile(AudioProfileType.AudioProfileMusicHighQuality);Voice radio
Voice radio generally uses professional audio equipment. It requires high sound quality and stereo. Use the following code in your project:
// Initialize the IRtcEngine instance with a specific audio application scenario
const engine = createAgoraRtcEngine();
engine.initialize({
appId,
...,
audioScenario: AudioScenarioType.AudioScenarioGameStreaming,
});
// Define the audio encoding settings
engine.setAudioProfile(AudioProfileType.AudioProfileMusicHighQualityStereo);Music teaching
This use-case requires high sound quality, and support for the transmission of speaker-played sound effects. Agora recommends the following settings:
// Initialize the IRtcEngine instance with a specific audio application scenario
const engine = createAgoraRtcEngine();
engine.initialize({
appId,
...,
audioScenario: AudioScenarioType.AudioScenarioDefault,
});
// Define the audio encoding settings
engine.setAudioProfile(AudioProfileType.AudioProfileMusicStandardStereo);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.
Frequently asked questions
Sample projects
Agora offers the following open-source sample projects for setting audio encoding properties and application scenario functions for your reference.