接口 | 接口含义 |
Init | 初始化 GME |
Poll | 触发事件回调 |
Pause | 系统暂停 |
Resume | 系统恢复 |
Uninit | 反初始化 GME |
const { GmeContext } = require('gme-electron-sdk');
context = new GmeContext();
//class GmeSDKInit(appid: string, openid: string): number;
返回值 | 处理 |
GmeError.AV_OK= 0 | 初始化 SDK 成功 |
AV_ERR_SDK_NOT_FULL_UPDATE=7015 | 检查 SDK 文件是否完整,建议删除后重新导入 SDK |
string SDKAPPID3RD = "14000xxxxx";string openId="10001";number ret = context.Init(SDKAPPID3RD, openId);//通过返回值判断是否初始化成功if (ret != GmeError.AV_OK){console.log("SDK初始化失败:");return;}
SetTMGDelegate(cb: ITMGDelegate);//在初始化 SDK 时候context = GmeSDK.GetInstance();context.setTMGDelegate(function(eventId, msg){if (type == ITMG_MAIN_EVENT_TYPE_ENTER_ROOM){//回调处理}});
Poll():number;
setInterval(function () {context.Poll();}, 50);
Pause() :number
Resume() :number
Uninit() : number;
接口 | 接口含义 |
GenAuthBuffer | 本地鉴权计算 |
EnterRoom | 加入房间 |
ExitRoom | 退出房间 |
IsRoomEntered | 判断是否已经进入房间 |
GenAuthBuffer(appId: string,roomId: string, openId:string, appKey: number) :string;
参数 | 类型 | 含义 |
appId | string | 来自腾讯云控制台的 AppID 号码。 |
roomId | string | 房间号,最大支持127字符。 |
openId | string | 用户标识。与 Init 时候的 openID 相同。 |
key | number |
let userSig = context.GenAuthBuffer(this.appid, this.roomId, this.userId, this.authKey)context.EnterRoom(this.roomId, this.roomType, userSig);
EnterRoom(roomid: string, roomType: number, appKey: string) :number;
参数 | 类型 | 含义 |
roomId | string | 房间号,最大支持127字符 |
roomType | ITMGRoomType | |
appKey | string | 鉴权码 |
context.EnterRoom(roomID, ITMG_ROOM_TYPE_STANDARD, retAuthBuff);
//对事件进行监听:gmeContext.setTMGDelegate(function(eventId, msg){switch (eventId) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{}}});
消息 | 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 接口正常调用 |
ExitRoom(): number;
context.ExitRoom();
gmeContext.setTMGDelegate(function(eventId, msg){switch (eventId) {case ITMG_MAIN_EVENT_TYPE_EXIT_ROOM:{//进行处理break;}}});
IsRoomEntered() :boolean
context.IsRoomEntered();
接口/通知 | 含义 |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | 成员状态变化通知 |
AddAudioBlackList | 房间中禁言某成员 |
RemoveAudioBlackList | 移除禁言 |
IsOpenIdInAudioBlackList | 查询某openid是否被禁言 |
event_id | 含义 | 应用侧维护内容 |
EVENT_ID_ENDPOINT_ENTER | 有成员进入房间,返回此时进房的 openid | 应用侧维护成员列表 |
EVENT_ID_ENDPOINT_EXIT | 有成员退出房间,返回此时退房的 openid | 应用侧维护成员列表 |
EVENT_ID_ENDPOINT_HAS_AUDIO | 有成员发送音频包,返回此时房间内说话的 openid,通过此事件可以判断用户是否说话,并展示声纹效果 | 应用侧维护通话成员列表 |
EVENT_ID_ENDPOINT_NO_AUDIO | 有成员停止发送音频包,返回此时房间内停止说话的 openid | 应用侧维护通话成员列表 |
context.setTMGDelegate(function(eventId, msg){if (type == ITMG_MAIN_EVENT_TYPE_ENTER_ROOM){//进行处理switch (eventID){case EVENT_ID_ENDPOINT_ENTER://有成员进入房间break;case EVENT_ID_ENDPOINT_EXIT://有成员退出房间break;case EVENT_ID_ENDPOINT_HAS_AUDIO://有成员发送音频包break;case EVENT_ID_ENDPOINT_NO_AUDIO://有成员停止发送音频包break;default:break;}break;}});
AddAudioBlackList(openId: string) :number
参数 | 类型 | 含义 |
openId | string | 需添加黑名单的用户 openid |
context.AddAudioBlackList(openId);
RemoveAudioBlackList(openId: string) :number
参数 | 类型 | 含义 |
openId | string | 需移除黑名单的 ID |
context.RemoveAudioBlackList(openId);
IsOpenIdInAudioBlackList(openId: string) :boolean
参数 | 类型 | 含义 |
openId | string | 需查询是否在黑名单的 ID |
boolean isInBlackList = context.IsOpenIdInAudioBlackList(openId);
接口 | 接口含义 |
EnableMic | 开关麦克风 |
GetMicState | 获取麦克风状态 |
EnableAudioCaptureDevice | 开关采集设备 |
IsAudioCaptureDeviceEnabled | 获取采集设备状态 |
EnableAudioSend | 打开关闭音频上行 |
IsAudioSendEnabled | 获取音频上行状态 |
GetMicLevel | 获取实时麦克风音量 |
GetSendStreamLevel | 获取音频上行实时音量 |
SetMicVolume | 设置麦克风音量 |
GetMicVolume | 获取麦克风音量 |
EnableMic(bEnable: boolean) : number
参数 | 类型 | 含义 |
isEnabled | boolean | 如果需要打开麦克风,则传入的参数为 true,如果关闭麦克风,则参数为 false |
//打开麦克风context.EnableMic(true);
GetMicState() :number
context.GetMicState();
EnableAudioCaptureDevice(enable:boolean) :number
参数 | 类型 | 含义 |
enable | boolean | 如果需要打开采集设备,则传入的参数为 true,如果关闭采集设备,则参数为 false |
//打开采集设备context.EnableAudioCaptureDevice(true);
IsAudioCaptureDeviceEnabled():boolean
boolean IsAudioCaptureDevice = context.IsAudioCaptureDeviceEnabled();
EnableAudioSend(bEnable: boolean) :number
参数 | 类型 | 含义 |
isEnabled | boolean | 如果需要打开音频上行,则传入的参数为 true,如果关闭音频上行,则参数为 false |
context.EnableAudioSend(true);
IsAudioSendEnabled():boolean
boolean IsAudioSend = context.IsAudioSendEnabled();
GetMicLevel():number
context.GetMicLevel();
GetSendStreamLevel() :number
context.GetSendStreamLevel();
SetMicVolume(volume:number) :number
参数 | 类型 | 含义 |
volume | number | 取值范围为 0-200,数值为0的时候表示静音,当数值为100的时候表示音量不增不减,默认数值为100。 |
number micVol = (value * 100);context.SetMicVolume (micVol);
GetMicVolume()
context.GetMicVolume();
接口 | 接口含义 |
EnableSpeaker | 开关扬声器 |
GetSpeakerState | 获取扬声器状态 |
EnableAudioPlayDevice | 开关播放设备 |
IsAudioPlayDeviceEnabled | 获取播放设备状态 |
EnableAudioRecv | 打开关闭音频下行 |
IsAudioRecvEnabled | 获取音频下行状态 |
GetSpeakerLevel | 获取实时扬声器音量 |
GetRecvStreamLevel | 获取房间内其他成员下行实时音量 |
SetSpeakerVolume | 设置扬声器音量 |
GetSpeakerVolume | 获取扬声器音量 |
EnableSpeaker(bEnable: boolean) : number;
参数 | 类型 | 含义 |
bEnable | boolean | 如果需要关闭扬声器,则传入的参数为 false,如果打开扬声器,则参数为 true |
//打开扬声器context.EnableSpeaker(true);
GetSpeakerState() :number
context.GetSpeakerState();
EnableAudioPlayDevice(enable:boolean) :number
参数 | 类型 | 含义 |
enable | boolean | 如果需要关闭播放设备,则传入的参数为 false,如果打开播放设备,则参数为 true |
context.EnableAudioPlayDevice(true);
IsAudioPlayDeviceEnabled() :boolean
boolean enable = context.IsAudioPlayDeviceEnabled();
EnableAudioRecv(bEnable: boolean) :number
参数 | 类型 | 含义 |
isEnabled | boolean | 如果需要打开音频下行,则传入的参数为 true,如果关闭音频下行,则参数为 false |
context.EnableAudioRecv(true);
IsAudioRecvEnabled():boolean
boolean IsAudioRecv = context.IsAudioRecvEnabled();
GetSpeakerLevel():number
context.GetSpeakerLevel();
GetRecvStreamLevel(openId: string) :number
参数 | 类型 | 含义 |
openId | string | 房间其他成员的openId |
number level =GetRecvStreamLevel(openId);
SetSpeakerVolumeByOpenID(openId: string, volume:number) :number;
参数 | 类型 | 含义 |
openId | string | 需要调节音量大小的 OpenID |
volume | number | 百分比,建议[0-200],其中100为默认值 |
context.SetSpeakerVolumeByOpenID(openId, 100);
GetSpeakerVolumeByOpenID(openId: string) :number;
参数 | 类型 | 含义 |
openId | string | 需要调节音量大小的 OpenID |
context.GetSpeakerVolumeByOpenID(openId);
SetSpeakerVolume(volume:number) :number
参数 | 类型 | 含义 |
volume | number | 设置音量,范围0 - 200,当数值为0时,表示静音,当数值为100时,表示音量不增不减,默认数值为100。 |
number vol = 100;context.SetSpeakerVolume(vol);
GetSpeakerVolume() :number
numbet volume = context.GetSpeakerVolume();
接口 | 接口含义 |
GetMicListCount | 获取麦克风设备数量 |
GetMicList | 枚举麦克风设备 |
GetSpeakerListCount | 获取扬声器设备数量 |
GetSpeakerList | 枚举扬声器设备 |
SelectMic | 选定麦克风设备 |
SelectSpeaker | 选定扬声器设备 |
GetMicListCount() :number
var micListCount = context.GetMicListCount();
GetMicList() :GmeAudioDeviceInfo[];
var micList = context.GetMicList();
SelectMic(micId: string) :number;
参数 | 类型 | 含义 |
micId | string | 麦克风设备 ID,设备 ID 来自于 GetMicList 返回列表。 |
context.SelectMic(deviceID);
GetSpeakerListCount() :number;
context.GetSpeakerListCount();
GetSpeakerList(): GmeAudioDeviceInfo[]
var speakList = GetSpeakerList();
SelectSpeaker(speakerId: string) :number
参数 | 类型 | 含义 |
speakerId | string | 扬声器设备 ID,设备 ID 来自于 GetSpeakerList 返回列表。 |
var ret = SelectSpeaker(deviceID);
EnableLoopBack(bEnable: boolean) :number
参数 | 类型 | 含义 |
enable | boolean | 设置是否启动 |
context.EnableLoopBack(true);
GetRoomType() :number
context.GetRoomType();
ChangeRoomType(roomType: number) :number
参数 | 类型 | 含义 |
roomtype | number | 房间切换成的目标类型,房间音频类型参考 EnterRoom 接口 |
context.ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);
事件子类型 | 代表参数 | 含义 |
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 接口,请求切换房间音频类型 |
context.setTMGDelegate(function(eventId, msg){if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE == type){//对房间类型事件进行处理}});
参数 | 类型 | 含义 |
weight | number | 范围是1 - 50,数值为50是音质评分极好,数值为1是音质评分很差,几乎不能使用,数值为0代表初始值,无含义。一般数值在30以下就可以提醒用户网络较差,建议切换网络。 |
loss | var | 上行丢包率。 |
delay | number | 音频触达延迟时间(ms)。 |
GetSDKVersion() :string
context.GetSDKVersion();
SetAppVersion(appVersion: string) : number
参数 | 类型 | 含义 |
appVersion | string | 应用名称和版本 |
context.SetAppVersion("gme V2.0.0");
SetLogLevel(level: number) : number
参数 | 类型 | 含义 |
level | number | 设置日志的等级,TMG_LOG_LEVEL_NONE 表示不写入,默认为 TMG_LOG_LEVEL_INFO |
level | 含义 |
TMG_LOG_LEVEL_NONE | 不打印日志 |
TMG_LOG_LEVEL_ERROR | 打印错误日志(默认) |
TMG_LOG_LEVEL_INFO | 打印提示日志 |
TMG_LOG_LEVEL_DEBUG | 打印开发调试日志 |
TMG_LOG_LEVEL_VERBOSE | 打印高频日志 |
context.SetLogLevel(TMG_LOG_LEVEL_INFO);
平台 | 路径 |
Windows | %appdata%\\GMEGLOBAL\\GME\\ProcessName |
SetLogPath(logPath: string)
参数 | 类型 | 含义 |
logPath | string | 路径 |
string logDir = ""//自行设置路径context.SetLogPath(logDir);
GetQualityTips() :string
string tips = context.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}} |
本页内容是否解决了您的问题?