this document primarily introduces how to use RTC Room Engine SDK to implement relevant features of background music.
Prerequisites
Before using the background music settings-related features provided by RTC Room Engine SDK, you need to log in to the SDK first. User Guide
Start/Stop Playing Background Music
You can start or stop playing background music by calling startPlayMusic and stopPlayMusic two APIs.
When calling startPlayMusic to start playing background music, you need to input a parameter in types of TXAudioMusicParam to set playback control information. TXAudioMusicParam contains following information, which you can set separately:
|
id | Field Meaning: Music ID. Special Instructions: The SDK allows playback of multiple music streams. Therefore, IDs are required for tagging to control the start, stop, and volume of the music. |
endTimeMS | Field Meaning: Music end playback time point, in milliseconds, with 0 indicating playback to the end of the file. |
isShortFile | Field Meaning: Whether the playback is a short music file. Recommended Value: YES: Short music files that need to be repeated. NO: Normal music file. Default value: NO. |
loopCount | Field Meaning: Number of music loops. Recommended Value: The value range is from 0 to any positive integer. The default value is 0. 0 means play the music once; 1 means play the music twice; and so on. |
path | Field Meaning: Complete path or URL address of the sound effect file. Supported audio formats include MP3, AAC, M4A, WAV. |
publish | Field Meaning: Whether to transmit music to remote end. Recommended Value: YES: The music can be played locally while the remote user can also hear it. NO: The anchor can only hear the music locally, and the remote audience cannot hear it. Default value: NO. |
startTimeMS | Field Meaning: Music start playback time point, in milliseconds. |
You can start or stop playing background music by calling startPlayMusic and stopPlayMusic two APIs.
When calling startPlayMusic to start playing background music, you need to input a parameter in types of AudioMusicParam to set playback control information. AudioMusicParam contains following information, which you can set separately:
|
id | Field Meaning: Music ID. Special Instructions: The SDK allows playback of multiple music streams. Therefore, IDs are required for tagging to control the start, stop, and volume of the music. |
endTimeMS | Field Meaning: Music end playback time point, in milliseconds, with 0 indicating playback to the end of the file. |
isShortFile | Field Meaning: Whether the playback is a short music file. Recommended Value: YES: Short music files that need to be repeated. NO: Normal music file. Default value: NO. |
loopCount | Field Meaning: Number of music loops. Recommended Value: The value range is from 0 to any positive integer. The default value is 0. 0 means play the music once; 1 means play the music twice; and so on. |
path | Field Meaning: Complete path or URL address of the sound effect file. Supported audio formats include MP3, AAC, M4A, WAV. |
publish | Field Meaning: Whether to transmit music to remote end. Recommended Value: YES: The music can be played locally while the remote user can also hear it. NO: The anchor can only hear the music locally, and the remote audience cannot hear it. Default value: NO. |
startTimeMS | Field Meaning: Music start playback time point, in milliseconds. |
The following is a simple example of starting/stopping playing background music:
import RTCRoomEngine
import TXLiteAVSDK_Professional
let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()
let musicParam = TXAudioMusicParam()
musicParam.id = 0
musicParam.path = "path"
musicParam.publish = true
musicParam.loopCount = 0
audioEffectManager.startPlayMusic(musicParam) { code in
if code == 0 {
} else {
}
} onProgress: { progress, duration in
} onComplete: { _ in
}
audioEffectManager.stopPlayMusic(musicId)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();
int id = 0;
String path = "path";
TXAudioEffectManager.AudioMusicParam musicParam = new TXAudioEffectManager.AudioMusicParam(id, path);
musicParam.publish = true;
musicParam.loopCount = 0;
audioEffectManager.startPlayMusic(musicParam);
audioEffectManager.stopPlayMusic(id);
Set Background Music Volume
You can set the background music volume by calling the setAllMusicVolume API and passing 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 setAllMusicVolume to set the background music volume:
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);