为方便小程序开发者调试和接入腾讯云游戏多媒体引擎产品 API，这里向您介绍适用于小程序实时语音功能的开发接入技术文档。
使用 GME 重要事项
- 调用 EnterRoom 接口成功进入实时语音房间后才会开始计费。
- 返回值为 OK 代表调用成功。
代码结构
<gme-room> 组件的文件结构如下：
| 目录 | 说明 |
|---|---|
| common | 常量存储空间，包括事件烈性和错误类型、本地和远端的默认配置信息 |
| model | pusher、player 的抽象对象模型 |
| custom utils | 功能函数 |
| gme-room.js | gme-room 组件主程序文件 |
| gme-room.json | gme-room 组件声明文件 |
| gme-room.wxml | gme-room 组件模板文件 |
| gme-room.wxss | gme-room 组件样式文件 |
组件属性
| KEY | 示例 | 作用 | 获取方案 |
|---|---|---|---|
| appID | 14000* | 用于计费和业务区分 | 来自 腾讯云控制台 的 GME 服务提供的 AppID |
| roomID | room_123 | 房间号 | 最大127字符，支持英文、数字和下划线 |
| userID | 10001 | 用户名 | 只支持 Int64 类型（转为 string 传入） |
| authBuffer | 鉴权字符串 | 用于进房的鉴权 | 来自 腾讯云控制台 的权限密钥 |
说明：
- 参数 appID 获取请参考 语音服务开通指引。
- userID 用于唯一标识一个用户，目前只支持 INT64，规则由 App 开发者自行制定，App 内不重复即可。
接口描述
加入语音房间
调用此函数用于进入实时语音房间。调用接口前请确认组件属性已经完成配置。
函数原型
enterRoom(eventHandler) | 参数 | 含义 |
|---|---|
| eventHandler | 接受事件通知的函数 |
回调
进房完成的回调： EVENT_ENTER_ROOM_COMPLETED。
退出语音房间
调用此函数用于退出实时语音房间。一次进入退出流程为一个进房周期。
函数原型
exitRoom()回调
退房完成回调： EVENT_EXIT_ROOM_COMPLETED。
打开/关闭麦克风
在进房成功后，才可以调用此接口打开麦克风并开始推流。
函数原型
enableMic(enable)| 参数 | 含义 |
|---|---|
| enable | 如果需要打开麦克风，则传入的参数为 true，如果关闭麦克风，则参数为 false |
打开/关闭扬声器
在进房成功后，默认打开扬声器播放房间内声音。
函数原型
enableSpeaker(enable)| 参数 | 含义 |
|---|---|
| enable | 如果需要打开扬声器，则传入的参数为 true，如果关闭扬声器风，则参数为 false |
获取成员列表
获取全量的远端用户列表,只有开麦的用户才能获取到。
函数原型
getRemoteUserList() 返回值
调用之后返回内容为全量的开麦用户。
事件定义
EVENT_TYPE
| 参数 | 含义 |
|---|---|
| EVENT_ENTER_ROOM_COMPLETED | 进房完成 |
| EVENT_EXIT_ROOM_COMPLETED | 退房完成 |
| EVENT_AUDIO_VOLUME_UPDATE | 音量变更，内容是 UserID 及 上下行的音量 |
| EVENT_USER_LIST_UPDATE | 用户列表更新，更新全量的开麦用户 |
| EVENT_ERROR | 通用错误，请咨询 GME 工作人员进行解决 |
错误说明
ERROR_TYPE
| 参数 | 含义 |
|---|---|
| OK | 无错误 |
| ERROR_INVALID_PARAMETER | 参数错误 |
| ERROR_CHARGE_OVERDU | 欠费 |
| ERROR_NETWORK_ERROR | 网络错误 |
| ERROR_UNKNOWN | 未知错误 |