接口 | 接口含义 |
Init | 初始化 GME |
Poll | 触发事件回调 |
Pause | 系统暂停 |
Resume | 系统恢复 |
Uninit | 反初始化 GME |
import 'package:gme/gme.dart';import 'package:gme/gmeType.dart';
ITMGContext context = ITMGContext.GetInstance();
//class ITMGContextFuture<int> InitSDK(String appID, String openID)
返回值 | 处理 |
GmeError.AV_OK= 0 | 初始化 SDK 成功 |
AV_ERR_SDK_NOT_FULL_UPDATE=7015 | 检查 SDK 文件是否完整,建议删除后重新导入 SDK |
string SDKAPPID3RD = "14000xxxxx";string openId="10001";int res = await ITMGContext.GetInstance().InitSDK(SDKAPPID3RD, openId);if (ret != GmeError.AV_OK){print("Init SDK Error");return;}
//在初始化 SDK 时候ITMGContext.GetInstance().SetEvent(handleEventMsg);//回调方法void handleEventMsg(int eventType, String data) async {// enterRoom eventprint("AddDelegate3" + eventType.toString());switch (eventType) {case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{//进房回调}break;case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE:{//切换房间回调}break;}}
Future<void> Poll();
Future<void> pollTimer() async {_pollTimer = Timer.periodic(Duration(milliseconds: 100), (Timer timer) {ITMGContext.GetInstance().Poll();});}
Future<int> Pause()
Future<int> Resume()
Future<int> Uninit()
接口 | 接口含义 |
GenAuthBuffer | 本地鉴权计算 |
EnterRoom | 加入房间 |
ExitRoom | 退出房间 |
IsRoomEntered | 判断是否已经进入房间 |
Future<Uint8List> GenAuthBuffer(String appID, String roomID, String openID, String key)
参数 | 类型 | 含义 |
appID | string | 来自腾讯云控制台的 AppID 号码。 |
roomID | string | 房间号,最大支持127字符。 |
openID | string | 用户标识。与 Init 时候的 openID 相同。 |
key | string |
Uint8List userSig = await ITMGContext.GetInstance().GenAuthBuffer(_editAppID.text, _editRoomID.text, _editOpenID.text, _editKey.text);int res = await ITMGContext.GetInstance().EnterRoom(_editRoomID.text, 1, userSig);
Future<int> EnterRoom(String roomID, int roomType, Uint8List authBuffer)
参数 | 类型 | 含义 |
roomId | string | 房间号,最大支持127字符。 |
roomType | ITMGRoomType | |
appKey | Uint8List | 鉴权码。 |
int res = await ITMGContext.GetInstance().EnterRoom(_editRoomID.text, 1, authBuffer);
//对事件进行监听:void handleEventMsg(int eventType, String data) async {switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{//进房后续流程处理}}}ITMGContext.GetInstance().SetEvent(handleEventMsg);
消息 | 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 接口正常调用 |
Future<int> ExitRoom()
ITMGContext.GetInstance().ExitRoom();
void handleEventMsg(int eventType, String data) async{switch (eventType) {case ITMG_MAIN_EVENT_TYPE_EXIT_ROOM:{//退房后续进行处理break;}}}ITMGContext.GetInstance().SetEvent(handleEventMsg);
Future<bool> IsRoomEntered()
bool res = await ITMGContext.GetInstance().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 | 应用侧维护通话成员列表 |
void handleEventMsg(int eventType, String data) async {if (eventType == 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;}}
Future<int> AddAudioBlackList(String openID)
参数 | 类型 | 含义 |
openID | string | 需添加黑名单的用户 openid |
res = await ITMGContext.GetInstance().GetAudioCtrl().AddAudioBlackList(_editRoomManagerID.text);
Future<int> RemoveAudioBlackList(String openID)
参数 | 类型 | 含义 |
openId | string | 需移除黑名单的 ID |
res = await ITMGContext.GetInstance().GetAudioCtrl().RemoveAudioBlackList(_editRoomManagerID.text);
接口 | 接口含义 |
EnableMic | 开关麦克风 |
GetMicState | 获取麦克风状态 |
EnableAudioCaptureDevice | 开关采集设备 |
IsAudioCaptureDeviceEnabled | 获取采集设备状态 |
EnableAudioSend | 打开关闭音频上行 |
IsAudioSendEnabled | 获取音频上行状态 |
GetMicLevel | 获取实时麦克风音量 |
GetSendStreamLevel | 获取音频上行实时音量 |
SetMicVolume | 设置麦克风音量 |
GetMicVolume | 获取麦克风音量 |
Future<int> EnableMic(bool enable)
参数 | 类型 | 含义 |
isEnabled | bool | 如果需要打开麦克风,则传入的参数为 true,如果关闭麦克风,则参数为 false |
//打开麦克风int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableMic(true);
Future<int> GetMicState()
int micState = await ITMGContext.GetInstance().GetAudioCtrl().GetMicState();
Future<int> EnableAudioCaptureDevice(bool enable)
参数 | 类型 | 含义 |
enable | bool | 如果需要打开采集设备,则传入的参数为 true,如果关闭采集设备,则参数为 false |
//打开采集设备int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableAudioCaptureDevice(true);
Future<bool> IsAudioCaptureDeviceEnabled()
bool res = await ITMGContext.GetInstance().GetAudioCtrl().IsAudioCaptureDeviceEnabled();
Future<int> EnableAudioSend(bool enable)
参数 | 类型 | 含义 |
isEnabled | bool | 如果需要打开音频上行,则传入的参数为 true,如果关闭音频上行,则参数为 false |
int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableAudioSend(isCheck);
Future<bool> IsAudioSendEnabled()
bool IsAudioSend = await ITMGContext.GetInstance().GetAudioCtrl().IsAudioSendEnabled();
Future<int> GetMicLevel()
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetMicLevel();
Future<int> GetSendStreamLevel()
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetSendStreamLevel();
Future<int> SetMicVolume(int volume)
参数 | 类型 | 含义 |
volume | number | 取值范围为 0-200,数值为0的时候表示静音,当数值为100的时候表示音量不增不减,默认数值为100。 |
int volume = 100;int res = await ITMGContext.GetInstance().GetAudioCtrl().SetMicVolume(volume);
Future<int> GetMicVolume()
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetMicVolume();
接口 | 接口含义 |
EnableSpeaker | 开关扬声器 |
GetSpeakerState | 获取扬声器状态 |
EnableAudioPlayDevice | 开关播放设备 |
IsAudioPlayDeviceEnabled | 获取播放设备状态 |
EnableAudioRecv | 打开关闭音频下行 |
IsAudioRecvEnabled | 获取音频下行状态 |
GetSpeakerLevel | 获取实时扬声器音量 |
GetRecvStreamLevel | 获取房间内其他成员下行实时音量 |
SetSpeakerVolume | 设置扬声器音量 |
GetSpeakerVolume | 获取扬声器音量 |
Future<int> EnableSpeaker(bool enable)
参数 | 类型 | 含义 |
bEnable | bool | 如果需要关闭扬声器,则传入的参数为 false,如果打开扬声器,则参数为 true |
//打开扬声器await ITMGContext.GetInstance().GetAudioCtrl().EnableSpeaker(isCheck);
Future<int> GetSpeakerState()
int spkState = await ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerState();
Future<int> EnableAudioPlayDevice(bool enable)
参数 | 类型 | 含义 |
enable | bool | 如果需要关闭播放设备,则传入的参数为 false,如果打开播放设备,则参数为 true |
int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableAudioPlayDevice(isCheck);
Future<bool> IsAudioPlayDeviceEnabled()
bool res = await ITMGContext.GetInstance().GetAudioCtrl().IsAudioPlayDeviceEnabled();
Future<int> EnableAudioRecv(bool enable)
参数 | 类型 | 含义 |
isEnabled | bool | 如果需要打开音频下行,则传入的参数为 true,如果关闭音频下行,则参数为 false |
int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableAudioRecv(isCheck);
Future<bool> IsAudioRecvEnabled()
bool res = await ITMGContext.GetInstance().GetAudioCtrl().IsAudioRecvEnabled();
Future<int> GetSpeakerLevel()
bool res = await ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerLevel();
Future<int> GetRecvStreamLevel(String openID)
参数 | 类型 | 含义 |
openId | string | 房间其他成员的 openId |
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetRecvStreamLevel(_editRoomManagerID.text);
Future<int> SetSpeakerVolumeByOpenID(String openId, int volume)
参数 | 类型 | 含义 |
openId | string | 需要调节音量大小的OpenID |
volume | number | 百分比,建议[0-200],其中100为默认值 |
int res = await ITMGContext.GetInstance().GetAudioCtrl().SetSpeakerVolumeByOpenID(_editRoomManagerID.text, 100);
Future<int> GetSpeakerVolumeByOpenID(String openId)
参数 | 类型 | 含义 |
openId | string | 需要调节音量大小的 OpenID |
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerVolumeByOpenID(_editRoomManagerID.text);
Future<int> SetSpeakerVolume(int volume)
参数 | 类型 | 含义 |
volume | number | 设置音量,范围0 - 200,当数值为0时,表示静音,当数值为100时,表示音量不增不减,默认数值为100。 |
int volume = value.toInt();int res = await ITMGContext.GetInstance().GetAudioCtrl().SetSpeakerVolume(volume);
Future<int> GetSpeakerVolume()
int res = await ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerVolume();
Future<int> EnableLoopBack(bool enable)
参数 | 类型 | 含义 |
enable | bool | 设置是否启动 |
int res = await ITMGContext.GetInstance().GetAudioCtrl().EnableLoopBack(true);
Future<int> GetRoomType()
int curType = await ITMGContext.GetInstance().GetRoom().GetRoomType();
Future<int> ChangeRoomType(int roomType)
参数 | 类型 | 含义 |
roomtype | number | 房间切换成的目标类型,房间音频类型参考 EnterRoom 接口 |
int res = await ITMGContext.GetInstance().GetRoom().ChangeRoomType(1);
事件子类型 | 代表参数 | 含义 |
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 接口,请求切换房间音频类型 |
case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE:{//对房间类型事件进行处理}break;
参数 | 类型 | 含义 |
weight | number | 范围是1 - 50,数值为50是音质评分极好,数值为1是音质评分很差,几乎不能使用,数值为0代表初始值,无含义。一般数值在30以下就可以提醒用户网络较差,建议切换网络。 |
loss | var | 上行丢包率。 |
delay | number | 音频触达延迟时间(ms)。 |
Future<String> GetSDKVersion()
_sdkVersions = await ITMGContext.GetInstance().GetSDKVersion();
Future<void> SetAppVersion(String appVersion)
参数 | 类型 | 含义 |
appVersion | string | 应用名称和版本 |
await ITMGContext.GetInstance().SetAppVersion("gme V2.0.0");
Future<int> SetLogLevel(int levelWrite, int levelPrint)
参数 | 类型 | 含义 |
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 | 打印高频日志 |
ITMGContext.GetInstance().SetLogLevel(ITMG_LOG_LEVEL.TMG_LOG_LEVEL_ERROR, ITMG_LOG_LEVEL.TMG_LOG_LEVEL_ERROR);
Future<int> SetLogPath(String logDir)
参数 | 类型 | 含义 |
logPath | string | 路径 |
String curPath = ""//自行设置路径ITMGContext.GetInstance().SetLogPath(curPath);
Future<String> GetQualityTips()
String curQualityTips = await ITMGContext.GetInstance().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}} |
本页内容是否解决了您的问题?