Copyright (c) 2025 Tencent. All rights reserved.
Module： TMGContext@GMESDK
Function： 腾讯云 GME 主功能接口。
ITMGContext
ITMGDelegate
函数列表 | 描述 |
GME SDK 事件回调接口。 |
ITMGContext
函数列表 | 描述 |
获取 GME SDK 实例（单例模式）。 | |
设置接入点（已废弃）。 | |
初始化 GME SDK。 | |
触发事件回调。 | |
系统暂停。 | |
系统恢复。 | |
反初始化 GME SDK。 | |
设置应用场景。 | |
切换角色。 | |
设置范围语音模式。 | |
设置范围语音的 TeamID。 | |
加入语音房间。 | |
退出语音房间。 | |
是否已经在语音房间内。 | |
设置打印日志等级。 | |
设置日志文件保存路径。 | |
获取日志文件保存路径。 | |
获取 GME SDK 版本。 | |
设置 App 版本号。 | |
显示仪表盘。 | |
获取房间相关的类实例。 | |
获取离线语音相关的类实例。 | |
获取音频控制相关的类实例。 | |
获取音频音效控制相关的类实例。 | |
设置最大混音路数。 | |
设置高级功能参数。 | |
获取高级功能参数值。 | |
查询麦克风权限。 |
OnEvent:data:
OnEvent:data:
- (void)OnEvent: | |
data: | (NSDictionary *)data |
GME SDK 事件回调接口。
参数 | 描述 |
data | 事件参数。 |
type | 事件类型。 |
GetInstance
GetInstance
获取 GME SDK 实例（单例模式）。
为 GME SDK 最基础函数， 需要第一个使用。
SetRegion:
SetRegion:
- (void)SetRegion: | (NSString *)region |
设置接入点（已废弃）。
通常不需要主动调用该接口，SDK 内部会根据 AppID 自动选择接入点，如果 AppID 是国内站申请的，就自动连接国内站环境；如果是 AppID 是国际站申请的，就自动连接国际站环境。
参数 | 描述 |
region |
InitEngine:openID:
InitEngine:openID:
- (int)InitEngine: | (NSString *)appId |
openID: | (NSString *)userID |
初始化 GME SDK。
在使用 GME SDK 相关功能时需要先调用该接口进行初始化。
参数 | 描述 |
appId | 在腾讯云申请的 GME 应用 appid。 |
userID | 当前用户的 userId，相当于用户名，使用 UTF-8 编码，最大 127 个字符。 |
Poll
Poll
触发事件回调。
Poll 是 GME 的消息泵，应用需要周期性的调用 Poll 接口触发事件回调；如果没有调用 Poll ，将会导致整个 SDK 服务运行异常。
Pause
Pause
系统暂停。
当系统发生 Pause 事件时，需要同时通知引擎进行 Pause。如果不需要后台播放房间内声音，请调用 Pause 接口暂停整个 GME 服务。
Resume
Resume
系统恢复。
当系统发生 Resume 事件时，需要同时通知引擎进行 Resume；Resume 接口只恢复实时语音。
Uninit
Uninit
反初始化 GME SDK。
使用 GME SDK 相关功能后，调用该接口释放相关资源，如果游戏业务侧账号与 UserID 是绑定的，那切换游戏账号需要反初始化 GME，再用新的 UserID 初始化。
SetScene:
SetScene:
- (int)SetScene: |
设置应用场景。
默认为语聊场景，单个房间最多支持 300 人同时在线，最高支持 50 人同时发言，适用于 [语音聊天]、[在线狼人杀] [游戏开黑]等业务场景；
SetAudioRole:
SetAudioRole:
- (int)SetAudioRole: |
切换角色。
调用本接口可以实现用户在 【主播】 和 【观众】 两种角色之间来回切换。
在语音互动直播或国战语音场景，只有主播才能发布音频流，听众只能接收音频流，如果观众需要发布音频流，需要调用该接口将角色切换成主播。
SetRangeAudioMode:
SetRangeAudioMode:
- (int)SetRangeAudioMode: |
设置范围语音模式。
进房前，通过调用此接口修改语音模式，影响下一次进房。
进房后，通过调用此接口修改语音模式，将直接改变当前用户的语音模式。
SetRangeAudioTeamID:
SetRangeAudioTeamID:
- (int)SetRangeAudioTeamID: | (int)teamID |
设置范围语音的 TeamID。
进房前，通过此接口设置队伍号，影响下一次进房。
进房后，可通过此接口修改队伍号，设置后立即生效。
退房后再进房，请在退房成功回调回来之后再调用设置队伍号接口。
EnterRoom:roomType:authBuffer:
EnterRoom:roomType:authBuffer:
- (int)EnterRoom: | (NSString *)roomID |
roomType: | |
authBuffer: | (NSData *)userSig |
加入语音房间。
参数 | 描述 |
roomId | 语音房间号，最大支持 64 字符。 |
roomType | 房间类型。 |
userSig | 用户鉴权信息。 |
ExitRoom
ExitRoom
退出语音房间。
通过调用此接口可以退出所在房间。本接口是异步的，返回值为 AV_OK 的时候代表异步调用成功。退房结果通过 ITMG_MAIN_EVENT_TYPE 的ITMG_MAIN_EVENT_TYPE_EXIT_ROOM 事件通知上层应用。
注意
如果应用中有退房后立即进房的场景，在接口调用流程上，开发者无需要等待 ExitRoom 的回调通知，只需直接调用接口。
IsRoomEntered
IsRoomEntered
是否已经在语音房间内。
通过调用此接口可以判断是否已经进入房间，返回值为 bool 类型。
SetLogLevel:levelPrint:
SetLogLevel:levelPrint:
- (int)SetLogLevel: | |
levelPrint: |
设置打印日志等级。
用于设置日志等级，建议保持默认等级，需要在 Init 之前调用。
参数 | 描述 |
levelPrint | 打印日志等级。 |
levelWrite | 写文件日志等级。 |
SetLogPath:
SetLogPath:
- (int)SetLogPath: | (NSString *)logDir |
设置日志文件保存路径。
用于设置打印日志路径，需要在 Init 之前调用。
参数 | 描述 |
logDir | 日志文件存储路径。 |
GetLogPath
GetLogPath
获取日志文件保存路径。
GetSDKVersion
GetSDKVersion
获取 GME SDK 版本。
SetAppVersion:
SetAppVersion:
- (void)SetAppVersion: | (NSString *)appVersion |
设置 App 版本号。
APP 可以将自己的版本号设置给 GME SDK，用于内部信息上报。
参数 | 描述 |
appVersion | 应用版本信息。 |
ShowDebugView:
ShowDebugView:
- (int)ShowDebugView: | (BOOL)show |
显示仪表盘。
仪表盘是状态统计和事件消息浮层 view，方便调试。
参数 | 描述 |
show | 是否显示仪表盘。 |
GetRoom
GetRoom
获取房间相关的类实例。
GetPTT
GetPTT
获取离线语音相关的类实例。
GetAudioCtrl
GetAudioCtrl
获取音频控制相关的类实例。
GetAudioEffectCtrl
GetAudioEffectCtrl
获取音频音效控制相关的类实例。
SetRecvMixStreamCount:
SetRecvMixStreamCount:
- (QAVResult)SetRecvMixStreamCount: | (int)count |
设置最大混音路数。
使用此接口可以设置最大混音路数，在进房前调用。
参数 | 描述 |
count | 最大混音路数。 |
SetAdvanceParams:value:
SetAdvanceParams:value:
- (QAVResult)SetAdvanceParams: | (NSString *)key |
value: | (NSString *)value |
设置高级功能参数。
参数 | 描述 |
key | 参数名。 |
value | 参数值。 |
GetAdvanceParams:
GetAdvanceParams:
- (NSString *)GetAdvanceParams: | (NSString *)key |
获取高级功能参数值。
CheckMicPermission
CheckMicPermission
查询麦克风权限。
