文档捉虫大赛火热进行中,好礼多多> HOT
为方便 Windows 开发者调试和接入腾讯云游戏多媒体引擎客户端 API,本文为您介绍适用于 Windows 实时语音功能的开发接入技术文档。

使用 GME 重要事项

GME 提供实时语音服务、语音消息服务及转文本服务,使用 GME 服务都依赖 Init 和 Poll 等核心接口。

重点提示

已完成 GME 应用创建,并获取 SDK AppID 和 Key。请参考 服务开通指引
已开通 GME 实时语音服务、语音消息服务以及转文本服务。请参考 服务开通指引
GME 使用前请对工程进行配置,否则 SDK 不生效。
GME 的接口调用成功后返回值为 QAVError.OK,数值为 0。
GME 的接口调用要在同一个线程下。
GME 需要周期性的调用 Poll 接口触发事件回调。
错误码详情可参考 错误码

接入 SDK

重要步骤

接入 SDK 重要流程如下:



1. 初始化 GME

C++ 类

含义
ITMGContext
核心接口
ITMGDelegate
回调相关
ITMGRoom
房间相关接口
ITMGRoomManager
ITMGAudioCtrl
音频相关接口
ITMGAudioEffectCtrl
音效及伴奏相关接口
ITMGPTT
语音消息、转文本相关接口

核心接口

接口
接口含义
Init
初始化 GME
Poll
触发事件回调
Pause
系统暂停
Resume
系统恢复
Uninit
反初始化 GME

引用头文件

接入 GME 首先需要引入头文件 tmg_sdk.h,头文件类继承 ITMGDelegate 以进行消息的传递及回调。

示例代码

#include "auth_buffer.h"
#include "tmg_sdk.h"
#include "AdvanceHeaders/tmg_sdk_adv.h"
#include <vector>

回调

设置回调示例代码

//在初始化 SDK 时候
m_pTmgContext = ITMGContextGetInstance();
m_pTmgContext->SetTMGDelegate(this);

//在析构函数中
CTMGSDK_For_AudioDlg::~CTMGSDK_For_AudioDlg()
{
ITMGContextGetInstance()->SetTMGDelegate(NULL);
}


消息传递

接口类采用 Delegate 方法用于向应用程序发送回调通知,消息类型参考 ITMG_MAIN_EVENT_TYPE,data 在 Windows 平台下是 json 字符串格式, 具体 key-value 参见说明文档。
//头文件中声明
virtual void OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data);
//示例代码
void CTMGSDK_For_AudioDlg::OnEvent(ITMG_MAIN_EVENT_TYPE eventType, const char* data)
{
switch(eventType)
{
case ITMG_MAIN_EVENT_TYPE_XXXX_XXXX:
{
//对回调进行处理
}
break;
}
}

获取单例

GME SDK 以单例的形式提供,所有调用都从 ITMGContext 开始,通过 ITMGDelegate 回调回传给应用,必须首先设置。

示例代码

ITMGContext* m_pTmgContext;
m_pTmgContext->Init(AppID, OpenID);

初始化 SDK

未初始化前,SDK 处于未初始化阶段,需要通过接口 Init 初始化 SDK,才可以使用实时语音服务、语音消息服务及转文本服务。调用 Init 接口的线程必须于其他接口在同一线程,建议都在主线程调用接口。

接口原型

ITMGContext virtual int Init(const char* sdkAppId, const char* openId)
参数
类型
含义
sdkAppId
const char*
来自 腾讯云控制台 的 GME 服务提供的 AppID,获取请参考 语音服务开通指引
openID
const char*
openID 只支持 Int64 类型(转为 const char* 传入)。 规则由 App 开发者自行制定,App 内不重复即可。如需使用字符串作为 Openid 传入,可通过工单联系开发者。

返回值

返回值
处理
AV_OK = 0
初始化 SDK 成功
AV_ERR_SDK_NOT_FULL_UPDATE=7015
检查 SDK 文件是否完整,建议删除后重新导入 SDK
关于7015错误提示
7015错误码是通过 md5 进行判断,在接入过程中若出现此错误,请根据提示检查 SDK 文件是否完整、SDK 文件版本是否一致。
出现返回值 AV_ERR_SDK_NOT_FULL_UPDATE 时,此返回值只有提示作用,并不会造成初始化失败。
由于第三方加固、Unity 打包机制等因素会影响库文件 md5,造成误判,所以正式发布请在逻辑中忽略此错误,并尽量不在 UI 中提示。

示例代码

#define SDKAPPID3RD "14000xxxxx"
cosnt char* openId="10001";
ITMGContext* context = ITMGContextGetInstance();
context->Init(SDKAPPID3RD, openId);

触发事件回调

通过在 update 里面周期的调用 Poll 可以触发事件回调。Poll 是 GME 的消息泵,GME 需要周期性的调用 Poll 接口触发事件回调。如果没有调用 Poll ,将会导致整个 SDK 服务运行异常。 可参考 Demo 中的 EnginePollHelper.cpp 文件。
务必周期性调用 Poll 接口
务必周期性调用 Poll 接口且在主线程调用,以免接口回调异常。

接口原型

class ITMGContext {
protected:
virtual ~ITMGContext() {}

public:
virtual void Poll()= 0;
}

示例代码

//头文件中的声明

//代码实现
void TMGTestScene::update(float delta)
{
ITMGContextGetInstance()->Poll();
}

系统暂停

当系统发生 Pause 事件时,需要同时通知引擎进行 Pause。如果不需要后台播放房间内声音,请调用 Pause 接口暂停整个 GME 服务。

接口原型

ITMGContext int Pause()

系统恢复

当系统发生 Resume 事件时,需要同时通知引擎进行 Resume。Resume 接口只恢复实时语音。

接口原型

ITMGContext int Resume()

反初始化 SDK

反初始化 SDK,进入未初始化状态。如果游戏业务侧账号与 openid 是绑定的,那切换游戏账号需要反初始化 GME,再用新的 openid 初始化

接口原型

ITMGContext int Uninit()

实时语音房间相关接口

初始化之后,SDK 调用进房后进去了房间,才可以进行实时语音通话。 使用问题可参考 实时语音相关问题



接口
接口含义
GenAuthBuffer
本地鉴权计算
EnterRoom
加入房间
ExitRoom
退出房间
IsRoomEntered
判断是否已经进入房间
SwitchRoom
快速切换房间

本地鉴权计算

生成 AuthBuffer,用于相关功能的加密和鉴权,如正式发布请使用后台部署密钥,后台部署请参考 鉴权密钥

接口原型

int QAVSDK_AuthBuffer_GenAuthBuffer(unsigned int dwSdkAppID, const char* strRoomID, const char* strOpenID,
const char* strKey, unsigned char* strAuthBuffer, unsigned int bufferLength);
参数
类型
含义
dwSdkAppID
unsigned int
来自腾讯云控制台的 AppId 号码
strRoomID
const char*
房间号,最大支持127字符
strOpenID
const char*
用户标识。与 Init 时候的 openID相同。
strKey
const char*
来自腾讯云 控制台 的权限密钥
strAuthBuffer
const char*
返回的 authbuff
bufferLength
int
传入的 authbuff 长度,建议为 500

示例代码

unsigned int bufferLen = 512;
unsigned char retAuthBuff[512] = {0};
QAVSDK_AuthBuffer_GenAuthBuffer(atoi(SDKAPPID3RD), roomId, "10001", AUTHKEY,retAuthBuff,bufferLen);

加入房间

用生成的鉴权信息进房,加入房间默认不打开麦克风及扬声器。
注意
加入房间事件回调结果 result 为 0 代表进房成功,进房接口 EnterRoom 返回值为 0 不代表进房成功。
房间的音频类型由第一个进房的人确定,此后房间里有成员修改房间类型,将对此房间所有成员生效。例如第一个进入房间的人使用的房间音频类型是流畅音质,第二个进房的是即使进房时候调用接口的音频类型参数是高清音质,进入房间之后也会变成流畅音质。需要有成员调用 ChangeRoomType 才会修改房间的音频类型。

接口原型

ITMGContext virtual int EnterRoom(const char* roomID, ITMG_ROOM_TYPE roomType, const char* authBuff, int buffLen)
参数
类型
含义
roomID
const char*
房间号,最大支持127字符
roomType
ITMG_ROOM_TYPE
房间类型,游戏建议使用 ITMG_ROOM_TYPE_FLUENCY。房间音频类型请参考 音质选择
authBuffer
const char*
鉴权码
buffLen
int
鉴权码长度

示例代码

ITMGContext* context = ITMGContextGetInstance();
context->EnterRoom(roomID, ITMG_ROOM_TYPE_FLUENCY, (char*)retAuthBuff,bufferLen);

加入房间事件回调

加入房间完成后会发送信息 ITMG_MAIN_EVENT_TYPE_ENTER_ROOM,在 OnEvent 函数中进行判断回调后处理。如果回调为成功,即此时进房成功,开始进行计费

示例代码

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
switch (eventType) {
case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
{
ListMicDevices();
ListSpeakerDevices();

std::string strText = "EnterRoom complete: ret=";
strText += data;
m_EditMonitor.SetWindowText(MByteToWChar(strText).c_str());
}
}
}

Data 详情

消息
Data
例子
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT
result; error_info
{"error_info":"waiting timeout, please check your network","result":0}
如果断网,将会有断网的回调提示 ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT,此时 SDK 会自动进行重连,回调是 ITMG_MAIN_EVENT_TYPE_RECONNECT_START,当重连成功时,会有 ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS 回调。

错误码

错误码值
原因及建议方案
7006
鉴权失败原因。
AppID 不存在或者错误
authbuff 鉴权错误
鉴权过期
OpenId 不符合规范
7007
已经在其它房间
1001
已经在进房过程中,然后又重复了此操作。建议在进房回调返回之前不要再调用进房接口
1003
已经进房了在房间中,又调用一次进房接口
1101
确保已经初始化 SDK,确保 OpenId 是否符合规则,或者确保在同一线程调用接口,以及确保 Poll 接口正常调用

退出房间

通过调用此接口可以退出所在房间。这是一个异步接口,返回值为 AV_OK 的时候代表异步投递成功。如果应用中有退房后立即进房的场景,在接口调用流程上,开发者无需要等待 ExitRoom 的回调 RoomExitComplete 通知,只需直接调用接口。

接口原型

ITMGContext virtual int ExitRoom()

示例代码

ITMGContext* context = ITMGContextGetInstance();
context->ExitRoom();

退出房间事件回调

退出房间完成后会有回调,消息为 ITMG_MAIN_EVENT_TYPE_EXIT_ROOM。

示例代码

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

Data详情

消息
Data
例子
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
result; error_info
{"error_info":"","result":0}

判断是否已经进入房间

通过调用此接口可以判断是否已经进入房间,返回值为 bool 类型。请勿在进房过程中调用。

接口原型

ITMGContext virtual bool IsRoomEntered()

示例代码

ITMGContext* context = ITMGContextGetInstance();
context->IsRoomEntered();


快速切换房间

调用此接口快速切换实时语音房间。此接口在进房后调用。切换房间后,不重置设备,即如果在此房间已经是打开麦克风状态,在切换房间后也会是打开麦克风状态。 快速切换房间的回调是 ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM,字段是 error_info 以及 result。

接口原型

ITMGContext virtual int SwitchRoom(const char* targetRoomID, const char* authBuff, int buffLen);

类型说明

参数
类型
含义
targetRoomID
const char*
将要进入的房间号
authBuffer
const char*
用将要进入的房间号生成的新鉴权
buffLen
int
鉴权码长度

房间内状态维护

此部分接口用于业务层显示说话成员、进退房成员,以及将房间内某成员禁言等功能。



接口/通知
含义
ITMG_MAIN_EVNET_TYPE_USER_UPDATE
成员状态变化通知
AddAudioBlackList
房间中禁言某成员
RemoveAudioBlackList
移除禁言

成员进房、说话状态通知事件

此接口适用于获取房间中说话的人并在 UI 中展示,以及有人进入、退出语音房间的一个通知。 该事件在状态变化才通知,状态不变化的情况下不通知。如需实时获取成员状态,请在上层收到通知时缓存,事件消息为 ITMG_MAIN_EVNET_TYPE_USER_UPDATE,其中 data 包含两个信息,event_id 及 user_list,在 OnEvent 函数中对事件消息进行判断。 音频事件的通知有一个阈值,超过这个阈值才会发送通知。超过两秒没有收到音频包才通知“有成员停止发送音频包”消息。
event_id
含义
应用侧维护内容
ITMG_EVENT_ID_USER_ENTER
有成员进入房间,返回此时进房的 openid
应用侧维护成员列表
ITMG_EVENT_ID_USER_EXIT
有成员退出房间,返回此时退房的 openid
应用侧维护成员列表
ITMG_EVENT_ID_USER_HAS_AUDIO
有成员发送音频包,返回此时房间内说话的 openid,通过此事件可以判断用户是否说话,并展示声纹效果
应用侧维护通话成员列表
ITMG_EVENT_ID_USER_NO_AUDIO
有成员停止发送音频包,返回此时房间内停止说话的 openid
应用侧维护通话成员列表

示例代码

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
switch (eventType) {
case ITMG_MAIN_EVNET_TYPE_USER_UPDATE:
{
//进行处理
//开发者对参数进行解析,得到信息 eventID 及 user_list
switch (eventID)
{
case ITMG_EVENT_ID_USER_ENTER:
//有成员进入房间
break;
case ITMG_EVENT_ID_USER_EXIT:
//有成员退出房间
break;
case ITMG_EVENT_ID_USER_HAS_AUDIO:
//有成员发送音频包
break;
case ITMG_EVENT_ID_USER_NO_AUDIO:
//有成员停止发送音频包
break;
default:
break;
}
break;
}
}
}

房间中禁言某成员

将某个 ID 加入音频数据黑名单,即不接受某人的语音, 只对本端生效,不会影响其他端。返回值为 0 表示调用成功。例如 :A、B、C 都在同一个房间开麦说话:
如果 A 设置了 C 的黑名单, 则 A 只能听见 B 的声音。
B 因为没有设置黑名单, 仍旧可以听见 A 和 C 的声音。
C 同样因为没有设置黑名单, 可以听见 A 和 B 的声音。
此接口适用于在语音房间中将某用户禁言的场景。

接口原型

ITMGContext ITMGAudioCtrl int AddAudioBlackList(const char* openId)
参数
类型
含义
openId
char*
需添加黑名单的用户 openid

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->AddAudioBlackList(openId);

移除禁言

将某个 Id 移除音频数据黑名单。返回值为0表示调用成功。

接口原型

ITMGContext ITMGAudioCtrl int RemoveAudioBlackList(const char* openId)
参数
类型
含义
openId
char*
需移除黑名单的 ID

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->RemoveAudioBlackList(openId);

实时语音采集相关接口

初始化 SDK 之后进房,在房间中,才可以调用实时音频语音相关接口。
当用户界面单击打开/关闭麦克风/扬声器按钮时,建议采用 EnableMic 以及 EnableSpeaker 接口进行调用。
当用户界面按住麦克风按钮时发言,放开按钮不发言,建议采用进房时候调用 EnableAudioCaptureDevice 一次,后续按住发言调用 EnableAudioSend 来实现。
接口
接口含义
EnableMic
开关麦克风
GetMicState
获取麦克风状态
EnableAudioCaptureDevice
开关采集设备
IsAudioCaptureDeviceEnabled
获取采集设备状态
EnableAudioSend
打开关闭音频上行
IsAudioSendEnabled
获取音频上行状态
GetMicLevel
获取实时麦克风音量
GetSendStreamLevel
获取音频上行实时音量
SetMicVolume
设置麦克风音量
GetMicVolume
获取麦克风音量


开启或关闭麦克风

此接口用来开启关闭麦克风。加入房间默认不打开麦克风及扬声器。EnableMic = EnableAudioCaptureDevice + EnableAudioSend

接口原型

ITMGAudioCtrl virtual int EnableMic(bool bEnabled)
参数
类型
含义
bEnabled
bool
如果需要打开麦克风,则传入的参数为 true,如果关闭麦克风,则参数为 false

示例代码

//打开麦克风
ITMGContextGetInstance()->GetAudioCtrl()->EnableMic(true);

麦克风状态获取

此接口用于获取麦克风状态,返回值0为关闭麦克风状态,返回值1为打开麦克风状态。

接口原型

ITMGAudioCtrl virtual int GetMicState()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetMicState();

开启或关闭采集设备

此接口用来开启/关闭采集设备。加入房间默认不打开设备。
只能在进房后调用此接口,退房会自动关闭设备。
在移动端,打开采集设备通常会伴随权限申请,音量类型调整等操作。

接口原型

ITMGAudioCtrl virtual int EnableAudioCaptureDevice(bool enable)
参数
类型
含义
enable
bool
如果需要打开采集设备,则传入的参数为 true,如果关闭采集设备,则参数为 false

示例代码

//打开采集设备
ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioCaptureDevice(true);

采集设备状态获取

此接口用于采集设备状态获取。

接口原型

ITMGContext virtual bool IsAudioCaptureDeviceEnabled()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioCaptureDeviceEnabled();

打开或关闭音频上行

此接口用于打开/关闭音频上行。如果采集设备已经打开,那么会发送采集到的音频数据。如果采集设备没有打开,那么仍旧无声。采集设备的打开关闭请参见接口 EnableAudioCaptureDevice。

接口原型

ITMGContext virtual int EnableAudioSend(bool bEnable)
参数
类型
含义
bEnable
bool
如果需要打开音频上行,则传入的参数为 true,如果关闭音频上行,则参数为 false

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioSend(true);

音频上行状态获取

此接口用于音频上行状态获取。

接口原型

ITMGContext virtual bool IsAudioSendEnabled()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioSendEnabled();

获取麦克风实时音量

此接口用于获取麦克风实时音量,返回值为 int 类型。建议20ms获取一次。值域为0 - 100,通过此接口可以获取到麦克风采集到的实时音量情况。

接口原型

ITMGAudioCtrl virtual int GetMicLevel()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetMicLevel();

获取音频上行实时音量

此接口用于获取自己音频上行实时音量,返回值为 int 类型,取值范围为0 - 100。

接口原型

ITMGAudioCtrl virtual int GetSendStreamLevel()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetSendStreamLevel();

设置麦克风软件音量

此接口用于设置麦克风的音量。参数 volume 用于设置麦克风的音量,相当于对采集的声音做衰减或增益。

接口原型

ITMGAudioCtrl virtual int SetMicVolume(int vol)
参数
类型
含义
vol
int
取值范围为 0-200,数值为0的时候表示静音,当数值为100的时候表示音量不增不减,默认数值为100。

示例代码

int micVol = (int)(value * 100);
ITMGContextGetInstance()->GetAudioCtrl()->SetMicVolume(vol);

获取麦克风软件音量

此接口用于获取麦克风的音量。返回值为一个int类型数值,返回值为101代表没调用过接口 SetMicVolume。

接口原型

ITMGAudioCtrl virtual int GetMicVolume()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetMicVolume();

实时语音播放相关接口

接口
接口含义
EnableSpeaker
开关扬声器
GetSpeakerState
获取扬声器状态
EnableAudioPlayDevice
开关播放设备
IsAudioPlayDeviceEnabled
获取播放设备状态
EnableAudioRecv
打开关闭音频下行
IsAudioRecvEnabled
获取音频下行状态
GetSpeakerLevel
获取实时扬声器音量
GetRecvStreamLevel
获取房间内其他成员下行实时音量
SetSpeakerVolume
设置扬声器音量
GetSpeakerVolume
获取扬声器音量


开启或关闭扬声器

此接口用于开启关闭扬声器。EnableSpeaker = EnableAudioPlayDevice + EnableAudioRecv

接口原型

ITMGAudioCtrl virtual int EnableSpeaker(bool enable)
参数
类型
含义
enable
bool
如果需要关闭扬声器,则传入的参数为 false,如果打开扬声器,则参数为 true

示例代码

//打开扬声器
ITMGContextGetInstance()->GetAudioCtrl()->EnableSpeaker(true);

扬声器状态获取

此接口用于扬声器状态获取。返回值0为关闭扬声器状态,返回值1为打开扬声器状态。

接口原型

ITMGAudioCtrl virtual int GetSpeakerState()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerState();

开启或关闭播放设备

此接口用于开启关闭播放设备。

接口原型

ITMGAudioCtrl virtual int EnableAudioPlayDevice(bool enable)
参数
类型
含义
enable
bool
如果需要关闭播放设备,则传入的参数为 false,如果打开播放设备,则参数为 true

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioPlayDevice(true);

播放设备状态获取

此接口用于播放设备状态获取。

接口原型

ITMGAudioCtrl virtual bool IsAudioPlayDeviceEnabled()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioPlayDeviceEnabled();

打开或关闭音频下行

此接口用于打开/关闭音频下行。如果播放设备已经打开,那么会播放房间里其他人的音频数据。如果播放设备没有打开,那么仍旧无声。播放设备的打开关闭参见接口请参见 EnableAudioPlayDevice。

接口原型

ITMGAudioCtrl virtual int EnableAudioRecv(bool enable)
参数
类型
含义
enable
bool
如果需要打开音频下行,则传入的参数为 true,如果关闭音频下行,则参数为 false

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioRecv(true);

音频下行状态获取

此接口用于音频下行状态获取。

接口原型

ITMGAudioCtrl virtual bool IsAudioRecvEnabled()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioRecvEnabled();

获取扬声器实时音量

此接口用于获取扬声器实时音量。返回值为 int 类型数值,表示扬声器实时音量。建议20ms获取一次。

接口原型

ITMGAudioCtrl virtual int GetSpeakerLevel()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerLevel();

获取房间内其他成员下行实时音量

此接口用于获取房间内其他成员下行实时音量,返回值为 int 类型,取值范围为0 - 200。

接口原型

ITMGAudioCtrl virtual int GetRecvStreamLevel(const char* openId)
参数
类型
含义
openId
char*
房间其他成员的openId

示例代码

iter->second.level = ITMGContextGetInstance()->GetAudioCtrl()->GetRecvStreamLevel(iter->second.openid.c_str());

动态设置房间内某成员音量

此接口用于设置房间内某成员的说话音量大小,此设置只在本端生效。

接口原型

ITMGAudioCtrl virtual int SetSpeakerVolumeByOpenID(const char* openId, int vol) = 0;
参数
类型
含义
openId
const char*
需要调节音量大小的OpenID
vol
int
百分比,建议[0-200],其中100为默认值

获取设置的声音百分比

调用此接口获取 SetSpeakerVolumeByOpenID 设置的能量值

接口原型

ITMGAudioCtrl virtual int GetSpeakerVolumeByOpenID(const char* openId) = 0;
参数
类型
含义
openId
const char*
需要调节音量大小的OpenID

返回值

接口返回 OpenID 设置的能量百分比, 默认返回100。

设置扬声器的音量

此接口用于设置扬声器的音量。

接口原型

ITMGAudioCtrl virtual int SetSpeakerVolume(int vol)
参数
类型
含义
vol
int
设置音量,范围0 - 200,当数值为0时,表示静音,当数值为100时,表示音量不增不减,默认数值为100。

示例代码

int vol = 100;
ITMGContextGetInstance()->GetAudioCtrl()->SetSpeakerVolume(vol);

获取扬声器的音量

此接口用于获取扬声器的音量。返回值为 int 类型数值,代表扬声器的音量,返回值为101代表没调用过接口 SetSpeakerVolume。 Level 是实时音量,Volume 是扬声器的音量,最终声音音量 = Level × Volume %。例如实时音量是数值是100,此时 Volume 的数值是60,那么最终发出来的声音数值也是60。

接口原型

ITMGAudioCtrl virtual int GetSpeakerVolume()

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerVolume();

高级 API

启动耳返

此接口用于启动耳返,需要 EnableLoopBack + EnableSpeaker 才可以听到自己声音。

接口原型

ITMGAudioCtrl virtual int EnableLoopBack(bool enable)
参数
类型
含义
enable
bool
设置是否启动

示例代码

ITMGContextGetInstance()->GetAudioCtrl()->EnableLoopBack(true);

获取用户房间音频类型

此接口用于获取用户房间音频类型,返回值为房间音频类型,返回值为0时代表获取用户房间音频类型发生错误,房间音频类型参考 EnterRoom 接口。

接口原型

class ITMGRoom {
public:
virtual ~ITMGRoom() {} ;
virtual int GetRoomType() = 0;

};


示例代码

ITMGContext* context = ITMGContextGetInstance();
ITMGContextGetInstance()->GetRoom()->GetRoomType();

获取房间号

此接口用于获取实时语音房间号,只能在进房成功之后使用。

接口原型

ITMGRoom virtual int GetRoomID(char* pBuffer, int nLength) = 0;
参数
类型
含义
pBuffer
char*
用于接收返回的 roomid
nLength
int
pBuffer 长度,在 128 - 256 之间

修改用户房间音频类型

此接口用于修改用户房间音频类型,结果参见回调事件,事件类型为 ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE。房间的音频类型由第一个进房的人确定,此后房间里有成员修改房间类型,将对此房间所有成员生效。

接口原型

IITMGContext TMGRoom public int ChangeRoomType((ITMG_ROOM_TYPE roomType)
参数
类型
含义
roomType
ITMG_ROOM_TYPE
房间切换成的目标类型,房间音频类型参考 EnterRoom 接口

示例代码

ITMGContext* context = ITMGContextGetInstance();
ITMGContextGetInstance()->GetRoom()->ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);

Data 详情

消息
Data
例子
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE
result; error_info; new_room_type
{"error_info":"","new_room_type":0,"result":0}

房间类型修改回调

房间类型设置完成后,回调的事件消息为 ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE,返回的参数为 result、error_info 及 new_room_type,new_room_type 代表的信息如下,在 OnEvent 函数中对事件消息进行判断。
事件子类型
代表参数
含义
ITMG_ROOM_CHANGE_EVENT_ENTERROOM
1
表示在进房的过程中,自带的音频类型与房间不符合,被修改为所进入房间的音频类型。
ITMG_ROOM_CHANGE_EVENT_START
2
表示已经在房间内,音频类型开始切换(例如调用 ChangeRoomType 接口后切换音频类型)。
ITMG_ROOM_CHANGE_EVENT_COMPLETE
3
表示已经在房间,音频类型切换完成。
ITMG_ROOM_CHANGE_EVENT_REQUEST
4
表示房间成员调用 ChangeRoomType 接口,请求切换房间音频类型。

示例代码

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data) {
if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE == type)
{
//对房间类型事件进行处理
}
}

房间通话质量监控事件

质量监控事件,在进房后触发,2秒回调一次,事件消息为 ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY,返回的参数为 weight、loss 及 delay,代表的信息如下:
参数
类型
含义
weight
int
范围是1 - 50,数值为50是音质评分极好,数值为1是音质评分很差,几乎不能使用,数值为0代表初始值,无含义。一般数值在30以下就可以提醒用户网络较差,建议切换网络。
loss
double
上行丢包率。
delay
int
音频触达延迟时间(ms)。

获取版本号

获取 SDK 版本号,用于分析。

接口原型

ITMGContext virtual const char* GetSDKVersion()

示例代码

ITMGContextGetInstance()->GetSDKVersion();

检查麦克风设备状态

函数原型

ITMGContext virtual ITMG_CHECK_MIC_STATUS CheckMic() = 0;

返回值处理

返回值
含义
处理
ITMG_CHECK_MIC_STATUS_AVAILABLE = 0
正常可用
无需处理
ITMG_CHECK_MIC_STATUS_NO_GRANTED = 2
未获得/拒绝授权权限
需要在打开麦克风之前获取下权限
ITMG_CHECK_MIC_STATUS_INVALID_MIC = 3
没有可用的设备
一般是 PC 设备上,没有可用的麦克风设备会报此错误,请提示插入耳机或麦克风
ITMG_CHECK_MIC_STATUS_NOT_INIT = 5
没有初始化
在Init之后调用 EnableMic 接口

设置打印日志等级

用于设置打印日志等级。建议保持默认等级。需要在 Init 之前调用。

接口原型

ITMGContext int SetLogLevel(ITMG_LOG_LEVEL levelWrite, ITMG_LOG_LEVEL levelPrint)

参数含义

参数
类型
含义
levelWrite
ITMG_LOG_LEVEL
设置写入日志的等级,TMG_LOG_LEVEL_NONE 表示不写入,默认为 TMG_LOG_LEVEL_INFO
levelPrint
ITMG_LOG_LEVEL
设置打印日志的等级,TMG_LOG_LEVEL_NONE 表示不打印,默认为 TMG_LOG_LEVEL_ERROR
ITMG_LOG_LEVEL 说明如下:
ITMG_LOG_LEVEL
含义
TMG_LOG_LEVEL_NONE
不打印日志
TMG_LOG_LEVEL_ERROR
打印错误日志(默认)
TMG_LOG_LEVEL_INFO
打印提示日志
TMG_LOG_LEVEL_DEBUG
打印开发调试日志
TMG_LOG_LEVEL_VERBOSE
打印高频日志

示例代码

ITMGContextGetInstance()->SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);

设置打印日志路径

用于设置打印日志路径。默认路径如下。需要在 Init 之前调用。
平台
路径
Windows
%appdata%\\Tencent\\GME\\ProcessName
iOS
Application/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Documents
Android
/sdcard/Android/data/xxx.xxx.xxx/files
Mac
/Users/username/Library/Containers/xxx.xxx.xxx/Data/Documents

接口原型

ITMGContext virtual int SetLogPath(const char* logDir)
参数
类型
含义
logDir
const char*
路径

示例代码

cosnt char* logDir = ""//自行设置路径

ITMGContext* context = ITMGContextGetInstance();
context->SetLogPath(logDir);

获取打印日志路径

通过接口获取日志路径,返回值为 const char* 类型字符串。

接口原型

ITMGContext virtual const char* GetLogPath() = 0;

获取诊断信息

获取音视频通话的实时通话质量的相关信息。该接口主要用来查看实时通话质量、排查问题等,业务侧可以忽略。

接口原型

ITMGRoom virtual const char* GetQualityTips()

示例代码

ITMGContextGetInstance()->GetRoom()->GetQualityTips();

回调消息

消息
含义
Data
例子
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM
进入音频房间消息
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
退出音频房间消息
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT
房间因为网络等原因断开消息
result; error_info
{"error_info":"waiting timeout, please check your network","result":0}
ITMG_MAIN_EVNET_TYPE_USER_UPDATE
房间成员更新消息
user_list; event_id
{"event_id":1,"user_list":["0"]}
ITMG_MAIN_EVENT_TYPE_RECONNECT_START
房间重连开始消息
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS
房间重连成功消息
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM
快速切换房间消息
result; error_info
{"error_info":"","result":0}
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE
房间状态切换消息
result; error_info; sub_event_type; new_room_type
{"error_info":"","new_room_type":0,"result":0}
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_START
开始跨房连麦消息
result;
{"result":0}
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_STOP
跨房连麦停止消息
result;
{"result":0}
ITMG_MAIN_EVENT_TYPE_SPEAKER_DEFAULT_DEVICE_CHANGED
默认扬声器设备修改消息
result; error_info
{"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"扬声器 (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0}
ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE
新增扬声器设备消息
result; error_info
{"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"扬声器 (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0}
ITMG_MAIN_EVENT_TYPE_SPEAKER_LOST_DEVICE
丢失扬声器设备消息
result; error_info
{"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"扬声器 (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":false,"result":0}
ITMG_MAIN_EVENT_TYPE_MIC_NEW_DEVICE
新增麦克风设备消息
result; error_info
{"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"麦克风 (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":true,"result":0}
ITMG_MAIN_EVENT_TYPE_MIC_LOST_DEVICE
丢失麦克风设备消息
result; error_info
{"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"麦克风 (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0}
ITMG_MAIN_EVENT_TYPE_MIC_DEFAULT_DEVICE_CHANGED
默认麦克风设备修改消息
result; error_info
{"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"麦克风 (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0}
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY
房间质量消息
weight; loss; delay
{"weight":5,"loss":0.1,"delay":1}
ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE
语音消息录制完成消息
result; file_path
{"file_path":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE
语音消息上传完成消息
result; file_path;file_id
{"file_id":"","file_path":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE
语音消息下载完成消息
result; file_path;file_id
{"file_id":"","file_path":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE
语音消息播放完成消息
result; file_path
{"file_path":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE
语音消息极速转文本完成消息
result; text;file_id
{"file_id":"","text":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE
语音消息流式转文本完成消息
result; file_path; text;file_id
{"file_id":"","file_path":","text":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING
语音消息正在流式转文本中
result; file_path; text;file_id
{"file_id":"","file_path":","text":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_TEXT2SPEECH_COMPLETE
文本转语音完成消息
result; text;file_id
{"file_id":"","text":"","result":0}
ITMG_MAIN_EVNET_TYPE_PTT_TRANSLATE_TEXT_COMPLETE
文本翻译完成消息
result; text;file_id
{"file_id":"","text":"","result":0}

目录