Copyright (c) 2025 Tencent. All rights reserved.
Module: GME 关键类型定义
Function: 常用的结构体、枚举值和常量值的定义。
类型定义
结构体类型
函数列表 | 描述 |
音频帧数据。 |
枚举类型
枚举类型 | 描述 |
日志级别。 | |
应用场景。 | |
角色类型。 | |
房间类型。 | |
GME SDK 事件类型。 | |
自定义数据相关子事件。 | |
范围语音相关状态。 | |
成员状态变化子事件。 | |
PCM - 位深度。 | |
网络质量, 表征网络质量的好坏,您可以通过该数值在用户界面上展示每个用户的网络质量。 | |
麦克风权限类型。 | |
音频路由(即声音的播放模式) | |
控制远端用户音频设备子事件。 | |
变声特效。 |
ITMG_LOG_LEVEL
ITMG_LOG_LEVEL
日志级别。
枚举 | 取值 | 描述 |
ITMG_LOG_LEVEL_NONE | -1 | 关闭日志。 |
ITMG_LOG_LEVEL_ERROR | 1 | 只输出 Error 级别日志。 |
ITMG_LOG_LEVEL_INFO | 2 | 输出 Info、Error 级别日志。 |
ITMG_LOG_LEVEL_DEBUG | 3 | 输出 Debug、Info、Error 级别日志。 |
ITMG_LOG_LEVEL_VERBOSE | 4 | 输出 Verbose、Debug、Info、Error 级别日志。 |
ITMG_APP_SCENE
ITMG_APP_SCENE
应用场景。
枚举 | 取值 | 描述 |
ITMG_APP_SCENE_RTC | 2 | 实时语聊场景,该场景下单个房间最多支持 300 人,最高支持 50 人同时发言,房间内用户默认为主播,均可自由发言。 |
ITMG_APP_SCENE_LIVE | 3 |
ITMG_AUDIO_MEMBER_ROLE
ITMG_AUDIO_MEMBER_ROLE
角色类型。
枚举 | 取值 | 描述 |
ITMG_AUDIO_MEMBER_ROLE_ANCHOR | 0 | 主播角色,可随时发布自己的音频流。 |
ITMG_AUDIO_MEMBER_ROLE_AUDIENCE | 1 |
ITMG_ROOM_TYPE
ITMG_ROOM_TYPE
房间类型。
枚举 | 取值 | 描述 |
ITMG_ROOM_TYPE_FLUENCY | 1 | 流畅音质,单声道,编码码率:18kbps,流畅优先、超低延迟实时语音;应用在游戏内开黑场景,适用于 FPS、MOBA 等类型的游戏。 |
ITMG_ROOM_TYPE_STANDARD | 2 | 标准音质,单声道,编码码率:50kbps,音质较好,延时适中;适用于狼人杀、棋牌等休闲游戏的实时通话场景。 |
ITMG_ROOM_TYPE_HIGHQUALITY | 3 | 高清音质,全频带立体声,编码码率:128kbps,超高音质,延时相对大一些;适用于音乐舞蹈类游戏以及语音互动类 App 以及播放音乐、线上 K 歌等有高音质要求的场景。 |
ITMG_MAIN_EVENT_TYPE
ITMG_MAIN_EVENT_TYPE
GME SDK 事件类型。
枚举 | 取值 | 描述 |
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | 1 | 进入实时语音房间事件。 |
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM | 2 | 退出实时语音房间事件 。 |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | 3 | 房间因为网络等原因断开连接事件。 |
ITMG_MAIN_EVENT_TYPE_USER_UPDATE | 4 | 成员状态变化事件。 |
ITMG_MAIN_EVENT_TYPE_NUMBER_OF_USERS_UPDATE | 7 | 已废弃。 |
ITMG_MAIN_EVENT_TYPE_NUMBER_OF_AUDIOSTREAMS_UPDATE | 8 | 已废弃。 |
ITMG_MAIN_EVENT_TYPE_RECONNECT_START | 11 | 房间重连开始事件。 |
ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS | 12 | 房间重连成功事件。 |
ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM | 13 | 快速切换房间结果事件。 |
ITMG_MAIN_EVENT_TYPE_SET_AUDIO_ROLE | 14 | 角色设置成功事件。 |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE | 21 | 已废弃。 |
ITMG_MAIN_EVENT_TYPE_AUDIO_DATA_EMPTY | 22 | 已废弃。 |
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_START | 23 | 请求跨房通话的结果事件。 |
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_STOP | 24 | 结束跨房通话的结果回调。 |
ITMG_MAIN_EVENT_TYPE_RECORD_COMPLETED | 30 | 音频录制结束事件。 |
ITMG_MAIN_EVENT_TYPE_IOS_MUTE_SWITCH_RESULT | 34 | iOS 静音键检查结果,[仅 iOS 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_SPEAKER_DEFAULT_DEVICE_CHANGED | 1008 | 默认扬声器发生改变事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE | 1009 | 新增扬声器设备事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_SPEAKER_LOST_DEVICE | 1010 | 移除扬声器设备事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_MIC_NEW_DEVICE | 1011 | 新增麦克风设备事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_MIC_LOST_DEVICE | 1012 | 移除麦克风设备事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_MIC_DEFAULT_DEVICE_CHANGED | 1013 | 默认麦克风设备发生改变事件,[仅 Windows 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_SYSTEM_LOOPBACK_START_FAILED | 1014 | 系统混音启动失败事件,[仅 Windows/Mac 平台有效]。 |
ITMG_MAIN_EVENT_TYPE_USER_VOLUMES | 1020 | 房间内用户音量发生变化事件。 |
ITMG_MAIN_EVENT_TYPE_NETWORK_QUALITY | 1021 | 网络通话质量事件。 |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY | 1022 | 房间通话质量监控事件(已废弃),请使用 ITMG_MAIN_EVENT_TYPE_NETWORK_QUALITY。 |
ITMG_MAIN_EVENT_TYPE_USER_SPECTRUMS | 1023 | 房间内用户频谱数据。 |
ITMG_MAIN_EVENT_TYPE_USER_VAD | 1024 | 房间内用户 VAD 状态回调事件。 |
ITMG_MAIN_EVENT_TYPE_TEST_MIC_VOLUME | 1030 | 麦克风测试回调事件 [仅桌面端有效]。 |
ITMG_MAIN_EVENT_TYPE_TEST_SPEAKER_VOLUME | 1031 | 扬声器测试回调事件 [仅桌面端有效]。 |
ITMG_MAIN_EVENT_TYPE_MUSIC_PLAY_START | 1087 | BGM 开始播放事件。 |
ITMG_MAIN_EVENT_TYPE_MUSIC_PLAY_PROGRESS | 1088 | BGM 播放进度事件。 |
ITMG_MAIN_EVENT_TYPE_MUSIC_PLAY_PAUSE | 1089 | BGM 暂停播放事件。 |
ITMG_MAIN_EVENT_TYPE_MUSIC_PLAY_RESUME | 1090 | BGM 恢复播放事件。 |
ITMG_MAIN_EVENT_TYPE_MUSIC_PLAY_FINISH | 1091 | BGM 播放完成事件。 |
ITMG_MAIN_EVENT_TYPE_CUSTOMDATA_UPDATE | 1092 | 自定义数据事件。 |
ITMG_MAIN_EVENT_TYPE_RECV_SEI_MSG | 1093 | SEI 自定义数据事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_RECORD_FIRST_FRAME | 5000 | 语音消息录制到第一帧音频事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_RECORD_COMPLETE | 5001 | 语音消息录制完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_UPLOAD_COMPLETE | 5002 | 语音消息文件上传完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_DOWNLOAD_COMPLETE | 5003 | 语音消息文件下载完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_PLAY_COMPLETE | 5004 | 语音消息播放完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_SPEECH2TEXT_COMPLETE | 5005 | 语音消息转文本完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE | 5006 | 流式语音转文本完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING | 5007 | 流式语音转文本进行中。 |
ITMG_MAIN_EVENT_TYPE_PTT_TEXT2SPEECH_COMPLETE | 5008 | 文本转语音完成事件。 |
ITMG_MAIN_EVENT_TYPE_PTT_TRANSLATE_TEXT_COMPLETE | 5009 | 文本翻译完成事件。 |
ITMG_MAIN_EVENT_TYPE_ROOM_MANAGEMENT_OPERATOR | 6000 | 控制远端用户音频设备事件。 |
ITMG_CUSTOMDATA_SUB_EVENT
ITMG_CUSTOMDATA_SUB_EVENT
自定义数据相关子事件。
枚举 | 取值 | 描述 |
ITMG_CUSTOMDATA_AV_SUB_EVENT_UPDATE | 0 | 自定义数据事件。 |
ITMG_CUSTOMDATA_AV_SUB_EVENT_AI_CONVERSATION | 1 | AI会话消息事件。 |
ITMG_RANGE_AUDIO_MODE
ITMG_RANGE_AUDIO_MODE
范围语音相关状态。
枚举 | 取值 | 描述 |
ITMG_RANGE_AUDIO_MODE_SND_ALL_REC_ALL | 1 | 默认模式:音频发送给房间内所有玩家,接收房间类所有玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_ALL_REC_BOTH | 2 | 主持人模式:音频发送给房间内所有玩家,接收附近范围内和同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_TEAM_REC_TEAM | 3 | 小队模式:音频只发送给同队玩家,只接收同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_TEAM_REC_PROX | 4 | 音频只发送给同队玩家,只接收附近范围内的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_TEAM_REC_BOTH | 5 | 音频只发送给同队玩家,接收附近范围内和同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_PROX_REC_TEAM | 6 | 音频只发送给附近范围内的玩家,只接收同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_PROX_REC_PROX | 7 | 范围模式:音频只发送给附近范围内的玩家,只接收附近范围内的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_PROX_REC_BOTH | 8 | 音频只发送给附近范围内的玩家,接收附近范围内和同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_BOTH_REC_TEAM | 9 | 音频发送给附近范围内和同队玩家的音频,只接收同队玩家的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_BOTH_REC_PROX | 10 | 音频发送给附近范围内和同队玩家的音频,只接收附近范围内的音频。 |
ITMG_RANGE_AUDIO_MODE_SND_BOTH_REC_BOTH | 11 | 范围+小队模式:音频发送给附近范围内和同队玩家的音频,接收附近范围内和同队玩家的音频。 |
ITMG_EVENT_ID_USER_UPDATE
ITMG_EVENT_ID_USER_UPDATE
成员状态变化子事件。
枚举 | 取值 | 描述 |
ITMG_EVENT_ID_USER_ENTER | 1 | 有用户进入语音房间事件。 |
ITMG_EVENT_ID_USER_EXIT | 2 | 有用户退出语音房间事件。 |
ITMG_EVENT_ID_USER_MIC_OPENED | 3 | 有用户开启麦克风事件。 |
ITMG_EVENT_ID_USER_MIC_CLOSED | 4 | 有用户关闭麦克风事件。 |
ITMG_EVENT_ID_USER_HAS_AUDIO | 5 | 有用户发送音频数据事件,返回此时房间内说话的 UserID,通过此事件可以判断用户是否说话,并展示声纹效果。 |
ITMG_EVENT_ID_USER_NO_AUDIO | 6 | 有用户停止发送音频数据事件,返回此时房间内停止说话的 UserID。 |
ITMG_PCM_BITS_TYPE
ITMG_PCM_BITS_TYPE
PCM - 位深度。
枚举 | 取值 | 描述 |
ITMG_PCM_BITS_TYPE_FIXED_16 | 0 | 16bit |
ITMG_PCM_BITS_TYPE_FLOAT_32 | 1 | 32bit |
ITMG_NETWORK_QUALITY
ITMG_NETWORK_QUALITY
网络质量, 表征网络质量的好坏,您可以通过该数值在用户界面上展示每个用户的网络质量。
枚举 | 取值 | 描述 |
ITMG_NETWORK_QUALITY_UNKNOWN | 0 | 未定义。 |
ITMG_NETWORK_QUALITY_EXCELLENT | 1 | 当前网络非常好。 |
ITMG_NETWORK_QUALITY_GOOD | 2 | 当前网络比较好。 |
ITMG_NETWORK_QUALITY_POOR | 3 | 当前网络一般。 |
ITMG_NETWORK_QUALITY_BAD | 4 | 当前网络较差。 |
ITMG_NETWORK_QUALITY_VBAD | 5 | 当前网络很差。 |
ITMG_NETWORK_QUALITY_DOWN | 6 | 当前网络不满足 GME SDK 的最低要求。 |
ITMG_MIC_PERMISSION
ITMG_MIC_PERMISSION
麦克风权限类型。
枚举 | 取值 | 描述 |
ITMG_PERMISSION_GRANTED | 0 | 麦克风已授权。 |
ITMG_PERMISSION_Denied | 1 | 麦克风被禁用。 |
ITMG_PERMISSION_NotDetermined | 2 | 权限未知,需请求权限。 |
ITMG_AUDIO_ROUTE
ITMG_AUDIO_ROUTE
音频路由(即声音的播放模式)
音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
手机有两个扬声器:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
枚举 | 取值 | 描述 |
ITMG_AUDIO_ROUTE_UNKNOWN | -1 | Unknown:未知路由设备。 |
ITMG_AUDIO_ROUTE_SPEAKER | 0 | Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。 |
ITMG_AUDIO_ROUTE_EARPIECE | 1 | Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。 |
ITMG_ROOM_MANAGEMENT_OPERATOR
ITMG_ROOM_MANAGEMENT_OPERATOR
控制远端用户音频设备子事件。
枚举 | 取值 | 描述 |
ITMG_ROOM_MANAGEMENT_MIC_OP | 0 | 控制麦克风事件。 |
ITMG_ROOM_MANAGERMENT_FORBID_OP | 1 | 禁止操作麦克风及扬声器事件。 |
ITMG_VOICE_TYPE
ITMG_VOICE_TYPE
变声特效。
变声特效可以作用于人声之上,通过声学算法对人声进行二次处理,以获得与原始声音所不同的音色。
枚举 | 取值 | 描述 |
ITMG_VOICE_TYPE_ORIGINAL_SOUND | 0 | 关闭特效。 |
ITMG_VOICE_TYPE_KINDER_GARTEN | 1 | 幼稚园。 |
ITMG_VOICE_TYPE_LOLITA | 2 | 萝莉。 |
ITMG_VOICE_TYPE_UNCLE | 3 | 大叔。 |
ITMG_VOICE_TYPE_HEAVY_MENTAL | 4 | 重金属。 |
ITMG_VOICE_TYPE_INFLUENZA | 5 | 感冒。 |
ITMG_VOICE_TYPE_DIALECT | 6 | 歪果仁。 |
ITMG_VOICE_TYPE_CAGED_ANIMAL | 7 | 困兽。 |
ITMG_VOICE_TYPE_DEAD_FATBOY | 8 | 死肥宅。 |
ITMG_VOICE_TYPE_STRONG_CURRENT | 9 | 强电流。 |
ITMG_VOICE_TYPE_HEAVY_MACHINE | 10 | 重机器。 |
ITMG_VOICE_TYPE_INTANGIBLE | 11 | 空灵。 |
ITMG_VOICE_TYPE_PIGSY | 12 | 猪八戒。 |
ITMG_VOICE_TYPE_HULK | 13 | 绿巨人。 |
TMGAudioFrame
TMGAudioFrame
音频帧数据。
枚举类型 | 描述 |
bits_type | 位深度。 |
channel | 声道数。 |
data | 音频数据。 |
sample_rate | 采样率。 |
timestamp | 时间戳,单位 ms。 |