游戏多媒体引擎 实时语音伴奏

一、实时语音伴奏相关接口

注意：说明：

注意：如需使用实时语音伴奏，需要在接入 GME SDK 且能在进行实时语音通话的情况下，才可以使用实时语音伴奏。

三、如何配合 EnableAudioCaputreDevice 使用

在进入实时语音房间成功之后，调用 EnableAudioCaputreDevice 打开采集设备，再调用 StartAccompany 播放伴奏。如果需要采集人声，可以调用 EnableAudioSend 实现开麦效果。

四、开始播放伴奏

调用 StartAccompany 接口开始播放伴奏。支持 m4a、wav、mp3 一共三种格式。调用此 API，音量会重置。

五、函数原型

ITMGAudioEffectCtrl virtual int StartAccompany(const char* filePath, bool loopBack, int loopCount, int msTime)

六、示例代码

//Windows端代码ITMGContextGetInstance()->GetAudioEffectCtrl()->StartAccompany(filePath,true,-1,0);//Android端代码ITMGContext.GetInstance(this).GetAudioEffectCtrl().StartAccompany(filePath,true,loopCount,0);//iOS端代码[[[ITMGContext GetInstance] GetAudioEffectCtrl] StartAccompany:path loopBack:isLoopBack loopCount:loopCount msTime:0];

注意：iOS 端需要以下配置。

1. 在 iOS 端使用此功能，需要将相关动态库引入工程中，单击下载 mp3 动态库。

2. 将下载好的文件引入到工程文件中。并在 Link Binary With Libraries 中添加此动态库。

3. 将头文件 TMGEngine_adv.h 加入工程中，与其他 SDK 头文件同目录下。

七、播放伴奏的回调

开始播放伴奏完成后，回调函数调用 OnEvent，事件消息为 ITMG_MAIN_EVENT_TYPE_ACCOMPANY_FINISH，在 OnEvent 函数中对事件消息进行判断。
传递的参数 data 包含两个信息，一个是 result，另一个是 file_path。

八、示例代码

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){ switch (eventType) { case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM: { //进行处理 break; } … case ITMG_MAIN_EVENT_TYPE_ACCOMPANY_FINISH: { //进行处理 break; } }}

九、停止播放伴奏

调用 StopAccompany 接口停止播放伴奏。

十、函数原型

ITMGAudioEffectCtrl virtual int StopAccompany(int duckerTime)

十一、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->StopAccompany(0);

十二、伴奏是否播放完毕

如果播放完毕，返回值为 true，如果没播放完，返回值为 false。

十三、函数原型

ITMGAudioEffectCtrl virtual bool IsAccompanyPlayEnd()

十四、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->IsAccompanyPlayEnd();

十五、暂停播放伴奏

调用 PauseAccompany 接口暂停播放伴奏。

十六、函数原型

ITMGAudioEffectCtrl virtual int PauseAccompany()

十七、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->PauseAccompany();

十八、恢复播放伴奏

ResumeAccompany 接口用于恢复播放伴奏。

十九、函数原型

ITMGAudioEffectCtrl virtual int ResumeAccompany()

20、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->ResumeAccompany();

21、设置自己是否可以听到伴奏

此接口用于设置自己是否可以听到伴奏。

22、函数原型

ITMGAudioEffectCtrl virtual int EnableAccompanyPlay(bool enable)

23、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->EnableAccompanyPlay(false);

24、设置他人是否也可以听到伴奏

设置他人是否也可以听到伴奏。

25、函数原型

ITMGAudioEffectCtrl virtual int EnableAccompanyLoopBack(bool enable)

26、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->EnableAccompanyLoopBack(false);

27、设置伴奏音量

调用 SetAccompanyVolume 接口设置伴奏音量，默认值为100，数值大于100音量增益，数值小于100音量减益，值域为0 – 200。

28、函数原型

ITMGAudioEffectCtrl virtual int SetAccompanyVolume(int vol)

29、示例代码

int vol=100;ITMGContextGetInstance()->GetAudioEffectCtrl()->SetAccompanyVolume(vol);

30、获取播放伴奏的音量

GetAccompanyVolume 接口用于获取伴奏音量。

31、函数原型

ITMGAudioEffectCtrl virtual int GetAccompanyVolume()

32、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->GetAccompanyVolume();

33、获得伴奏播放进度

以下两个接口用于获得伴奏播放进度。需要注意：Current / Total = 当前循环次数，Current % Total = 当前循环播放位置。

34、函数原型

ITMGAudioEffectCtrl virtual int GetAccompanyFileTotalTimeByMs()ITMGAudioEffectCtrl virtual int GetAccompanyFileCurrentPlayedTimeByMs()

35、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->GetAccompanyFileTotalTimeByMs();ITMGContextGetInstance()->GetAudioEffectCtrl()->GetAccompanyFileCurrentPlayedTimeByMs();

36、设置播放进度

SetAccompanyFileCurrentPlayedTimeByMs 接口用于设置播放进度。

37、函数原型

ITMGAudioEffectCtrl virtual int SetAccompanyFileCurrentPlayedTimeByMs(unsigned int time)

38、示例代码

ITMGContextGetInstance()->GetAudioEffectCtrl()->SetAccompanyFileCurrentPlayedTimeByMs(time);

39、设置伴奏音调

SetAccompanyKey 接口用于调整伴奏的音调，在启动伴奏之前调用。

40、函数原型

ITMGAudioEffectCtrl virtual int SetAccompanyKey(int nKey)

41、错误码列表