NERtc Android SDK V5.6.30
载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
com.netease.lava.nertc.sdk.NERtcCallback接口 参考
类 com.netease.lava.nertc.sdk.NERtcCallback 继承关系图:
com.netease.lava.nertc.sdk.NERtcCallbackEx com.netease.lava.nertc.sdk.AbsNERtcCallbackEx

Public 成员函数

void onJoinChannel (int result, long channelId, long elapsed, long uid)
 
void onLeaveChannel (int result)
 
void onUserJoined (long uid)
 
void onUserJoined (long uid, NERtcUserJoinExtraInfo joinExtraInfo)
 
void onUserLeave (long uid, int reason)
 
void onUserLeave (long uid, int reason, NERtcUserLeaveExtraInfo leaveExtraInfo)
 
void onUserAudioStart (long uid)
 
void onUserAudioStop (long uid)
 
void onUserVideoStart (long uid, int maxProfile)
 
void onUserVideoStop (long uid)
 
void onDisconnect (int reason)
 
void onClientRoleChange (int oldRole, int newRole)
 

详细描述

NERtc 异步回调接口，用户需要实现该接口来完成对 NERtc 各种状态回调的处理。

成员函数说明

◆ onClientRoleChange()

void com.netease.lava.nertc.sdk.NERtcCallback.onClientRoleChange ( int oldRole,
int newRole )

直播场景下用户角色已切换回调。
用户加入房间后，通过 NERtcEx#setClientRole(int role) 切换用户角色后会触发此回调。例如从主播切换为观众、从观众切换为主播。
注意：
直播场景下，如果您在加入房间后调用该方法切换用户角色，调用成功后，会触发以下回调：

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onDisconnect()

void com.netease.lava.nertc.sdk.NERtcCallback.onDisconnect ( int reason)

与服务器连接中断，可能原因包括：网络连接失败、服务器关闭该房间、用户被踢出房间等。
注意：
SDK 在调用 joinChannel 加入房间成功后，如果和服务器失去连接，就会触发该回调。

参数
reason网络连接中断原因。详细信息请查看 NERtcConstants.ErrorCode。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onJoinChannel()

void com.netease.lava.nertc.sdk.NERtcCallback.onJoinChannel ( int result,
long channelId,
long elapsed,
long uid )

加入房间回调，表示客户端已经登入服务器。

参数
result0 表示加入房间成功；其他值表示加入房间失败，详细错误码请参考 NERtcConstants.ErrorCode。
channelId客户端加入的房间 ID。
elapsed从 joinChannel 开始到发生此事件过去的时间，单位为毫秒。
uid用户 ID。 如果在 joinChannel 方法中指定了 uid，此处会返回指定的 ID; 如果未指定 uid（joinChannel 时 uid=0），此处将返回云信服务器自动分配的 ID。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onLeaveChannel()

void com.netease.lava.nertc.sdk.NERtcCallback.onLeaveChannel ( int result)

退出房间回调。
App 调用 leaveChannel 方法后，SDK 提示 App 退出房间是否成功。

参数
result0 表示成功；其他值表示退出房间失败，错误码请参考 NERtcConstants.ErrorCode。 在快速切换房间时 code 为 NERtcConstants.ErrorCode::LEAVE_CHANNEL_FOR_SWITCH。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserAudioStart()

void com.netease.lava.nertc.sdk.NERtcCallback.onUserAudioStart ( long uid)

远端用户开启音频回调。

注解
该回调由远端用户调用 enableLocalAudio 方法开启音频采集和发送触发。
参数
uid远端用户 ID。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserAudioStop()

void com.netease.lava.nertc.sdk.NERtcCallback.onUserAudioStop ( long uid)

远端用户停用音频回调。

注解
该回调由远端用户调用 enableLocalAudio 方法关闭音频采集和发送触发。
参数
uid远端用户 ID。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserJoined() [1/2]

void com.netease.lava.nertc.sdk.NERtcCallback.onUserJoined ( long uid)

该回调在如下情况下会被触发：

  • 远端用户调用 joinChannel 方法加入房间。
  • 远端用户网络中断后重新加入房间。
    注解
    此回调与 NERtcCallback#onUserJoined(long, NERtcUserJoinExtraInfo)会同时回调，推荐使用后者，禁止同时处理 2 个回调。
    直播场景下：
    • 主播间能相互收到新主播加入频道的回调，并能获得该主播的用户 ID。
    • 观众也能收到新主播加入频道的回调，并能获得该主播的用户 ID。
    • 当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调。
    参数
    uid新加入房间的远端用户 ID。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserJoined() [2/2]

void com.netease.lava.nertc.sdk.NERtcCallback.onUserJoined ( long uid,
NERtcUserJoinExtraInfo joinExtraInfo )

远端用户加入房间事件回调。 远端用户加入房间或断网重连后，SDK 会触发该回调，可以通过返回的用户 ID 订阅对应用户发布的音、视频流。

  • 通信场景下，该回调通知有远端用户加入了房间，并返回新加入用户的 ID；若该用户加入之前，已有其他用户在房间中，该新加入的用户也会收到这些已有用户加入房间的回调。
  • 直播场景下，该回调通知有主播加入了房间，并返回该主播的用户 ID；若该用户加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入房间的回调。
    自从
    V4.6.29
    使用前提
    请在 NERtcCallback 或 NERtcCallbackEx 接口类中通过 NERtc#init() 接口设置回调监听。
    注解

同类型事件发生后，NERtcCallback#onUserJoined(long uid) 回调可能会与该回调同时触发，建议您仅注册此回调，不能同时处理两个回调。

  • 当 Web 端用户加入直播场景的房间中，只要该用户发布了媒体流，SDK 会默认该用户为主播，并触发此回调。
    参数说明
    参数名称 类型 描述
    uid long 新加入房间的远端用户 ID。
    joinExtraInfo NERtcUserJoinExtraInfo 该远端用户加入的额外信息。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserLeave() [1/2]

void com.netease.lava.nertc.sdk.NERtcCallback.onUserLeave ( long uid,
int reason )
弃用
推荐使用 NERtcCallback#onUserLeave(long, int, NERtcUserLeaveExtraInfo) 远端用户离开当前房间回调。
提示有远端用户离开了房间（或掉线）。
用户离开房间有两个原因，即正常离开和超时掉线：
  • 正常离开的时候，远端用户会收到消息提示，判断用户离开房间。
  • 超时掉线的依据是，在一定时间内（40~50s），用户没有收到对方的任何数据包，则判定为对方掉线。 note
参数
uid离开房间的远端用户 ID。
reason离开原因。
  • kNERtcSessionLeaveNormal(0)：正常离开。
  • kNERtcSessionLeaveForFailOver(1)：用户断线导致离开房间。
  • kNERTCSessionLeaveForUpdate(2)：用户因 Failover 导致离开房间，仅 SDK 内部使用。
  • kNERtcSessionLeaveForKick(3)：用户被踢导致离开房间。
  • kNERtcSessionLeaveTimeout(4)：用户超时退出房间。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserLeave() [2/2]

void com.netease.lava.nertc.sdk.NERtcCallback.onUserLeave ( long uid,
int reason,
NERtcUserLeaveExtraInfo leaveExtraInfo )

远端用户离开房间事件回调。

  • 远端用户离开房间或掉线（在 40 ~ 50 秒内本端用户未收到远端用户的任何数据包）后，SDK 会触发该回调。
    自从
    V4.6.29
    使用前提
    请在 NERtcCallback 接口类中通过 NERtc#init() 接口设置回调监听。
    注解
    同类型事件发生后，NERtcCallback#onUserLeave(long uid,int reason) 回调可能会与该回调同时触发，建议您仅注册此回调，不能同时处理两个回调。
    参数说明
    参数名称 类型 描述
    uid long 离开房间的远端用户 ID。
    reason int 该远端用户离开的原因，更多请参考 NERtcConstants.ErrorCode。
    • kNERtcSessionLeaveNormal（0）：正常离开。
    • kNERtcSessionLeaveForFailOver（1）：用户断线导致离开房间。
    • kNERTCSessionLeaveForUpdate（2）：用户因 Failover 导致离开房间，仅 SDK 内部使用。
    • kNERtcSessionLeaveForKick（3）：用户被踢导致离开房间。
    • kNERtcSessionLeaveTimeout（4）：用户超时退出房间。
    leaveExtraInfo NERtcUserLeaveExtraInfo 该远端用户离开的额外信息。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserVideoStart()

void com.netease.lava.nertc.sdk.NERtcCallback.onUserVideoStart ( long uid,
int maxProfile )

远端用户开启视频回调。
启用后，用户可以进行视频通话或直播。

参数
uid用户 ID，提示是哪个用户的视频流。
maxProfile视频编码配置，详细信息请参考 NERtcConstants.VideoProfile。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

◆ onUserVideoStop()

void com.netease.lava.nertc.sdk.NERtcCallback.onUserVideoStop ( long uid)

远端用户停用视频回调。
关闭后，用户只能进行语音通话或者直播。

参数
uid远端用户 ID。

在 com.netease.lava.nertc.sdk.AbsNERtcCallbackEx 内被实现.

该接口的文档由以下文件生成:
制作者 doxygen 1.10.0