tencent cloud

文档反馈

语音消息及转文本

最后更新时间:2024-01-18 15:02:24
    为方便 Unity 开发者调试和接入腾讯云游戏多媒体引擎客户端 API,本文为您介绍适用于 Unity 语音消息服务及转文本服务的接入技术文档。

    使用 GME 重要事项

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

    重点提示

    已完成 GME 应用创建,并获取 SDK AppID 和 Key。请参见 服务开通指引
    已开通 GME 实时语音服务、语音消息服务以及转文本服务。请参见 服务开通指引
    GME 使用前请对工程进行配置,否则 SDK 不生效。
    GME 的接口调用成功后返回值为 QAVError.OK,数值为 0。
    GME 的接口调用要在同一个线程下。
    GME 需要周期性的调用 Poll 接口触发事件回调。
    错误码详情可参见 错误码
    注意:
    语音转文本相关接口有默认频率限制,限额范围内计费方式请参见 计费文档;若需提升接口频率限额或了解超额计费方式,请联系商务或 提交工单咨询
    语音消息非流式转文本接口 SpeechToText():默认单账号限制并发数为10路
    语音消息流式转文本接口 StartRecordingWithStreamingRecognition():默认单账号限制并发数为50路
    实时语音流式转文本接口 StartRealTimeASR():默认单账号限制并发数为50路

    接入 SDK

    重要步骤

    接入 SDK 重要流程如下:
    
    
    
    1. 初始化 GME
    5. 停止录制

    C# 类

    含义
    ITMGContext
    核心接口
    ITMGPTT
    语音消息及转文本相关接口

    核心接口

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

    引用头文件

    using GME;

    获取实例

    请使用 ITMGContext 的方法获取 Context 实例,不要直接使用 QAVContext.GetInstance() 去获取实例。

    初始化 SDK

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

    接口原型

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

    返回值

    返回值
    处理
    QAVError.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 中提示。

    示例代码

    int ret = ITMGContext.GetInstance().Init(sdkAppId, openID);
    //通过返回值判断是否初始化成功
    if (ret != QAVError.OK)
    {
    Debug.Log("SDK初始化失败:"+ret);
    return;
    }

    触发事件回调

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

    接口原型

    ITMGContext public abstract int Poll();

    示例代码

    public void Update()
    {
    ITMGContext.GetInstance().Poll();
    }

    系统暂停

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

    接口原型

    ITMGContext public abstract int Pause()

    系统恢复

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

    接口原型

    ITMGContext public abstract int Resume()

    反初始化 SDK

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

    接口原型

    ITMGContext public abstract int Uninit()

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

    说明:
    转文本服务分录音文件极速转文本以及语音消息流式转文本。
    使用语音消息服务不需要进入实时语音房间。
    语音消息最大录制时长默认为58秒,最短不能小于1秒。如果需要再加以限制,例如限制为最大录制时长为10秒,请在初始化之后调用 SetMaxMessageLength 接口进行设置。

    语音消息服务使用流程

    
    
    

    转文本服务使用流程

    
    
    
    接口
    接口含义
    GenAuthBuffer
    生成本地鉴权
    ApplyPTTAuthbuffer
    鉴权初始化
    SetMaxMessageLength
    限制最大语音信息时长

    生成本地鉴权

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

    接口原型

    QAVAuthBuffer GenAuthBuffer(int appId, string roomId, string openId, string key)
    参数
    类型
    含义
    appId
    int
    来自腾讯云控制台的 AppId 号码
    roomId
    string
    填 null 或者空字符串
    openId
    string
    用户标识。与 Init 时候的 OpenId 相同
    key
    string
    来自腾讯云 控制台 的权限密钥

    应用鉴权

    生成鉴权信息后,将鉴权赋值到 SDK 中。

    接口原型

    ITMGPTT int ApplyPTTAuthbuffer (byte[] authBuffer)
    参数
    类型
    含义
    authBuffer
    byte[]
    鉴权

    示例代码

    UserConfig.SetAppID(transform.Find ("appId").GetComponent<InputField> ().text);
    UserConfig.SetUserID(transform.Find ("userId").GetComponent<InputField> ().text);
    UserConfig.SetAuthKey(transform.Find("authKey").GetComponent<InputField>().text);
    byte[] authBuffer = UserConfig.GetAuthBuffer(UserConfig.GetAppID(), UserConfig.GetUserID(), null,UserConfig.GetAuthKey());
    ITMGContext.GetInstance ().GetPttCtrl ().ApplyPTTAuthbuffer(authBuffer);

    限制最大语音信息时长

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

    接口原型

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

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().SetMaxMessageLength(58000);

    流式语音识别

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

    接口
    接口含义
    StartRecordingWithStreamingRecognition
    启动流式录音
    StopRecording
    停止录音

    启动流式语音识别

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

    接口原型

    ITMGPTT int StartRecordingWithStreamingRecognition(string filePath)
    ITMGPTT int StartRecordingWithStreamingRecognition(string filePath, string speechLanguage,string translateLanguage)
    参数
    类型
    含义
    filePath
    String
    存放的语音路径
    speechLanguage
    String
    识别成指定文字的语言参数,参数请参见 语言参数参考列表
    translateLanguage
    String
    填入与 speechLanguage 相同的值

    示例代码

    string recordPath = Application.persistentDataPath + string.Format("/{0}.silk", sUid++);
    int ret = ITMGContext.GetInstance().GetPttCtrl().StartRecordingWithStreamingRecognition(recordPath, "cmn-Hans-CN","cmn-Hans-CN");
    注意:
    翻译会收取额外费用,请参见 购买指南

    流式语音识别的回调

    启动流式语音识别后,需要通过在 OnStreamingSpeechComplete 或者 OnStreamingSpeechisRunning 通知中监听回调消息,事件消息分为以下两个:
    OnStreamingSpeechComplete 是在停止录制并完成识别后才返回文字,相当于一段话说完才会返回识别的文字。
    OnStreamingSpeechisRunning 是在录音过程中就会实时返回识别到的文字,相当于边说话边返回识别到的文字。
    根据需求在 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
    流式语音转文本失败
    在流式录制状态当中,请等待流式录制接口执行结果返回
    32787
    转文本成功,文本翻译服务未开通
    需要在控制台开通文本翻译服务
    32788
    转文本成功,文本翻译语言参数不支持
    重新检查传入参数
    如果出现 4098 错误码,请参见 常见问题文档 进行解决。

    示例代码

    //对事件进行监听:
    ITMGContext.GetInstance().GetPttCtrl().OnStreamingSpeechComplete +=new QAVStreamingRecognitionCallback (OnStreamingSpeechComplete);
    ITMGContext.GetInstance().GetPttCtrl().OnStreamingSpeechisRunning += new QAVStreamingRecognitionCallback (OnStreamingRecisRunning);
    //监听处理:
    void OnStreamingSpeechComplete(int code, string fileid, string filepath, string result){
    //启动流式语音识别的回调
    }
    
    void OnStreamingRecisRunning(int code, string fileid, string filePath, string result){
    if (code == 0)
    {
    setBtnText(mStreamBtn, "流式");
    InputField field = transform.Find("recordFilePath").GetComponent<InputField>();
    field.text = filePath;
    
    field = transform.Find("downloadUrl").GetComponent<InputField>();
    field.text = "Stream is Running";
    
    field = transform.Find("convertTextResult").GetComponent<InputField>();
    field.text = result;
    showWarningText("录制中");
    }
    }

    语音消息录制

    录制的流程为:录音 > 停止录音 > 录音回调返回 > 启动下一次录音。

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

    接口
    接口含义
    StartRecording
    启动录音
    PauseRecording
    暂停录音
    ResumeRecording
    恢复录音
    StopRecording
    停止录音
    CancelRecording
    取消录音

    启动录音

    此接口用于启动录音。

    接口原型

    ITMGPTT int StartRecording(string fileDir)
    参数
    类型
    含义
    fileDir
    string
    存放的语音路径

    示例代码

    string recordPath = Application.persistentDataPath + string.Format ("/{0}.silk", sUid++);
    int ret = ITMGContext.GetInstance().GetPttCtrl().StartRecording(recordPath);

    停止录音

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

    接口原型

    ITMGPTT int StopRecording()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().StopRecording();

    启动录音的回调

    录音完成的回调,通过委托传递消息。
    停止录音调用StopRecording。停止录音后才有启动录音的回调。

    接口原型

    public delegate void QAVRecordFileCompleteCallback(int code, string filepath);
    public abstract event QAVRecordFileCompleteCallback OnRecordFileComplete;
    参数
    类型
    含义
    code
    string
    当 code 为 0 时,录制完成
    filepath
    string
    录制的存放地址,必须是可以访问到的路径,不可将 fileid 作为路径

    错误码

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

    示例代码

    //对事件进行监听
    ITMGContext.GetInstance().GetPttCtrl().OnRecordFileComplete += new QAVRecordFileCompleteCallback (OnRecordFileComplete);
    //监听处理
    void OnRecordFileComplete(int code, string filepath){
    //启动录音的回调
    }

    暂停录音

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

    接口原型

    ITMGPTT int PauseRecording()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().PauseRecording();

    恢复录音

    此接口用于恢复录音。

    接口原型

    ITMGPTT int ResumeRecording()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().ResumeRecording();

    取消录音

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

    接口原型

    ITMGPTT int CancelRecording()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().CancelRecording();

    语音消息上传、下载及播放

    接口
    接口含义
    UploadRecordedFile
    上传语音文件
    DownloadRecordedFile
    下载语音文件
    PlayRecordedFile
    播放语音
    StopPlayFile
    停止播放语音
    GetFileSize
    语音文件的大小
    GetVoiceFileDuration
    语音文件的时长

    上传语音文件

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

    接口原型

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

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().UploadRecordedFile(filePath);

    上传语音完成的回调

    上传语音完成的回调,通过委托传递消息。

    接口原型

    public delegate void QAVUploadFileCompleteCallback(int code, string filepath, string fileid);
    public abstract event QAVUploadFileCompleteCallback OnUploadFileComplete;
    参数
    类型
    含义
    code
    int
    当 code 为0时,录制完成
    filepath
    string
    录制的存放地址
    fileid
    string
    文件的 url 路径

    错误码

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

    示例代码

    //对事件进行监听
    ITMGContext.GetInstance().GetPttCtrl().OnUploadFileComplete +=new QAVUploadFileCompleteCallback (OnUploadFileComplete);
    //监听处理
    void OnUploadFileComplete(int code, string filepath, string fileid){
    //上传语音完成的回调
    }

    下载语音文件

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

    接口原型

    ITMGPTT DownloadRecordedFile (string fileID, string downloadFilePath)
    参数
    类型
    含义
    fileID
    String
    文件的 url 路径
    downloadFilePath
    String
    文件的本地保存路径,必须是可以访问到的路径,不可将 fileid 作为路径

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().DownloadRecordedFile(fileId, filePath);

    下载语音文件完成回调

    下载语音文件完成回调,通过委托传递消息。

    接口原型

    public delegate void QAVDownloadFileCompleteCallback(int code, string filepath, string fileid);
    public abstract event QAVDownloadFileCompleteCallback OnDownloadFileComplete;
    参数
    类型
    含义
    code
    int
    当 code 为0时,录制完成
    filepath
    string
    录制的存放地址
    fileid
    string
    文件的 url 路径,录音在服务器存放 90 天

    错误码

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

    示例代码

    //对事件进行监听
    ITMGContext.GetInstance().GetPttCtrl().OnDownloadFileComplete +=new QAVDownloadFileCompleteCallback(OnDownloadFileComplete);
    //监听处理
    void OnDownloadFileComplete(int code, string filepath, string fileid){
    //下载语音文件完成回调
    }

    播放语音

    此接口用于播放语音。

    接口原型

    ITMGPTT PlayRecordedFile(string filePath)
    ITMGPTT PlayRecordedFile(string filePath,int voiceType);
    参数
    类型
    含义
    filePath
    string
    本地语音文件的路径
    voicetype
    int
    变声类型,请参见 变声接入文档

    错误码

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

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().PlayRecordedFile(filePath);

    播放语音的回调

    播放语音的回调,通过委托传递消息。

    接口原型

    public delegate void QAVPlayFileCompleteCallback(int code, string filepath);
    public abstract event QAVPlayFileCompleteCallback OnPlayFileComplete;
    参数
    类型
    含义
    code
    int
    当 code 为0时,播放完成
    filepath
    string
    录制的存放地址

    错误码

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

    示例代码

    //对事件进行监听:
    ITMGContext.GetInstance().GetPttCtrl().OnPlayFileComplete +=new QAVPlayFileCompleteCallback(OnPlayFileComplete);
    //监听处理:
    void OnPlayFileComplete(int code, string filepath){
    //播放语音的回调
    }

    停止播放语音

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

    接口原型

    ITMGPTT int StopPlayFile()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().StopPlayFile();

    获取语音文件的大小

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

    接口原型

    ITMGPTT GetFileSize(string filePath)
    参数
    类型
    含义
    filePath
    String
    语音文件的路径,此路径为本地路径

    示例代码

    int fileSize = ITMGContext.GetInstance().GetPttCtrl().GetFileSize(filepath);

    获取语音文件的时长

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

    接口原型

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

    示例代码

    int fileDuration = ITMGContext.GetInstance().GetPttCtrl().GetVoiceFileDuration(filepath);

    录音文件极速转文本

    接口
    接口含义
    SpeechToText
    语音识别成文字

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

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

    接口原型

    ITMGPTT int SpeechToText(String fileID)
    参数
    类型
    含义
    fileID
    String
    语音文件 url

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().SpeechToText(fileID);

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

    此接口可以指定语言进行识别,也可以将语音中识别到的信息翻译成指定的语言返回。
    注意:
    翻译会收取额外费用,请参见 购买指南

    接口原型

    ITMGPTT int SpeechToText(String fileID,String speechLanguage)
    ITMGPTT int SpeechToText(String fileID,String speechLanguage,String translatelanguage)
    参数
    类型
    含义
    fileID
    String
    语音文件 url,录音在服务器存放90天
    speechLanguage
    String
    识别出指定文字的语言参数,参数参见 语言参数参考列表
    translatelanguage
    String
    翻译成指定文字的语言参数,参数参见 语言参数参考列表 中的翻译语言参数

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().SpeechToText(fileID,"cmn-Hans-CN","cmn-Hans-CN");

    识别回调

    将指定的语音文件识别成文字,通过委托传递消息。

    接口原型

    public delegate void QAVSpeechToTextCallback(int code, string fileid, string result);
    public abstract event QAVSpeechToTextCallback OnSpeechToTextComplete;
    参数
    类型
    含义
    code
    int
    当 code 为0时,录制完成
    fileid
    string
    语音文件 url,录音在服务器存放 90 天
    result
    string
    转换的文本结果

    错误码

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

    示例代码

    //对事件进行监听
    ITMGContext.GetInstance().GetPttCtrl().OnSpeechToTextComplete += new QAVSpeechToTextCallback(OnSpeechToTextComplete);
    //监听处理
    void OnSpeechToTextComplete(int code, string fileid, string result){
    //识别回调
    }

    语音消息音量相关接口

    接口
    接口含义
    GetMicLevel
    获取实时麦克风音量
    SetMicVolume
    设置录制音量
    GetMicVolume
    获取录制音量
    GetSpeakerLevel
    获取实时扬声器音量
    SetSpeakerVolume
    设置播放音量
    GetSpeakerVolume
    获取播放音量

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

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

    接口原型

    ITMGPTT int GetMicLevel()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().GetMicLevel();

    设置语音消息录制音量

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

    接口原型

    ITMGPTT int SetMicVolume(int vol)

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().SetMicVolume(100);

    获取语音消息录制音量

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

    接口原型

    ITMGPTT int GetMicVolume()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().GetMicVolume();

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

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

    接口原型

    ITMGPTT int GetSpeakerLevel()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().GetSpeakerLevel();

    设置语音消息播放音量

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

    接口原型

    ITMGPTT int SetSpeakerVolume(int vol)

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().SetSpeakerVolume(100);

    获取语音消息播放音量

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

    接口原型

    ITMGPTT int GetSpeakerVolume()

    示例代码

    ITMGContext.GetInstance().GetPttCtrl().GetSpeakerVolume();

    高级 API

    获取版本号

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

    接口原型

    ITMGContext abstract string GetSDKVersion()

    示例代码

    ITMGContext.GetInstance().GetSDKVersion();

    设置打印日志等级

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

    接口原型

    ITMGContext 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
    打印高频日志

    示例代码

    ITMGContext.GetInstance().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 SetLogPath(string logDir)
    参数
    类型
    含义
    logDir
    String
    路径

    示例代码

    ITMGContext.GetInstance().SetLogPath(path);
    
    联系我们

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

    技术支持

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

    7x24 电话支持