Public Callback

函数

函数说明

OnJoinRoomResultEventHandler

public delegate void GameRTC.OnJoinRoomResultEventHandler(
    string roomID,
    string userID,
    JoinRoomErrorCode errorCode,
    bool isRejoined,
    int elapsed)

用户首次成功加入房间/重连进房后，收到此回调。

传入参数

OnLeaveRoomEventHandler

public delegate void GameRTC.OnLeaveRoomEventHandler(
    string roomID)

离开房间成功回调
用户调用 LeaveRoom 方法后，SDK 会停止所有的发布订阅流，并释放所有通话相关的音视频资源。SDK 完成所有的资源释放后，用户收到此回调。

传入参数

注意

• 离开房间结束通话后，如果 App 需要使用系统音视频设备，建议在收到此回调后再初始化音视频设备，否则可能由于被 SDK 占用而导致 App 初始化音视频设备失败。
• 用户调用 LeaveRoom 方法离开房间后，如果立即调用 Release 方法销毁 GameRTC 引擎，则将无法收到此回调事件。

OnUserJoinedEventHandler

public delegate void GameRTC.OnUserJoinedEventHandler(
    string roomID,
    string userID)

远端用户加入房间回调。
以下情形下，本地用户会收到此回调：

• 远端用户首次加入房间/重连加入房间；
  
• 本地用户加入房间时，会收到回调，提示已在房间中的远端用户。

传入参数

OnUserLeaveEventHandler

public delegate void GameRTC.OnUserLeaveEventHandler(
    string roomID,
    string userID,
    UserLeaveReasonType reason)

远端用户离开房间回调。
房间中有用户主动调用 LeaveRoom 方法离开房间或断线超时离开房间时，房间中其他用户都会收到此回调。

传入参数

OnMicrophoneEnabledEventHandler

public delegate void GameRTC.OnMicrophoneEnabledEventHandler(
    string roomID,
    string userID,
    bool enable)

远端用户开关麦克风回调。
当用户调用 EnableMicrophone 更改本地音频采集和发布状态时，房间内其他用户会收到此回调。

传入参数

OnAudioSendEnabledEventHandler

public delegate void GameRTC.OnAudioSendEnabledEventHandler(
    string roomID,
    string userID,
    bool enable)

远端用户启停音频数据发送的回调。
当用户调用 EnableAudioSend 更改本地音频发送状态时，房间内其他用户会收到此回调。

传入参数

OnSpeakerphoneEnabledEventHandler

public delegate void GameRTC.OnSpeakerphoneEnabledEventHandler(
    string roomID,
    string userID,
    bool enable)

远端用户启停音频数据接收的回调。
当用户调用 EnableSpeakerphone 更改远端音频接收状态时，房间内其他用户会收到此回调。

传入参数

OnAudioVolumeIndicationEventHandler

public delegate void GameRTC.OnAudioVolumeIndicationEventHandler(
    string roomID,
    List<GameRTCAudioVolumeInfo> speakers,
    int totalVolume)

提示本地采集的音量信息和在房间内订阅的远端用户的音量信息。
本回调默认不开启。你可以通过 GameRTCRoomConfig.AudioVolumeIndicationIntervalGameRTCRoomConfig 开启。

传入参数

注意

• 对于本地用户：只要进行本地音频采集，回调内就会包含本地音频流的音量信息。
• 对于远端用户：本地必须订阅某远端用户的音频流，回调内才会包含其发送的音频流的音量信息。

OnNetworkQualityEventHandler

public delegate void GameRTC.OnNetworkQualityEventHandler(
    string roomID,
    string userID,
    NetworkQuality txQuality,
    NetworkQuality rxQuality)

通话中用户的媒体流网络上下行质量报告回调。加入房间成功后，每隔 2 秒会收到此回调，通知房间内用户与媒体服务器之间数据交互的网络质量。

传入参数

注意

• 当 userId 为本地用户 ID 时，txQuality 为该用户的上行网络质量，rxQuality 为该用户的下行网络质量。
• 当 userId 为远端用户 ID 时，目前仅支持获取该用户的上行网络质量 txQuality，下行网络质量 rxQuality 为 0 。

OnConnectionStateChangedEventHandler

public delegate void GameRTC.OnConnectionStateChangedEventHandler(
    ConnectionState state)

用户与 RTC 服务器连接状态发生改变时，收到此回调。

传入参数

OnRoomWarningEventHandler

public delegate void GameRTC.OnRoomWarningEventHandler(
    string roomID,
    RoomWarnCode code)

SDK 运行时，出现房间相关警告，收到此回调。

传入参数

注意 通常情况下，SDK 上报的警告信息可以忽略，SDK 能够自动恢复。

OnRoomErrorEventHandler

public delegate void GameRTC.OnRoomErrorEventHandler(
    string roomID,
    RoomErrorCode code)

房间相关错误回调。

传入参数

OnEngineWarningEventHandler

public delegate void GameRTC.OnEngineWarningEventHandler(
    EngineWarnCode code)

SDK 运行时出现了引擎相关的警告时，收到此回调。

传入参数

注意 通常情况下，SDK 上报的警告信息可以忽略，SDK 能够自动恢复。