tencent cloud

Tencent Real-Time Communication

DocumentationTencent Real-Time CommunicationLegacy DocumentationRTC RoomEngine SDK（Old）Advanced FeaturesAudio Effect Settings

Audio Effect Settings

Download
Focus Mode
Font Size
Last updated: 2025-06-23 14:26:14
this document primarily introduces how to use RTC Room Engine SDK to implement related features of audio effect settings.

Prerequisites

Before using the background music settings-related features provided by the RTC Room Engine SDK, you need to log in first.

User Guide

Setting the Background Music Volume

You can set the background music volume by calling the setAllMusicVolume API and inputting an Int value.
The passed-in Int value represents the volume. The value range is 0 - 100. The following is an example of calling setAllMusicVolume to set the background music volume:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let volume = 60
audioEffectManager.setAllMusicVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int volume = 60;
audioEffectManager.setAllMusicVolume(volume);

Setting the Voice Volume

You can set the background music volume by calling the setVoiceVolume API and inputting an Int value.
The passed-in Int value represents the voice volume, with a value range of 0 - 100. The following is an example of calling setVoiceVolume to set the voice volume to 60:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let volume = 60
audioEffectManager.setVoiceVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int volume = 60;
audioEffectManager.setVoiceCaptureVolume(volume);

Turn On/Off the IEMs (In-Ear Monitors)

You can enable or disable the earpiece feedback by calling the enableVoiceEarMonitor API and inputting a Bool value.
The passed-in Bool value indicates whether to enable the earpiece feedback. true means enabling the earpiece feedback, and false means disabling it. The following is an example of calling the enableVoiceEarMonitor API to enable the earpiece feedback:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let enable = true
audioEffectManager.enableVoiceEarMonitor(enable)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

boolean enable = true;
audioEffectManager.enableVoiceEarMonitor(enable);

Set the Volume of IEMs

You can set the volume of the earpiece feedback by calling the setVoiceEarMonitorVolume API and inputting an Int value.
The passed-in Int value represents the volume, with a value range of 0 - 100. The following is an example of calling setVoiceEarMonitorVolume to set the volume of IEMs to 60:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let volume = 60
audioEffectManager.setVoiceEarMonitorVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int volume = 60;
audioEffectManager.setVoiceEarMonitorVolume(volume);

Set Voice Changing Effects

You can set the voice changer effect by calling the setVoiceChangerType API and inputting a TXVoiceChangeType value.
TXVoiceChangeType is an enumeration that includes the following types:
Error Example
Value
Description
TXVoiceChangeType_0
0
Off
TXVoiceChangeType_1
1
Mischievous child
TXVoiceChangeType_2
2
Lolita
TXVoiceChangeType_3
3
Uncle
TXVoiceChangeType_4
4
heavy metal
TXVoiceChangeType_5
5
Cold
TXVoiceChangeType_6
6
foreign accent
TXVoiceChangeType_7
7
trapped beast
TXVoiceChangeType_8
8
Fat otaku
TXVoiceChangeType_9
9
strong electric current
TXVoiceChangeType_10
10
heavy machinery
TXVoiceChangeType_11
11
Ethereal
The following is an example of calling the setVoiceChangerType API to set the voice changing effect to naughty boy:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let type: TXVoiceChangeType = ._1
audioEffectManager.setVoiceChangerType(type)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

TXAudioEffectManager.TXVoiceChangerType type = TXAudioEffectManager.TXVoiceChangerType.TXLiveVoiceChangerType_1;
audioEffectManager.setVoiceChangerType(type);

Set Reverb Effect

You can set the reverb effect by calling the setVoiceReverbType API and importing a TXVoiceReverbType value.
TXVoiceReverbType is an enumeration that includes the following types:
Error Example
Value
Description
TXVoiceReverbType_0
0
Turn off special effects
TXVoiceReverbType_1
1
KTV
TXVoiceReverbType_2
2
small room
TXVoiceReverbType_3
3
great hall
TXVoiceReverbType_4
4
Deep
TXVoiceReverbType_5
5
resonant
TXVoiceReverbType_6
6
Metallic sound
TXVoiceReverbType_7
7
magnetic
TXVoiceReverbType_8
8
Ethereal
TXVoiceReverbType_9
9
Studio
TXVoiceReverbType_10
10
Melodious
TXVoiceReverbType_11
11
Studio 2
The following is an example of calling the setVoiceReverbType API to set the reverb effect to KTV:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let type: TXVoiceReverbType = ._1
audioEffectManager.setVoiceReverbType(type)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

TXAudioEffectManager.TXVoiceReverbType type = TXAudioEffectManager.TXVoiceReverbType.TXLiveVoiceReverbType_1;
audioEffectManager.setVoiceReverbType(type);
Note:
If you need to use more audio effect settings related features, please see TXAudioEffectManager.

Previous Topic: Background MusicNext Topic: Beauty Settings

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback