API OVERVIEW
基础功能
函数列表 | 描述 |
GME SDK 事件回调接口。 | |
获取 GME SDK 实例(单例模式)。 | |
设置接入点(已废弃)。 | |
初始化 GME SDK。 | |
触发事件回调。 | |
系统暂停。 | |
系统恢复。 | |
反初始化 GME SDK。 | |
设置应用场景。 | |
切换角色。 | |
设置范围语音模式。 | |
设置范围语音的 TeamID。 | |
加入语音房间。 | |
退出语音房间。 | |
是否已经在语音房间内。 | |
设置打印日志等级。 | |
设置日志文件保存路径。 | |
获取日志文件保存路径。 | |
获取 GME SDK 版本。 | |
设置 App 版本号。 | |
显示仪表盘。 | |
获取房间相关的类实例。 | |
获取离线语音相关的类实例。 | |
获取音频控制相关的类实例。 | |
获取音频音效控制相关的类实例。 | |
设置最大混音路数。 | |
设置高级功能参数。 | |
获取高级功能参数值。 | |
查询麦克风权限。 |
音频控制相关。
函数列表 | 描述 |
开启或关闭麦克风。 | |
麦克风状态获取。 | |
开启或关闭扬声器。 | |
扬声器状态获取。 | |
开启音频采集设备。 | |
获取采集设备状态。 | |
开启或关闭播放设备。 | |
获取播放设备状态。 | |
打开关闭音频上行。 | |
获取音频上行状态。 | |
打开或关闭音频下行。 | |
获取音频下行状态。 | |
设置麦克风音量的增益。 | |
获取麦克风音量的增益。 | |
设置扬声器音量增益。 | |
获取扬声器音量增益。 | |
动态设置房间内某成员音量增益。 | |
获取设置的房间内成员音量增益。 | |
开启/关闭耳返。 | |
设置耳返音量。 | |
禁言房间中某个用户。 | |
解除对房间中某个用户的禁言。 | |
查询某个用户是否被禁言。 | |
初始化 3D 音效处理器。 | |
开启或关闭 3D 音效。 | |
获取当前 3D 音效状态。 | |
启用音频自定义采集模式。 | |
设置音频路由 | |
向 SDK 投送自己采集的音频数据。 | |
开启音频自定义播放。 | |
获取可播放的音频数据。 | |
开启音量回调。 | |
停止音量回调。 | |
获取实时麦克风音量。 | |
获取实时扬声器音量。 | |
获取音频上行实时音量。 | |
获取房间内其他成员下行实时音量。 | |
开始麦克风测试 [仅桌面端有效]。 | |
结束麦克风测试 [仅桌面端有效]。 | |
开始扬声器测试 [仅桌面端有效]。 | |
结束扬声器测试 [仅桌面端有效]。 | |
设置音频数据自定义回调。 |
音频特效和背景音乐。
函数列表 | 描述 |
开始播放背景音乐。 | |
停止播放背景音乐。 | |
暂停播放背景音乐。 | |
恢复播放背景音乐。 | |
背景音乐是否播放结束。 | |
设置所有背景音乐的本地音量和远端音量的大小。 | |
设置某一首背景音乐的远端音量的大小。 | |
获取某一首背景音乐的远端音量大小。 | |
设置某一首背景音乐的本地音量的大小。 | |
获取某一首背景音乐的本地音量的大小。 | |
调整背景音乐的音调高低。 | |
获取背景音乐的总时长(单位:毫秒)。 | |
获取背景音乐的播放进度(单位:毫秒)。 | |
设置背景音乐的播放进度(单位:毫秒)。 | |
是否将 sound_id 对应的背景音乐发布到远端。 | |
是否在本地播放 sound_id 对应的背景音乐。 | |
设置人声的变声特效。 | |
设置人声的混响特效。 | |
开始录制音频。 | |
停止录制音频。 | |
开启系统声音采集。 | |
停止系统声音采集。 | |
设置系统声音的采集音量。 |
音频房间相关。
函数列表 | 描述 |
获取语音房间 ID。 | |
修改用户房间音频类型。 | |
获取当前房间类型。 | |
开始跨房连麦通话。 | |
结束跨房连麦通话。 | |
快速切换房间。 | |
发送自定义消息。 | |
停止发送自定义消息。 | |
设置接收语音距离范围。 | |
设置 3D 音效衰减距离。 | |
更新玩家在指定房间的声源方位及坐标。 | |
更新指定远端用户的空间坐标。 | |
使用 SEI 通道发送自定义消息。 |
离线语音相关
函数列表 | 描述 |
应用鉴权。 | |
限制最大语音消息时长。 | |
启动录音。 | |
停止录音。 | |
取消录音。 | |
上传语音文件。 | |
下载语音文件。 | |
播放语音。 | |
播放语音。 | |
停止播放语音。 | |
将指定的语音文件识别成文字。 | |
将指定的语音文件翻译成文字(指定语言)。 | |
将指定的语音文件翻译成文字(指定语言)。 | |
文本翻译接口。 | |
获取语音文件的大小。 | |
获取语音文件的时长。 | |
启动流式语音识别。 | |
启动流式语音识别。 | |
启动流式语音识别。 | |
设置 PTT 功能源语言。 | |
文本转语音接口。 |