| 方法 | 描述 |
|---|---|
| create | 创建 GameRTCEngine 实例。 创建 GameRTCEngine 实例后,你才可以使用 SDK 提供的其他能力。 |
| destroy | 销毁引擎 销毁由 GameRTCEngine.create 所创建引擎实例,并释放所有相关资源 |
| getSdkVersion | 获取 SDK 当前的版本号。 |
| setRtcNativeLibraryLoader | 设置 native library 加载器,需要在其他所有静态方法调用之前被调用。 |
| 方法 | 描述 |
|---|---|
| joinRoom | 加入实时语音房间。 在使用实时语音的通话功能时,必须先加入实时语音房间 |
| leaveRoom | 离开房间 用户调用此方法离开房间,结束通话过程,释放所有通话相关的资源。 调用 joinRoom 方法加入房间后,在通话结束时必须调用此方法,并收到 onLeaveRoom 回调确认结束通话,否则无法开始下一次通话。 无论当前是否在房间中,都可以调用此方法。重复调用此方法不会有负面影响。 |
| updateToken | 更新进房 token。 在进房时如果收到错误码为 ROOM_ERROR_INVALID_TOKEN 的 onRoomError 回调,表示 token 过期导致进房失败。 此时,你应调用此接口,以新 token 进房。 |
| 方法 | 描述 |
|---|---|
| enableMicrophone | 控制本地音频采集和发布状态。 改变该状态后,房间内其他用户会收到 onMicrophoneEnabled 回调 |
| enableAudioSend | 控制本地语音的发送状态:发送/不发送 使用此方法后,房间中的其他用户会收到回调 onAudioSendEnabled。 |
| enableSpeakerphone | 设置对来自远端的语音的接收状态。 使用此方法后,房间中的其他用户会收到回调 onSpeakerphoneEnabled。 |
| enableAudioReceive | 设置对来自指定远端用户的语音的接收状态。 |
| setRecordingVolume | 调节音频采集音量。 |
| setPlaybackVolume | 调节本地播放的所有远端用户混音后的音量。 |
| setRemoteAudioPlaybackVolume | 调节来自指定远端用户的音频播放音量,默认为 100。 |
| 方法 | 描述 |
|---|---|
| updateReceiveRange | 在世界房间中,使用范围语音功能时,设定语音的接收范围和衰减信息。 |
| updatePosition | 使用范围语音功能时,设置玩家的坐标。 |
| 方法 | 描述 |
|---|---|
| setExternalAudioDevice | 设置是否启用外部音频采集渲染 |
| pushExternalAudioFrame | 推送音频数据。 推送的音频格式是 PCM。推送间隔是 10ms。音频采样格式是 S16。 |
| pullExternalAudioFrame | 拉取音频数据。 拉取的音频格式是 PCM。拉取间隔是 10ms。音频采样格式是 S16。 |
| 回调 | 描述 |
|---|---|
| load | SDK 在需要加载动态库时通过该方法回调 |
| onConnectionStateChanged | 用户与 RTC 服务器连接状态发生改变时,收到此回调。 |
| onNetworkQuality | 通话中用户的媒体流网络上下行质量报告回调。加入房间成功后,每隔 2 秒会触发此回调,通知房间内用户与媒体服务器之间数据交互的网络质量。 |
| onLogReport | 上报日志时,回调该事件。 |
| onEngineWarning | SDK 运行时出现了引擎相关的警告时,收到此回调。 |
| 回调 | 描述 |
|---|---|
| onJoinRoomSuccess | 用户成功加入房间/重连进房后,收到此回调。 |
| onLeaveRoom | 离开房间成功回调 用户调用 leaveRoom 方法后,SDK 会停止所有的发布订阅流,并释放所有通话相关的音视频资源。SDK 完成所有的资源释放后,用户收到此回调。 离开房间结束通话后,如果 App 需要使用系统音视频设备,建议在收到此回调后再初始化音视频设备.否则可能由于 SDK 占用了导致 App 初始化音视频设备失败。 |
| onUserJoined | 远端用户加入房间回调。 以下情形下,本地用户会收到此回调: |
| onUserLeave | 远端用户离开房间回调。 房间中有用户主动调用 leaveRoom 方法离开房间或断线超时离开房间时,房间中其他用户都会收到此回调。 |
| onRoomWarning | SDK 运行时,出现房间相关警告,收到此回调。 |
| onRoomError | 房间相关错误回调。 |
| 回调 | 描述 |
|---|---|
| onMicrophoneEnabled | 远端用户开关麦克风回调 当用户调用 enableMicrophone 更改本地音频采集和发布状态时,房间内其他用户会收到此回调。 |
| onAudioSendEnabled | 远端用户启停音频数据发送的回调 当用户调用 enableAudioSend 更改本地音频发送状态时,房间内其他用户会收到此回调。 |
| onSpeakerphoneEnabled | 远端用户启停音频数据接收的回调 当用户调用 enableSpeakerphone 更改远端音频接收状态时,房间内其他用户会收到此回调。 |
| onAudioVolumeIndication | 提示本地采集的音量信息和在房间内订阅的远端用户的音量信息。 本回调默认不开启。你可以通过 GameRTCRoomConfig 中的 audioVolumeIndicationInterval 参数开启。 |