tencent cloud

文档反馈

接口文档

最后更新时间:2022-06-15 16:01:34

    为方便 Windows 开发者调试和接入腾讯云游戏多媒体引擎产品 API,这里向您介绍适用于 Windows 开发的接入技术文档。

    说明

    此文档对应 GME sdk version:v2.8。

    使用 GME 重要事项

    GME 分为两个部分,提供实时语音服务、语音消息及转文本服务。

    image

    重要接口

    重要接口 接口含义
    Init 初始化 GME
    Poll 触发事件回调
    EnterRoom 进房(实时语音)
    EnableMic 开麦克风(实时语音)
    EnableSpeaker 开扬声器(实时语音)
    StartRecordingWithStreamingRecognition 流式录制及转文字(语音消息及转文字)

    重点提示

    • GME 使用前请对工程进行配置,否则 SDK 不生效。
    • GME 的接口调用成功后返回值为 AV_OK,数值为 0。
    • GME 的接口调用要在同一个线程下。
    • GME 需要周期性的调用 Poll 接口触发事件回调。
    • 错误码详情可参考 错误码

    C++类

    含义
    ITMGContext 核心接口
    ITMGRoom 房间相关接口
    ITMGRoomManager 房间管理接口
    ITMGAudioCtrl 音频相关接口
    ITMGAudioEffectCtrl 音效及伴奏相关接口
    ITMGPTT 语音消息及转文字相关接口

    核心接口

    未初始化前,SDK 处于未初始化阶段,需要通过接口 Init 初始化 SDK,才可以使用实时语音服务、语音消息及转文字服务。如果切换账号,请调用 UnInit 反初始化 SDK。

    使用问题可参考 一般性问题

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

    引入头文件

    #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

    • 此接口用于初始化 GME 服务,建议应用侧在应用初始化时候调用。
    • OpenId 用于唯一标识一个用户,数值需大于 10000(目前只支持 INT64),规则由 App 开发者自行制定,App 内不重复即可
    注意

    初始化 SDK 之后才可以进入实时语音房间。

    函数原型

    ITMGContext virtual int Init(const char* sdkAppId, const char* openId)
    
    参数 类型 含义
    sdkAppId char* 来自 腾讯云控制台 的 GME 服务提供的 AppId。
    openId char* OpenId 只支持 Int64 类型(转为 string 传入),数值必须大于10000,否则初始化不成功,导致进房失败
    返回值 处理
    AV_OK = 0 初始化 SDK 成功
    AV_ERR_SDK_NOT_FULL_UPDATE=7015 检查 SDK 文件是否完整,建议删除后重新导入 SDK

    出现返回值 AV_ERR_SDK_NOT_FULL_UPDATE 时,此返回值只有提示作用,并不会造成初始化失败。

    • 如果在接入过程中提示此错误,请根据提示检查 SDK 文件是否完整、SDK 文件版本是否一致。
    • 如果是在导出可执行文件之后出现此返回值,请忽略此错误,并尽量不在 UI 中提示。

    示例代码

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

    触发事件回调

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

    函数原型

    class ITMGContext {
    protected:
      virtual ~ITMGContext() {}
      
    public:        
    virtual void Poll()= 0;
    }
    

    示例代码

    //头文件中的声明
    //代码实现
    void TMGTestScene::update(float delta)
    {
      ITMGContextGetInstance()->Poll();
    }
    

    系统暂停

    当系统发生 Pause 事件时,需要同时通知引擎进行 Pause。

    函数原型

    ITMGContext int Pause()
    

    系统恢复

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

    函数原型

    ITMGContext int Resume()
    

    反初始化 SDK

    反初始化 SDK,进入未初始化状态。切换账号需要反初始化

    函数原型

    ITMGContext int Uninit()
    

    实时语音

    实时语音,即一对一或一对多的实时语音通话功能。

    实时语音流程图

    实时语音房间调用流程图

    实时语音房间相关接口

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

    接口 接口含义
    GenAuthBuffer 初始化鉴权
    EnterRoom 加入房间
    IsRoomEntered 是否已经进入房间
    ExitRoom 退出房间
    ChangeRoomType 修改用户房间音频类型
    GetRoomType 获取用户房间音频类型

    鉴权信息

    生成 AuthBuffer,用于相关功能的加密和鉴权,如正式发布请使用后台部署密钥,后台部署请参考 鉴权密钥
    使用语音消息及转文字服务获取鉴权时,房间号参数必须填 null。

    函数原型

    int  QAVSDK_AuthBuffer_GenAuthBuffer(unsigned int dwSdkAppID, const char* strRoomID, const char* strOpenID,
    const char* strKey, unsigned char* strAuthBuffer, unsigned int bufferLength);
    
    参数 类型 含义
    dwSdkAppID int  来自腾讯云控制台的 AppId 号码。
    strRoomID char*  房间号,最大支持127字符(使用语音消息及转文字服务,房间号参数必须填 null)。
    strOpenID char*    用户标识。与 Init 时候的 openID 相同。
    strKey char*    来自腾讯云 控制台 的权限密钥。
    strAuthBuffer 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);
    

    加入房间

    用生成的鉴权信息进房,会收到消息为 ITMG_MAIN_EVENT_TYPE_ENTER_ROOM 的回调。加入房间默认不打开麦克风及扬声器。返回值为 AV_OK 的时候代表成功。

    函数原型

    ITMGContext virtual int EnterRoom(const char*  roomID, ITMG_ROOM_TYPE roomType, const char* authBuffer , int buffLen)
    
    参数 类型 含义
    roomID char*   房间号,最大支持127字符
    roomType ITMG_ROOM_TYPE 房间音频类型
    authBuffer char*    鉴权码
    buffLen int   鉴权码长度

    房间音频类型请参考 音质选择

    示例代码

    ITMGContext* context = ITMGContextGetInstance();
    context->EnterRoom(roomID, ITMG_ROOM_TYPE_STANDARD, (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}

    错误码

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

    判断是否已经进入房间

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

    函数原型

    ITMGContext virtual bool IsRoomEntered()
    

    示例代码

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

    退出房间

    通过调用此接口可以退出所在房间。这是一个异步接口,返回值为 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}

    修改用户房间音频类型

    此接口用于修改用户房间音频类型,结果参见回调事件,事件类型为 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);
    

    获取用户房间音频类型

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

    函数原型

    IITMGContext TMGRoom public  int GetRoomType()
    

    示例代码

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

    房间类型完成回调

    房间类型设置完成后,回调的事件消息为 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)
                    {
            //对房间类型事件进行处理
         }
    }
    

    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_EVNET_TYPE_USER_UPDATE,其中 data 包含两个信息,event_id 及 user_list,在 OnEvent 函数中对事件消息进行判断。
    音频事件的通知有一个阈值,超过这个阈值才会发送通知。超过两秒没有收到音频包才通知“有成员停止发送音频包”消息。

    event_id 含义 应用侧维护内容
    ITMG_EVENT_ID_USER_ENTER 有成员进入房间 应用侧维护成员列表
    ITMG_EVENT_ID_USER_EXIT 有成员退出房间 应用侧维护成员列表
    ITMG_EVENT_ID_USER_HAS_AUDIO 有成员发送音频包,通过此事件可以判断用户是否说话,并展示声纹效果 应用侧维护通话成员列表
    ITMG_EVENT_ID_USER_NO_AUDIO 有成员停止发送音频包 应用侧维护通话成员列表

    维护房间成员流程图

    示例代码

    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;
        }
    }
    }
    

    Data 详情

    消息 Data 例子
    ITMG_MAIN_EVNET_TYPE_USER_UPDATE event_id; user_list {"event_id":0,"user_list":""}

    房间通话质量监控事件

    质量监控事件,在进房后触发,2秒回调一次,事件消息为 ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY,返回的参数为 weight、loss 及 delay,代表的信息如下。

    参数 类型 含义
    weight int 范围是1 - 50,数值为50是音质评分极好,数值为1是音质评分很差,几乎不能使用,数值为0代表初始值,无含义。一般数值在 30 以下就可以提醒用户网络较差,建议切换网络。
    loss double 上行丢包率。
    delay int 音频触达延迟时间(ms)。

    实时语音音频接口

    Image

    实时语音音频接入须知

    初始化 SDK 之后进房,在房间中,才可以调用实时音频语音相关接口。
    当用户界面单击打开/关闭麦克风/扬声器按钮时,建议如下方式:

    • 对于大部分的游戏类 App,推荐调用 EnableMic 及 EnableSpeaker 接口,相当于同时调用 EnableAudioCaptureDevice/EnableAudioSend 和 EnableAudioPlayDevice/EnableAudioRecv 接口。
    • 其他类型的移动端 App 例如社交类型 App,打开或者关闭采集设备,会伴随整个设备(采集及播放)重启,如果此时 App 正在播放背景音乐,那么背景音乐的播放也会被中断。利用控制上下行的方式来实现开关麦克风效果,不会中断播放设备。具体调用方式为:在进房的时候调用 EnableAudioCaptureDevice(true) && EnableAudioPlayDevice(true) 一次,单击开关麦克风时只调用 EnableAudioSend/Recv 来控制音频流是否发送/接收
    • 如果想单独释放采集或者播放设备,请参考接口 EnableAudioCaptureDevice 及 EnableAudioPlayDevice。
    • 调用 pause 暂停音频引擎,调用 resume 恢复音频引擎。

    实时语音音频相关接口

    接口 接口含义
    GetMicListCount 获取麦克风设备数量
    GetMicList 枚举麦克风设备
    GetSpeakerListCount 获取扬声器设备数量
    GetSpeakerList 枚举扬声器设备
    SelectMic 选定麦克风设备
    SelectSpeaker 选定扬声器设备
    EnableMic 开关麦克风
    GetMicState 获取麦克风状态
    EnableAudioCaptureDevice 开关采集设备
    IsAudioCaptureDeviceEnabled 获取采集设备状态
    EnableAudioSend 打开关闭音频上行
    IsAudioSendEnabled 获取音频上行状态
    GetMicLevel 获取实时麦克风音量
    GetSendStreamLevel 获取音频上行实时音量
    SetMicVolume 设置麦克风音量
    GetMicVolume 获取麦克风音量
    EnableSpeaker 开关扬声器
    GetSpeakerState 获取扬声器状态
    EnableAudioPlayDevice 开关播放设备
    IsAudioPlayDeviceEnabled 获取播放设备状态
    EnableAudioRecv 打开关闭音频下行
    IsAudioRecvEnabled 获取音频下行状态
    GetSpeakerLevel 获取实时扬声器音量
    GetRecvStreamLevel 获取房间内其他成员下行实时音量
    SetSpeakerVolume 设置扬声器音量
    GetSpeakerVolume 获取扬声器音量
    EnableLoopBack 开关耳返

    实时语音采集相关接口

    获取麦克风设备数量

    此接口用来获取麦克风设备数量。

    函数原型

    ITMGAudioCtrl virtual int GetMicListCount()
    

    示例代码

    ITMGContextGetInstance()->GetAudioCtrl()->GetMicListCount();
    

    枚举麦克风设备

    此接口用来枚举麦克风设备。配合 GetMicListCount 接口使用。

    函数原型

    ITMGAudioCtrl virtual int GetMicList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)
    class TMGAudioDeviceInfo
    {
        public:
            const char* pDeviceID;
            const char* pDeviceName;
    };
    
    参数 类型 含义
    ppDeviceInfoList TMGAudioDeviceInfo   设备列表
    nCount int   获取的麦克风设备数量

    示例代码

    ITMGContextGetInstance()->GetAudioCtrl()->GetMicList(ppDeviceInfoList,nCount);
    

    选中麦克风设备

    此接口用来选中麦克风设备。如果不调用或者传入 "DEVICEID_DEFAULT",则选中系统默认设备。设备 ID 来自于 GetMicList 返回列表。

    函数原型

    ITMGAudioCtrl virtual int SelectMic(const char* pMicID)
    
    参数 类型 含义
    pMicID char* 麦克风设备 ID

    示例代码

    const char* pMicID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";
    ITMGContextGetInstance()->GetAudioCtrl()->SelectMic(pMicID);
    

    开启或关闭麦克风

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

    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();
    

    开启或关闭采集设备

    此接口用来开启/关闭采集设备。加入房间默认不打开设备。

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

    函数原型

    ITMGContext 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 enable)
    
    参数 类型 含义
    enable 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 用于设置麦克风的音量,相当于对采集的声音做衰减或增益,当数值为 0 的时候表示静音,当数值为 100 的时候表示音量不增不减,默认数值为 100。

    说明

    此接口不适用于语音消息服务。

    函数原型

    ITMGAudioCtrl virtual int SetMicVolume(int vol)
    
    参数 类型 含义
    vol int    设置音量,范围 0 到 200

    示例代码

    ITMGContextGetInstance()->GetAudioCtrl()->SetMicVolume(vol);
    

    获取麦克风软件音量

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

    说明

    此接口不适用于语音消息服务。

    函数原型

    ITMGAudioCtrl virtual int GetMicVolume()
    

    示例代码

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

    实时语音播放相关接口

    获取扬声器设备数量

    此接口用来获取扬声器设备数量。

    函数原型

    ITMGAudioCtrl virtual int GetSpeakerListCount()
    

    示例代码

    ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerListCount();
    

    枚举扬声器设备

    此接口用来枚举扬声器设备。配合 GetSpeakerListCount 接口使用。

    函数原型

    ITMGAudioCtrl virtual int GetSpeakerList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)
    class TMGAudioDeviceInfo
    {
        public:
            const char* pDeviceID;
            const char* pDeviceName;
    };
    
    参数 类型 含义
    ppDeviceInfoList TMGAudioDeviceInfo   设备列表
    nCount int   获取的扬声器设备数量

    示例代码

    ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerList(ppDeviceInfoList,nCount);
    

    选中扬声器设备

    此接口用来选中播放设备。如果不调用或者传入"DEVICEID_DEFAULT",则选中系统默认播放设备。设备 ID 来自于 GetSpeakerList 返回列表。

    函数原型

    ITMGAudioCtrl virtual int SelectSpeaker(const char* pSpeakerID)
    
    参数 类型 含义
    pSpeakerID char* 扬声器设备 ID

    示例代码

    const char* pSpeakerID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";
    ITMGContextGetInstance()->GetAudioCtrl()->SelectSpeaker(pSpeakerID);
    

    开启或关闭扬声器

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

    函数原型

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

    示例代码

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

    扬声器状态获取

    此接口用于扬声器状态获取。返回值 0 为关闭扬声器状态,返回值1 为打开扬声器状态,返回值2 为扬声器设备正在操作中。

    函数原型

    ITMGAudioCtrl virtual int GetSpeakerState()
    

    示例代码

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

    开启或关闭播放设备

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

    函数原型

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

    示例代码

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

    播放设备状态获取

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

    函数原型

    ITMGContext virtual bool IsAudioPlayDeviceEnabled()
    

    示例代码

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

    打开或关闭音频下行

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

    函数原型

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

    示例代码

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

    音频下行状态获取

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

    函数原型

    ITMGContext 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());
    

    设置扬声器的音量

    此接口用于设置扬声器的音量。
    参数 volume 用于设置扬声器的音量,当数值为0时,表示静音,当数值为100时,表示音量不增不减,默认数值为 100。

    函数原型

    ITMGAudioCtrl virtual int SetSpeakerVolume(int vol)
    
    参数 类型 含义
    vol int      设置音量,范围 0 到 200

    示例代码

    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();
    

    启动耳返

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

    函数原型

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

    示例代码

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

    语音消息及转文字

    语音消息,录制并发送一段语音消息,同时可以将语音消息转成文字,也可以同时将文字进行翻译。

    说明

    建议使用流式语音转文字服务。

    语音消息及语音转文字流程图

    接入语音消息及转文本服务

    语音消息及转文字相关接口

    接口 接口含义
    ApplyPTTAuthbuffer 鉴权初始化
    SetMaxMessageLength 限制最大语音信息时长
    StartRecording 启动录音
    StartRecordingWithStreamingRecognition 启动流式录音
    PauseRecording 暂停录音
    ResumeRecording 恢复录音
    StopRecording 停止录音
    CancelRecording 取消录音
    GetMicLevel 获取实时麦克风音量
    SetMicVolume 设置录制音量
    GetMicVolume 获取录制音量
    GetSpeakerLevel 获取实时扬声器音量
    SetSpeakerVolume 设置播放音量
    GetSpeakerVolume 获取播放音量
    UploadRecordedFile 上传语音文件
    DownloadRecordedFile 下载语音文件
    PlayRecordedFile 播放语音
    StopPlayFile 停止播放语音
    GetFileSize 语音文件的大小
    GetVoiceFileDuration 语音文件的时长
    SpeechToText 语音识别成文字

    初始化SDK

    未初始化前,SDK 处于未初始化阶段,需要通过接口 Init 初始化 SDK,才可以使用实时语音及语音消息服务。

    使用问题可参考 离线语音相关问题

    初始化相关接口

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

    鉴权初始化

    在初始化 SDK 之后调用鉴权初始化,authBuffer 的获取参见上文实时语音鉴权信息接口 QAVSDK_AuthBuffer_GenAuthBuffer。

    函数原型

    ITMGPTT virtual int ApplyPTTAuthbuffer(const char* authBuffer, int authBufferLen)
    
    参数 类型 含义
    authBuffer char*       鉴权
    authBufferLen int       鉴权长度

    示例代码

    ITMGContextGetInstance()->GetPTT()->ApplyPTTAuthbuffer(authBuffer,authBufferLen);
    

    流式语音识别

    启动流式语音识别

    此接口用于启动流式语音识别,同时在回调中会有实时的语音转文字返回,可以指定语言进行识别,也可以将语音中识别到的信息翻译成指定的语言返回。停止录音调用 StopRecording

    函数原型

    ITMGPTT virtual int StartRecordingWithStreamingRecognition(const char* filePath) 
    ITMGPTT virtual int StartRecordingWithStreamingRecognition(const char* filePath,const char* speechLanguage,const char* translateLanguage) 
    
    参数 类型 含义
    filePath char* 存放的语音路径
    speechLanguage char* 识别成指定文字的语言参数,语音转文字的参数请参见 语言参数参考列表
    translateLanguage char* 翻译成指定文字的语言参数,语音转文字的参数请参见 语言参数参考列表(此参数暂不可用,请填写与 speechLanguage 相同的参数)

    示例代码

    ITMGContextGetInstance()->GetPTT()->StartRecordingWithStreamingRecognition(filePath,"cmn-Hans-CN","cmn-Hans-CN");
    

    流式语音识别的回调

    启动流式语音识别后,需要在回调函数 OnEvent 中监听回调消息,事件消息分为以下两个:

    • ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE 是在停止录制并完成识别后才返回文字,相当于一段话说完才会返回识别的文字。
    • ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING 是在录音过程中就会实时返回识别到的文字,相当于边说话边返回识别到的文字。
      根据需求在 OnEvent 函数中对相应事件消息进行判断。传递的参数包含以下四个信息。
    消息名称 含义
    result 用于判断流式语音识别是否成功的返回码
    text 语音转文字识别的文本
    file_path 录音存放的本地地址
    file_id 录音在后台的 url 地址,录音在服务器存放90天
    注意

    监听 ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING 消息时,file_id 为空。

    错误码

    错误码 含义 处理方式
    32775 流式语音转文本失败,但是录音成功 调用 UploadRecordedFile 接口上传录音,再调用 SpeechToText 接口进行语音转文字操作
    32777 流式语音转文本失败,但是录音成功,上传成功 返回的信息中有上传成功的后台 url 地址,调用 SpeechToText 接口进行语音转文字操作
    32786 流式语音转文本失败 在流式录制状态当中,请等待流式录制接口执行结果返回

    示例代码

    void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
        switch (eventType) {
            case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE:
            {
                HandleSTREAM2TEXTComplete(data,true);
                break;
            }
            ...
            case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING:
            {
                HandleSTREAM2TEXTComplete(data, false);
                break;
            }
        }
    }
    void CTMGSDK_For_AudioDlg::HandleSTREAM2TEXTComplete(const char* data, bool isComplete)
    {
        std::string strText = "STREAM2TEXT: ret=";
        strText += data;
        m_EditMonitor.SetWindowText(MByteToWChar(strText).c_str());
        Json::Reader reader;
        Json::Value root;
        bool parseRet = reader.parse(data, root);
        if (!parseRet) {
            ::SetWindowText(m_EditInfo.GetSafeHwnd(),MByteToWChar(std::string("parse result Json error")).c_str());
        }
            else
            {
                if (isComplete) {
                                    ::SetWindowText(m_EditUpload.GetSafeHwnd(), MByteToWChar(root["file_id"].asString()).c_str());
                                }
                                else {
                                        std::string isruning = "STREAMINGRECOGNITION_IS_RUNNING";
                                        ::SetWindowText(m_EditUpload.GetSafeHwnd(), MByteToWChar(isruning).c_str());
                                     }
        }
    }
    

    语音消息录制

    限制最大语音信息时长

    限制最大语音消息的长度,最大支持58秒。

    函数原型

    ITMGPTT virtual int SetMaxMessageLength(int msTime)
    
    参数 类型 含义
    msTime int 语音时长,单位 ms,区间为 1000 < msTime < 58000

    示例代码

    int msTime = 10000;
    ITMGContextGetInstance()->GetPTT()->SetMaxMessageLength(msTime);
    

    启动录音

    此接口用于启动录音。需要将录音文件上传后才可以进行语音转文字等操作。

    函数原型

    ITMGPTT virtual int StartRecording(const char* fileDir)
    
    参数 类型 含义
    fileDir char*       存放的语音路径

    示例代码

    ITMGContextGetInstance()->GetPTT()->StartRecording(fileDir);
    

    启动录音的回调

    启动录音完成后的回调调用函数 OnEvent,事件消息为 ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE, 在 OnEvent 函数中对事件消息进行判断。
    传递的参数包含两个信息,一个是 result,另一个是 file_path。

    错误码

    错误码值 原因 建议方案
    4097 参数为空 检查代码中接口参数是否正确
    4098 初始化错误 检查设备是否被占用,或者权限是否正常,是否初始化正常
    4099 正在录制中 确保在正确的时机使用 SDK 录制功能
    4100 没有采集到音频数据 检查麦克风设备是否正常
    4101 录音时,录制文件访问错误 确保文件存在,文件路径的合法性
    4102 麦克风未授权错误 使用 SDK 需要麦克风权限,添加权限请参考对应引擎或平台的 SDK 工程配置文档
    4103 录音时间太短错误 首先,限制录音时长的单位为毫秒,检查参数是否正确;其次,录音时长要1000毫秒以上才能成功录制
    4104 没有启动录音操作 检查是否已经调用启动录音接口

    示例代码

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

    暂停录音

    此接口用于暂停录音。如需恢复录音请调用接口 ResumeRecording。

    函数原型

    ITMGPTT virtual int PauseRecording()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->PauseRecording();
    

    恢复录音

    此接口用于恢复录音。

    函数原型

    ITMGPTT virtual int ResumeRecording()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->ResumeRecording();
    

    停止录音

    此接口用于停止录音。此接口为异步接口,停止录音后会有录音完成回调,成功之后录音文件才可用。

    函数原型

    ITMGPTT virtual int StopRecording()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->StopRecording();
    

    取消录音

    调用此接口取消录音。取消之后没有回调。

    函数原型

    ITMGPTT virtual int CancelRecording()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->CancelRecording();
    

    获取语音消息麦克风实时音量

    此接口用于获取麦克风实时音量,返回值为 int 类型,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT.java 中。

    函数原型

    ITMGPTT virtual int GetMicLevel()
    

    示例代码

    ITMGContext.GetInstance(this).GetPTT().GetMicLevel();
    

    设置语音消息录制音量

    此接口用于设置离线语音录制音量,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT.java 中。

    函数原型

    ITMGPTT virtual int SetMicVolume(int vol)
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->SetMicVolume(100);
    

    获取语音消息录制音量

    此接口用于获取离线语音录制音量。返回值为 int 类型,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT 中。

    函数原型

    ITMGPTT virtual int GetMicVolume()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->GetMicVolume();
    

    获取语音消息扬声器实时音量

    此接口用于获取扬声器实时音量。返回值为 int 类型,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT 中。

    函数原型

    ITMGPTT virtual int GetSpeakerLevel()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->GetSpeakerLevel();
    

    设置语音消息播放音量

    此接口用于设置离线语音播放音量,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT 中。

    函数原型

    ITMGPTT virtual int SetSpeakerVolume(int vol)
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->SetSpeakerVolume(100);
    

    获取语音消息播放音量

    此接口用于获取离线语音播放音量。返回值为 int 类型,值域为0到200。

    说明

    此接口不同于实时语音接口,此接口在 ITMGPTT 中。

    函数原型

    ITMGPTT virtual int GetSpeakerVolume()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->GetSpeakerVolume();
    

    语音消息播放

    播放语音

    此接口用于播放语音。

    函数原型

    ITMGPTT virtual int PlayRecordedFile(const char* filePath)
    
    参数 类型 含义
    filePath char*       本地语音文件的路径

    错误码

    错误码值 原因 建议方案
    20485 播放未开始 确保文件存在,文件路径的合法性

    示例代码

    ITMGContextGetInstance()->GetPTT()->PlayRecordedFile(filePath);
    

    播放语音的回调

    播放语音的回调,事件消息为 ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE, 在 OnEvent 函数中对事件消息进行判断。
    传递的参数包含两个信息,一个是 result,另一个是 file_path。

    错误码

    错误码值 原因 建议方案
    20481 初始化错误 检查设备是否被占用,或者权限是否正常,是否初始化正常
    20482 正在播放中,试图打断并播放下一个失败了(正常是可以打断的) 检查代码逻辑是否正确
    20483 参数为空 检查代码中接口参数是否正确
    20484 内部错误 初始化播放器错误,解码失败等问题产生此错误码,需要结合日志定位问题

    示例代码

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

    停止播放语音

    此接口用于停止播放语音。停止播放语音也会有播放完成的回调。

    函数原型

    ITMGPTT virtual int StopPlayFile()
    

    示例代码

    ITMGContextGetInstance()->GetPTT()->StopPlayFile();
    

    获取语音文件的大小

    通过此接口,获取语音文件的大小。

    函数原型

    ITMGPTT virtual int GetFileSize(const char* filePath)
    
    参数 类型 含义
    filePath char*       语音文件的路径,此路径为本地路径

    示例代码

    ITMGContextGetInstance()->GetPTT()->GetFileSize(filePath);
    

    获取语音文件的时长

    此接口用于获取语音文件的时长,单位毫秒。

    函数原型

    ITMGPTT virtual int GetVoiceFileDuration(const char* filePath)
    
    参数 类型 含义
    filePath char*       语音文件的路径,此路径为本地路径

    示例代码

    ITMGContextGetInstance()->GetPTT()->GetVoiceFileDuration(filePath);
    

    语音消息上传及下载

    上传语音文件

    此接口用于上传语音文件。

    函数原型

    ITMGPTT virtual int UploadRecordedFile(const char* filePath)
    
    参数 类型 含义
    filePath char*       上传的语音路径,此路径为本地路径

    示例代码

    ITMGContextGetInstance()->GetPTT()->UploadRecordedFile(filePath);
    

    上传语音完成的回调

    上传语音完成后,事件消息为 ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE, 在 OnEvent 函数中对事件消息进行判断。
    传递的参数包含三个信息,result,file_path 和 file_id。

    错误码

    错误码值 原因 建议方案
    8193 上传文件时,文件访问错误 确保文件存在,文件路径的合法性
    8194 签名校验失败错误 检查鉴权密钥是否正确,检查是否有初始化离线语音
    8195 网络错误 检查设备网络是否可以正常访问外网环境
    8196 获取上传参数过程中网络失败 检查鉴权是否正确,检查设备网络是否可以正常访问外网环境
    8197 获取上传参数过程中回包数据为空 检查鉴权是否正确,检查设备网络是否可以正常访问外网环境
    8198 获取上传参数过程中回包解包失败 检查鉴权是否正确,检查设备网络是否可以正常访问外网环境
    8200 没有设置 appinfo 检查 apply 接口是否有调用,或者入参是否为空

    示例代码

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

    下载语音文件

    此接口用于下载语音文件。

    函数原型

    ITMGPTT virtual int DownloadRecordedFile(const char* fileId, const char* filePath) 
    
    参数 类型 含义
    fileId char* 文件的 url 路径
    filePath char* 文件的本地保存路径

    示例代码

    ITMGContextGetInstance()->GetPTT()->DownloadRecordedFile(fileID,filePath);
    

    下载语音文件完成回调

    下载语音完成后,事件消息为 ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE, 在 OnEvent 函数中对事件消息进行判断。
    传递的参数包含三个信息,result、file_path 和 file_id。

    错误码

    错误码值 原因 建议方案
    12289 下载文件时,文件访问错误 检查文件路径是否合法
    12290 签名校验失败 检查鉴权密钥是否正确,检查是否有初始化离线语音
    12291 网络存储系统异常 服务器获取语音文件失败,检查接口参数 fileid 是否正确,检查网络是否正常,检查 cos 文件存不存在
    12292 服务器文件系统错误 检查设备网络是否可以正常访问外网环境,检查服务器上是否有此文件
    12293 获取下载参数过程中,HTTP 网络失败 检查设备网络是否可以正常访问外网环境
    12294 获取下载参数过程中,回包数据为空 检查设备网络是否可以正常访问外网环境
    12295 获取下载参数过程中,回包解包失败 检查设备网络是否可以正常访问外网环境
    12297 没有设置 appinfo 检查鉴权密钥是否正确,检查是否有初始化离线语音

    示例代码

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

    语音转文字服务

    将指定的语音文件识别成文字

    此接口用于将指定的语音文件识别成文字。

    函数原型

    ITMGPTT virtual void SpeechToText(const char* fileID)
    
    参数 类型 含义
    fileID char*       语音文件 url

    示例代码

    ITMGContextGetInstance()->GetPTT()->SpeechToText(fileID);
    

    将指定的语音文件翻译成文字(指定语言)

    此接口可以指定语言进行识别,也可以将语音中识别到的信息翻译成指定的语言返回。

    函数原型

    ITMGPTT virtual int SpeechToText(const char* fileID,const char* speechLanguage,const char* translateLanguage)
    
    参数 类型 含义
    fileID char* 语音文件 url,录音在服务器存放 90 天
    speechLanguage char* 识别出指定文字的语言参数,语音转文字的参数参见 语言参数参考列表
    translatelanguage char* 翻译成指定文字的语言参数,语音转文字的参数参见 语言参数参考列表(此参数暂时无效,填入参数应与 speechLanguage 一致)

    示例代码

    ITMGContextGetInstance()->GetPTT()->SpeechToText(filePath,"cmn-Hans-CN","cmn-Hans-CN");
    

    识别回调

    将指定的语音文件识别成文字的回调,事件消息为 ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE, 在 OnEvent 函数中对事件消息进行判断。
    传递的参数包含三个信息,result、file_path 和 text,其中 text 为识别的文本。

    错误码

    错误码值 原因 建议方案
    32769 内部错误 分析日志,获取后台返回给客户端的真正错误码,并联系后台同事协助解决。
    32770 网络失败 检查设备网络是否可以正常访问外网环境
    32772 回包解包失败 分析日志,获取后台返回给客户端的真正错误码,并联系后台同事协助解决。
    32774 没有设置 appinfo 检查鉴权密钥是否正确,检查是否有初始化离线语音
    32776 authbuffer 校验失败 检查 authbuffer 是否正确
    32784 语音转文本参数错误 检查代码中接口参数 fileid 是否为空
    32785 语音转文本翻译返回错误 离线语音后台错误,请分析日志,获取后台返回给客户端的真正错误码,并联系后台同事协助解决

    示例代码

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

    高级 API

    获取诊断信息

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

    函数原型

    ITMGRoom virtual const char* GetQualityTips()
    
    

    示例代码

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

    获取版本号

    函数原型

    ITMGContext virtual const char* GetSDKVersion()
    
    

    示例代码

    ITMGContextGetInstance()->GetSDKVersion();
    

    设置打印日志等级

    用于设置打印日志等级。建议保持默认等级。

    函数原型

    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 含义
    TMG_LOG_LEVEL_NONE=0 不打印日志
    TMG_LOG_LEVEL_ERROR=1 打印错误日志(默认)
    TMG_LOG_LEVEL_INFO=2 打印提示日志
    TMG_LOG_LEVEL_DEBUG=3 打印开发调试日志
    TMG_LOG_LEVEL_VERBOSE=4 打印高频日志

    示例代码

    ITMGContext* context = ITMGContextGetInstance();
    context->SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);
    

    设置打印日志路径

    用于设置打印日志路径。
    默认路径为:%appdata%\Tencent\GME\ProcessName|

    函数原型

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

    示例代码

    cosnt char* logDir = ""//自行设置路径
    ITMGContext* context = ITMGContextGetInstance();
    context->SetLogPath(logDir);
    

    加入音频数据黑名单

    将某个 ID 加入音频数据黑名单,即不接受某人的语音, 只对本端生效。返回值为 0 表示调用成功。例如 :A,B,C 都在同一个房间开麦说话:

    • 如果 A 设置了 C 的黑名单, 则 A 只能听见 B 的声音。
    • B 因为没有设置黑名单, 仍旧可以听见 A 和 C 的声音。
    • C 同样因为没有设置黑名单, 可以听见 A 和 B 的声音。

    函数原型

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

    示例代码

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

    移除音频数据黑名单

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

    函数原型

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

    示例代码

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

    回调消息

    消息列表

    消息 消息代表的含义
    ITMG_MAIN_EVENT_TYPE_ENTER_ROOM 进入音频房间消息
    ITMG_MAIN_EVENT_TYPE_EXIT_ROOM 退出音频房间消息
    ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT 房间因为网络等原因断开消息
    ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE 房间类型变化事件
    ITMG_MAIN_EVENT_TYPE_MIC_NEW_DEVICE 新增麦克风设备消息
    ITMG_MAIN_EVENT_TYPE_MIC_LOST_DEVICE 丢失麦克风设备消息
    ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE 新增扬声器设备消息
    ITMG_MAIN_EVENT_TYPE_SPEAKER_LOST_DEVICE 丢失扬声器设备消息
    ITMG_MAIN_EVENT_TYPE_ACCOMPANY_FINISH 伴奏结束消息
    ITMG_MAIN_EVNET_TYPE_USER_UPDATE 房间成员更新消息
    ITMG_MAIN_EVENT_TYPE_NUMBER_OF_USERS_UPDATE 房间成员数量更新消息
    ITMG_MAIN_EVENT_TYPE_NUMBER_OF_AUDIOSTREAMS_UPDATE 房间音频流数量更新消息
    ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY 房间质量信息
    ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE PTT 录音完成
    ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE 上传 PTT 完成
    ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE 下载 PTT 完成
    ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE 播放 PTT 完成
    ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE 语音转文字完成

    Data 列表

    消息 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_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_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_EVNET_TYPE_USER_UPDATE user_list; event_id {"event_id":1,"user_list":["0"]}
    ITMG_MAIN_EVENT_TYPE_NUMBER_OF_USERS_UPDATE AllUser; AccUser; ProxyUser {"AllUser":3,"AccUser":2,"ProxyUser":1}
    ITMG_MAIN_EVENT_TYPE_NUMBER_OF_AUDIOSTREAMS_UPDATE AudioStreams {"AudioStreams":3}
    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}
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持