NERtc Android SDK  V4.6.0
Public 成员函数 | 所有成员列表
com.netease.lava.nertc.sdk.NERtcCallbackEx接口 参考
类 com.netease.lava.nertc.sdk.NERtcCallbackEx 继承关系图:
com.netease.lava.nertc.sdk.NERtcCallback com.netease.lava.nertc.sdk.AbsNERtcCallbackEx

Public 成员函数

void onUserSubStreamVideoStart (long uid, int maxProfile)
 
void onUserSubStreamVideoStop (long uid)
 
void onUserAudioMute (long uid, boolean muted)
 
void onUserVideoMute (long uid, boolean muted)
 
void onFirstAudioDataReceived (long uid)
 
void onFirstVideoDataReceived (long uid)
 
void onFirstAudioFrameDecoded (long userID)
 
void onFirstVideoFrameDecoded (long userID, int width, int height)
 
void onUserVideoProfileUpdate (long uid, int maxProfile)
 
void onAudioDeviceChanged (final int selected)
 
void onAudioDeviceStateChange (int deviceType, int deviceState)
 
void onVideoDeviceStageChange (int deviceState)
 
void onConnectionTypeChanged (int newConnectionType)
 
void onReconnectingStart ()
 
void onReJoinChannel (int result, long channelId)
 
void onAudioMixingStateChanged (int reason)
 
void onAudioMixingTimestampUpdate (long timestampMs)
 
void onAudioEffectFinished (int effectId)
 
void onLocalAudioVolumeIndication (int volume)
 
void onRemoteAudioVolumeIndication (NERtcAudioVolumeInfo[] volumeArray, int totalVolume)
 
void onLiveStreamState (String taskId, String pushUrl, int liveState)
 
void onConnectionStateChanged (int state, int reason)
 
void onCameraFocusChanged (Rect rect)
 
void onCameraExposureChanged (Rect rect)
 
void onRecvSEIMsg (long userID, String seiMsg)
 
void onAudioRecording (int code, String filePath)
 
void onError (int code)
 
void onWarning (int code)
 
void onMediaRelayStatesChange (int state, String channelName)
 
void onMediaRelayReceiveEvent (int event, int code, String channelName)
 
void onLocalPublishFallbackToAudioOnly (boolean isFallback, NERtcVideoStreamType streamType)
 
void onRemoteSubscribeFallbackToAudioOnly (long uid, boolean isFallback, NERtcVideoStreamType streamType)
 
void onLastmileQuality (int quality)
 
void onLastmileProbeResult (LastmileProbeResult result)
 
void onMediaRightChange (boolean isAudioBannedByServer, boolean isVideoBannedByServer)
 
- Public 成员函数 继承自 com.netease.lava.nertc.sdk.NERtcCallback
void onJoinChannel (int result, long channelId, long elapsed, long uid)
 
void onLeaveChannel (int result)
 
void onUserJoined (long uid)
 
void onUserLeave (long uid, int reason)
 
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)
 

详细描述

NERtcCallbackEx

成员函数说明

◆ onAudioDeviceChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioDeviceChanged ( final int  selected)

语音播放设备已改变回调。

参数
selected选择的设备,详细信息请参考 NERtcConstants.AudioDevice

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

◆ onAudioDeviceStateChange()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioDeviceStateChange ( int  deviceType,
int  deviceState 
)

音频设备状态已改变回调。

参数
deviceType设备类型。详细信息请参考 NERtcConstants.AudioDeviceType
deviceState设备状态。详细信息请参考 NERtcConstants.AudioDeviceState

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

◆ onAudioEffectFinished()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioEffectFinished ( int  effectId)


本地音效文件播放已结束回调。

参数
effectId指定音效的 ID。每个音效均有唯一的 ID

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

◆ onAudioMixingStateChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioMixingStateChanged ( int  reason)

本地用户的音乐文件播放状态改变回调。
调用 startAudioMixing 播放混音音乐文件后,当音乐文件的播放状态发生改变时,会触发该回调。

参数
reasonNERtcConstants.AudioMixingError#AUDIO_MIXING_FINISH 表示正常结束;其他状态码表示播放失败,详细信息请参考 NERtcConstants.AudioMixingError

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

◆ onAudioMixingTimestampUpdate()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioMixingTimestampUpdate ( long  timestampMs)

本地用户的音乐文件播放进度回调。
调用 startAudioMixing 播放混音音乐文件后,当音乐文件的播放进度改变时,会触发该回调。

参数
timestampMs音乐文件播放进度,单位为毫秒。

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

◆ onAudioRecording()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioRecording ( int  code,
String  filePath 
)

音频录制状态回调。

参数
code音频录制状态码。详细信息请参考 NERtcConstants.AudioRecordingCode
filePath音频录制文件保存路径。

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

◆ onCameraExposureChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onCameraExposureChanged ( Rect  rect)

摄像头曝光区域已改变回调。
该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。

参数
rect新的曝光区域位置。

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

◆ onCameraFocusChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onCameraFocusChanged ( Rect  rect)

摄像头对焦区域已改变回调。
该回调表示相机的对焦区域发生了改变。
该回调是由本地用户调用 setCameraFocusPosition 方法改变对焦位置触发的。

参数
rect新的对焦区域位置。

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

◆ onConnectionStateChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onConnectionStateChanged ( int  state,
int  reason 
)

房间连接状态已改变回调。
该回调在房间连接状态发生改变的时候触发,并告知用户当前的房间连接状态和引起房间状态改变的原因。

参数
state当前的房间连接状态。详细信息请参考 NERtcConstants.ConnectionState
reason引起当前房间连接状态发生改变的原因。详细信息请参考 NERtcConstants.ConnectionStateChangeReason

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

◆ onConnectionTypeChanged()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onConnectionTypeChanged ( int  newConnectionType)

本地网络类型已改变回调。
本地网络连接类型发生改变时,SDK 会触发该回调,并在回调中声明当前正在使用的网络连接类型。

参数
newConnectionType当前的本地网络类型,详细信息请参考 NERtcConstants.ConnectionType

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

◆ onError()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onError ( int  code)

发生错误回调。
该回调方法表示 SDK 运行时出现了网络或媒体相关的错误。
通常情况下,SDK上报的错误意味着 SDK 无法自动恢复,需要 App 干预或提示用户。

参数
codeNERtcConstants.RuntimeError

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

◆ onFirstAudioDataReceived()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstAudioDataReceived ( long  uid)

已接收到远端音频首帧回调。

参数
uid远端用户 ID,指定是哪个用户的音频流。

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

◆ onFirstAudioFrameDecoded()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstAudioFrameDecoded ( long  userID)

已解码远端音频首帧的回调。

参数
userID远端用户 ID,指定是哪个用户的音频流。

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

◆ onFirstVideoDataReceived()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoDataReceived ( long  uid)

已显示首帧远端视频回调。
第一帧远端视频显示在视图上时,触发此回调。

参数
uid远端用户 ID,指定是哪个用户的视频流。

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

◆ onFirstVideoFrameDecoded()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoFrameDecoded ( long  userID,
int  width,
int  height 
)

已显示首帧远端视频回调。
引擎收到第一帧远端视频流并解码成功时,触发此调用。 App 可在此回调中设置该用户的视频画布。

参数
userID远端用户 ID,指定是哪个用户的视频流。
width首帧视频宽,单位为 px。
height首帧视频高,单位为 px。

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

◆ onLastmileProbeResult()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLastmileProbeResult ( LastmileProbeResult  result)

通话前网络上下行 Last mile 质量探测报告回调。
该回调描述本地用户在加入房间前的 last mile 网络探测详细报告,报告中通过客观数据反馈上下行网络质量,包括网络抖动、丢包率等数据。您可以通过该回调客观预测本地用户在音视频通话中的网络状态。
在调用 startLastmileProbeTest 之后,SDK 会在约 30 秒内返回该回调。

自从
V4.5.0
参数
result上下行 Last mile 质量探测结果。详细信息请参考 LastmileProbeResult

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

◆ onLastmileQuality()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLastmileQuality ( int  quality)

通话前网络上下行 last mile 质量状态回调。
该回调描述本地用户在加入房间前的 last mile 网络探测的结果,以打分形式描述上下行网络质量的主观体验,您可以通过该回调预估本地用户在音视频通话中的网络体验。
在调用 startLastmileProbeTest 之后,SDK 会在约 5 秒内返回该回调。

自从
V4.5.0
参数
quality网络上下行质量,基于上下行网络的丢包率和抖动计算,探测结果主要反映上行网络的状态。
  • QUALITY_UNKNOWN(0):质量未知
  • QUALITY_EXCELLENT(1):质量极好
  • QUALITY_GOOD(2):用户主观感觉和极好差不多,但码率可能略低于极好
  • QUALITY_POOR(3):用户主观感受有瑕疵但不影响沟通
  • QUALITY_BAD(4):勉强能沟通但不顺畅
  • QUALITY_VBAD(5):网络质量非常差,基本不能沟通
  • QUALITY_DOWN(6):完全无法沟通

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

◆ onLiveStreamState()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLiveStreamState ( String  taskId,
String  pushUrl,
int  liveState 
)

推流状态已改变回调。

参数
taskId推流任务 ID。
pushUrl推流任务对应的 URL 地址。
liveState推流状态,详细信息请参考 NERtcConstants.LiveStreamState

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

◆ onLocalAudioVolumeIndication()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalAudioVolumeIndication ( int  volume)

提示房间内本地用户瞬时音量的回调。
该回调默认为关闭状态。可以通过 enableAudioVolumeIndication 方法开启。开启后,本地用户说话,SDK 会按 enableAudioVolumeIndication 方法中设置的时间间隔触发该回调。

参数
volume混音后的音量,范围为 0~100。

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

◆ onLocalPublishFallbackToAudioOnly()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalPublishFallbackToAudioOnly ( boolean  isFallback,
NERtcVideoStreamType  streamType 
)

本地发布流已回退为音频流、或已恢复为音视频流回调。 如果您调用了设置本地推流回退选项 setLocalPublishFallbackOption 接口,并将 option 设置为 AUDIO_ONLY 后,当上行网络环境不理想、本地发布的媒体流回退为音频流时,或当上行网络改善、媒体流恢复为音视频流时,会触发该回调。

自从
V4.3.0
参数
isFallback本地发布流已回退或已恢复。
  • true: 由于网络环境不理想,发布的媒体流已回退为音频流。
  • false: 由于网络环境改善,从音频流恢复为音视频流。
streamType对应的视频流类型,即主流或辅流。

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

◆ onMediaRelayReceiveEvent()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRelayReceiveEvent ( int  event,
int  code,
String  channelName 
)

跨房间媒体流转发状态发生改变回调。

参数
event当前媒体流转发事件。详细信息请参考 NERtcConstants.ChannelMediaRelayEvent
code当前跨房间媒体流转发状态。详细信息请参考 NERtcConstants.ChannelMediaRelayState
channelName媒体流转发的目标房间名。

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

◆ onMediaRelayStatesChange()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRelayStatesChange ( int  state,
String  channelName 
)

跨房间媒体流转发状态发生改变回调。

参数
state当前跨房间媒体流转发状态。详细信息请参考 NERtcConstants.ChannelMediaRelayState
channelName媒体流转发的目标房间名。

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

◆ onMediaRightChange()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRightChange ( boolean  isAudioBannedByServer,
boolean  isVideoBannedByServer 
)

服务端禁言音视频权限变化回调。

自从
v4.6.0
参数
isAudioBannedByServer是否禁用音频。
  • true:禁用音频。
  • false:取消禁用音频。
isVideoBannedByServer是否禁用视频。
  • true:禁用视频。
  • false:取消禁用视频。

◆ onReconnectingStart()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onReconnectingStart ( )

重连开始回调。
客户端和服务器断开连接时,SDK 会进行重连,重连开始时触发此回调。重连结果请参考 onReJoinChannel、onDisconnect。

参见
NERtcCallbackEx::onReJoinChannel(int, long)
NERtcCallbackEx::onDisconnect(int)

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

◆ onRecvSEIMsg()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRecvSEIMsg ( long  userID,
String  seiMsg 
)

收到远端流的 SEI 内容回调。
当远端成功发送 SEI 后,本端会收到此回调。

参数
userID发送 SEI 的用户 ID。
seiMsg对应用户的 SEI 信息。
参见
NERtcEx::sendSEIMsg(String)

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

◆ onReJoinChannel()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onReJoinChannel ( int  result,
long  channelId 
)

重新加入房间回调。
在弱网环境下,若客户端和服务器失去连接,SDK 会自动重连。自动重连成功后触发此回调方法。

参数
result0 成功;其他值表示重新加入失败,错误码请参考NERtcConstants.ErrorCode
channelId客户端加入的房间 ID。

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

◆ onRemoteAudioVolumeIndication()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRemoteAudioVolumeIndication ( NERtcAudioVolumeInfo[]  volumeArray,
int  totalVolume 
)

提示房间内谁正在说话及说话者瞬时音量的回调。
该回调默认为关闭状态。可以通过 enableAudioVolumeIndication 方法开启。开启后,无论房间内是否有人说话,SDK 都会按 enableAudioVolumeIndication 方法中设置的时间间隔触发该回调。
在返回的数组中:

  • 如果有 uid 出现在上次返回的数组中,但不在本次返回的数组中,则默认该 uid 对应的远端用户没有说话。
  • 如果 volume 为 0,表示该用户没有说话。
  • 如果数组为空,则表示此时远端没有人说话。
    参数
    volumeArray每个说话者的用户 ID 和音量信息的数组。详细信息请参考 stats.NERtcAudioVolumeInfo
    totalVolume混音后的总音量,取值范围为 0~100。

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

◆ onRemoteSubscribeFallbackToAudioOnly()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRemoteSubscribeFallbackToAudioOnly ( long  uid,
boolean  isFallback,
NERtcVideoStreamType  streamType 
)

订阅的远端流已回退为音频流、或已恢复为音视频流回调。
如果你调用了设置远端订阅流回退选项 setRemoteSubscribeFallbackOption 接口并将 option 设置 AUDIO_ONLY 后,当下行网络环境不理想、仅接收远端音频流时,或当下行网络改善、恢复订阅音视频流时,会触发该回调。

自从
V4.3.0
参数
uid远端用户的 ID。
isFallback远端订阅流已回退或恢复。
  • true: 由于网络环境不理想,订阅的远端流已回退为音频流。
  • false:由于网络环境改善,订阅的远端流从音频流恢复为音视频流。
streamType对应的视频流类型,即主流或辅流。

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

◆ onUserAudioMute()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserAudioMute ( long  uid,
boolean  muted 
)

远端用户暂停或恢复发送音频流的回调。

注解
该回调由远端用户调用 muteLocalAudioStream 方法开启或关闭音频发送触发。
参数
uid用户 ID,提示是哪个用户的音频流。
muted是否停止发送音频流。
  • true:该用户已暂停发送音频流。
  • false:该用户已恢复发送音频流。

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

◆ onUserSubStreamVideoStart()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamVideoStart ( long  uid,
int  maxProfile 
)

远端用户开启屏幕共享辅流通道的回调。

参数
uid远端用户 ID。
maxProfile远端视频分辨率等级。详细信息请参考 NERtcConstants.VideoProfile

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

◆ onUserSubStreamVideoStop()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamVideoStop ( long  uid)

远端用户停止屏幕共享辅流通道的回调。

参数
uid远端用户 ID。

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

◆ onUserVideoMute()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserVideoMute ( long  uid,
boolean  muted 
)

远端用户暂停或恢复发送视频流回调。

注解
当远端用户调用 muteLocalVideoStream 取消或者恢复发布视频流时,SDK会触发该回调向本地用户报告远程用户的发流状况。
参数
uid用户 ID,提示是哪个用户的视频流。
muted是否停止发送视频流。
  • true:该用户已暂停发送视频流。
  • false:该用户已恢复发送视频流。

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

◆ onUserVideoProfileUpdate()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserVideoProfileUpdate ( long  uid,
int  maxProfile 
)

远端用户视频编码配置已更新回调。

参数
uid远端用户 ID。
maxProfile视频编码配置,详细信息请参考 NERtcConstants.VideoProfile

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

◆ onVideoDeviceStageChange()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onVideoDeviceStageChange ( int  deviceState)

视频设备状态已改变回调。
该回调提示系统视频设备状态发生改变,比如被拔出或移除。如果设备已使用外接摄像头采集,外接摄像头被拔开后,视频会中断。

参数
deviceState设备状态。详细信息请参考 NERtcConstants.VideoDeviceState

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

◆ onWarning()

void com.netease.lava.nertc.sdk.NERtcCallbackEx.onWarning ( int  code)

发生警告回调。
该回调方法表示 SDK 运行时出现了网络或媒体相关的警告。
通常情况下,App 可以忽略 SDK 上报的警告信息,SDK 会自动恢复。

参数
code警告码。NERtcConstants.WarningCode

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


该接口的文档由以下文件生成: