| 方法 | 描述 |
|---|---|
| Initialize | 创建 GameRTCEngine 实例。 GameRTCEngine 实例成功创建后,你才可以使用 SDK 提供的其他能力。 |
| Release | 销毁由 Initialize 所创建引擎实例,并释放所有相关资源。 |
| GetSdkVersion | 获取 SDK 当前的版本号。 |
| 方法 | 描述 |
|---|---|
| JoinRoom | 加入实时语音房间。 在使用实时语音的通话功能时,必须先加入实时语音房间。 调用该方法后,会收到 OnJoinRoomResultEventHandler 回调通知。 |
| LeaveRoom | 离开房间。 用户调用此方法离开房间,结束通话过程,释放所有通话相关的资源。 调用 JoinRoom 方法加入房间后,在通话结束时必须调用此方法,并收到 OnLeaveRoomEventHandler 回调确认结束通话,否则无法开始下一次通话。 无论当前是否在房间中,都可以调用此方法。重复调用此方法不会有负面影响。 |
| UpdateToken | 更新进房 token。 在进房时如果收到错误码为 kJoinRoomInvalidToken 的 OnJoinRoomResultEventHandler 回调,表示 token 过期导致进房失败。 此时,你应调用此接口,以新 token 进房。 |
| 方法 | 描述 |
|---|---|
| EnableMicrophone | 控制本地音频采集和发布状态。 改变该状态后,房间内其他用户会收到 OnMicrophoneEnabledEventHandler 回调。 |
| EnableAudioSend | 控制本地语音的发送状态:发送/不发送。 使用此方法后,房间中的其他用户会收到 OnAudioSendEnabledEventHandler 回调。 |
| EnableSpeakerphone | 设置对来自远端的语音的接收状态。 使用此方法后,房间中的其他用户会收到 OnSpeakerphoneEnabledEventHandler 回调。 |
| EnableAudioReceive | 设置对来自指定远端用户的语音的接收状态。 |
| SetRecordingVolume | 调节音频采集音量。 |
| SetPlaybackVolume | 调节本地播放的所有远端用户混音后的音量。 |
| SetRemoteAudioPlaybackVolume | 调节来自指定远端用户的音频播放音量 |
| SetAudioScenario | 设置音频场景类型。 你可以根据你的应用所在场景,选择合适的音频场景类型。 选择音频场景后,RTC 会自动根据客户端音频路由和发布订阅状态,适用通话音量/媒体音量。 在进房前和进房后设置均可生效。 |
| 方法 | 描述 |
|---|---|
| UpdateReceiveRange | 在世界房间中,使用范围语音功能时,设定语音的接收范围和衰减信息。 |
| UpdatePosition | 使用范围语音功能时,设置玩家的坐标。 |
| 方法 | 描述 |
|---|---|
| GetRecordingDeviceCount | 获取音频采集设备的数量 |
| SetRecordingDevice | 指定音频采集设备 |
| GetCurrentRecordingDevice | 获取当前音频采集设备 |
| GetAllRecordingDevices | 获取全部音频采集设备信息 |
| GetPlaybackDeviceCount | 获取音频播放设备的数量 |
| SetPlaybackDevice | 指定音频播放设备 |
| GetCurrentPlaybackDevice | 获取当前音频播放设备 |
| GetAllPlaybackDevices | 获取全部音频播放设备信息 |
| 回调 | 描述 |
|---|---|
| OnJoinRoomResultEventHandler | 用户首次成功加入房间/重连进房后,收到此回调。 |
| OnLeaveRoomEventHandler | 离开房间成功回调 用户调用 LeaveRoom 方法后,SDK 会停止所有的发布订阅流,并释放所有通话相关的音视频资源。SDK 完成所有的资源释放后,用户收到此回调。 |
| OnUserJoinedEventHandler | 远端用户加入房间回调。 以下情形下,本地用户会收到此回调: + 远端用户首次加入房间/重连加入房间; + 本地用户加入房间时,会收到回调,提示已在房间中的远端用户。 |
| OnUserLeaveEventHandler | 远端用户离开房间回调。 房间中有用户主动调用 LeaveRoom 方法离开房间或断线超时离开房间时,房间中其他用户都会收到此回调。 |
| OnRoomWarningEventHandler | SDK 运行时,出现房间相关警告,收到此回调。 |
| OnRoomErrorEventHandler | 房间相关错误回调。 |
| 回调 | 描述 |
|---|---|
| OnMicrophoneEnabledEventHandler | 远端用户开关麦克风回调。 当用户调用 EnableMicrophone 更改本地音频采集和发布状态时,房间内其他用户会收到此回调。 |
| OnAudioSendEnabledEventHandler | 远端用户启停音频数据发送的回调。 当用户调用 EnableAudioSend 更改本地音频发送状态时,房间内其他用户会收到此回调。 |
| OnSpeakerphoneEnabledEventHandler | 远端用户启停音频数据接收的回调。 当用户调用 EnableSpeakerphone 更改远端音频接收状态时,房间内其他用户会收到此回调。 |
| OnAudioVolumeIndicationEventHandler | 提示本地采集的音量信息和在房间内订阅的远端用户的音量信息。 本回调默认不开启。你可以通过 GameRTCRoomConfig.AudioVolumeIndicationIntervalGameRTCRoomConfig 开启。 |
| 回调 | 描述 |
|---|---|
| OnNetworkQualityEventHandler | 通话中用户的媒体流网络上下行质量报告回调。加入房间成功后,每隔 2 秒会收到此回调,通知房间内用户与媒体服务器之间数据交互的网络质量。 |
| OnConnectionStateChangedEventHandler | 用户与 RTC 服务器连接状态发生改变时,收到此回调。 |
| OnEngineWarningEventHandler | SDK 运行时出现了引擎相关的警告时,收到此回调。 |