播放音效与混音文件

功能描述

在实时音视频互动过程中，为烘托气氛、增添趣味性，用户通常需要播放音效或音乐文件并且让频道内所有用户都听到。例如，在游戏中添加打斗声，在唱歌时添加伴奏。声网提供两组独立的方法，你可以分别实现播放音效和音乐文件。

开始前请确保已在你的项目中实现基本的实时音视频功能。 详见实现音频通话或实现音频直播。

播放音效文件

音效通常指持续很短的音频。播放音效文件方法主要用来播放短小的氛围音，比如鼓掌、游戏子弹撞击声音等，可以多个音效叠加播放。

音效由音频文件路径指定，但在 SDK 内部使用 nSoundID 来识别和处理音效。SDK 并不强制如何定义 nSoundID，保证每个音效有唯一的识别即可。一般的做法有自增 id，使用音效文件名的 hashCode 等。

实现方法

参考如下步骤，在你的项目中实现播放音效文件：

1. 在加入频道前调用 GetAudioEffectManager 方法获取音效管理类 AudioEffectManagerImpl。
2. 调用 PreloadEffect 方法预加载音效文件，可以多次调用该方法加载多个音效文件。
3. 加入频道后调用 PlayEffect 方法播放音效文件，可以多次调用该方法同时播放多个音效。我们建议最多同时播放三个音效文件。

下图展示与播放音效相关的 API 时序，在开始播放音效后你还可以调用其他音效相关的方法实现更多功能，包括暂停播放音效、设置音效音量、释放预加载的音效等。

示例代码

// 初始化参数对象。
AudioEffectManagerImpl audioEffectManager = (AudioEffectManagerImpl)mRtcEngine.GetAudioEffectManager();
// 预加载音效文件，可以多次调用该方法加载多个音效文件。
int ret = audioEffectManager.PreloadEffect(nSoundID, filePath);
// 播放指定音效文件。
int ret = audioEffectManager.PlayEffect(nSoundID, filePath, nLoopCount, dPitch, dPan, nGain, true);
// 暂停指定的音效播放。
int ret = audioEffectManager.PauseEffect(nSoundID);
// 暂停所有音效播放。
int ret = audioEffectManager.PauseAllEffects();
// 继续播放已暂停的指定音效文件。
int ret = audioEffectManager.ResumeEffect(nSoundID);
// 继续播放所有已暂停的指定音效文件。
int ret = audioEffectManager.ResumeAllEffects();
// 停止播放指定音效文件。
int ret = audioEffectManager.StopEffect(nSoundID);
// 停止播放所有音效文件。
int ret = audioEffectManager.StopAllEffects();
// 从内存释放某个预加载的音效文件。
int ret = audioEffectManager.UnloadEffect(nSoundID);

API 参考

• GetAudioEffectManager
• PreloadEffect
• PlayEffect
• PauseEffect
• PauseAllEffects
• ResumeEffect
• ResumeAllEffects
• StopEffect
• StopAllEffects
• UnloadEffect

开发注意事项

预加载不是一个必须的步骤，一般来说为了提高性能或者需要反复播放某个特定的音效的时候，我们建议使用预加载。但如果音效文件较大，不建议预加载。

音乐混音

混音是指播放本地或者在线音乐文件，同时让频道内的其他人听到此音乐。混音方法主要用来播放比较长的背景音，比如直播的时候播放的音乐，同时只可以有一个文件播放。如果在混音播放第一个文件的过程中播放第二个文件，会自动停止第一个文件的播放。

声网混音功能支持如下设置：

• 混音或替换： 混音指的是音乐文件的音频流跟麦克风采集的音频流进行混音（叠加）并编码发送给对方；替换指的是麦克风采集的音频被音乐文件的音频流替换掉，对方只能听见音乐播放。
• 循环：可以设置是否循环播放混音文件，以及循环次数。

实现方法

string filePath = "http://www.hochmuth.com/mp3/Haydn_Cello_Concerto_D-1.mp3";
// 开始播放音乐文件。
int ret = mRtcEngine.StartAudioMixing(filePath, false, true, 1);
// 将本地和远端音乐文件播放音量调节为 50。
int ret = mRtcEngine.AdjustAudioMixingVolume(50);
// 获取音乐文件的本地播放音量。
int ret = mRtcEngine.GetAudioMixingPlayoutVolume();
// 获取音乐文件的远端播放音量。
int ret = mRtcEngine.GetAudioMixingPublishVolume();
// 获取音乐文件总时长。
int ret = mRtcEngine.GetAudioMixingDuration();
// 获取音乐文件的播放进度。
int ret = mRtcEngine.GetAudioMixingCurrentPosition();
// 将音乐文件的播放位置设置为第 3000 毫秒处。
int ret = mRtcEngine.SetAudioMixingPosition(3000);
// 停止播放音乐文件。
int ret = mRtcEngine.StopAudioMixing();

API 参考

• StartAudioMixing
• StopAudioMixng
• PauseAudioMixing
• ResumeAudioMixing
• AdjustAudioMixingVolume
• AdjustAudioMixingPlayoutVolume
• AdjustAudioMixingPublishVolume
• GetAudioMixingPlayoutVolume
• GetAudioMixingPublishVolume
• GetAudioMixingDuration
• GetAudioMixingCurrentPosition
• SetAudioMixingPosition
• OnAudioMixingStateChangedHandler
• OnRemoteAudioMixingBeginHandler
• OnRemoteAudioMixingEndHandler

开发注意事项

请确保在频道内调用混音方法，否则会有潜在问题。