NERtc Android SDK
V4.6.61
|
Public 成员函数 | |
void | onUserSubStreamVideoStart (long uid, int maxProfile) |
void | onUserSubStreamVideoStop (long uid) |
void | onUserAudioMute (long uid, boolean muted) |
void | onUserVideoMute (long uid, boolean muted) |
void | onUserVideoMute (NERtcVideoStreamType streamType, long uid, boolean muted) |
void | onLocalAudioFirstPacketSent (NERtcAudioStreamType audioStreamType) |
void | onFirstAudioDataReceived (long uid) |
void | onFirstVideoDataReceived (long uid) |
void | onFirstVideoDataReceived (NERtcVideoStreamType streamType, long uid) |
void | onFirstAudioFrameDecoded (long userID) |
void | onFirstVideoFrameDecoded (long userID, int width, int height) |
void | onFirstVideoFrameDecoded (NERtcVideoStreamType streamType, 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 | onAudioEffectTimestampUpdate (long id, long timestampMs) |
void | onAudioEffectFinished (int effectId) |
void | onLocalAudioVolumeIndication (int volume) |
void | onLocalAudioVolumeIndication (int volume, boolean vadFlag) |
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) |
void | onVirtualBackgroundSourceEnabled (boolean enabled, int reason) |
void | onUserSubStreamAudioStart (long uid) |
void | onUserSubStreamAudioStop (long uid) |
void | onUserSubStreamAudioMute (long uid, boolean muted) |
void | onPermissionKeyWillExpire () |
void | onUpdatePermissionKey (String key, int error, int timeout) |
void | onLocalVideoWatermarkState (NERtcVideoStreamType videoStreamType, int state) |
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 | 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) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioDeviceChanged | ( | final int | selected | ) |
语音播放设备已改变回调。
selected | 选择的设备,详细信息请参考 NERtcConstants.AudioDevice。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioDeviceStateChange | ( | int | deviceType, |
int | deviceState | ||
) |
音频设备状态已改变回调。
deviceType | 设备类型。详细信息请参考 NERtcConstants.AudioDeviceType。 |
deviceState | 设备状态。详细信息请参考 NERtcConstants.AudioDeviceState。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioEffectFinished | ( | int | effectId | ) |
本地音效文件播放已结束回调。
effectId | 指定音效的 ID。每个音效均有唯一的 ID |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioEffectTimestampUpdate | ( | long | id, |
long | timestampMs | ||
) |
本地用户的指定音效文件播放进度回调。
参数名称 | 类型 | 描述 |
---|---|---|
id | long | 指定音效文件的 ID。每个音效均有唯一的 ID。 |
timestampMs | long | 指定音效文件的当前播放进度。单位为毫秒。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioMixingStateChanged | ( | int | reason | ) |
本地用户的音乐文件播放状态改变回调。
调用 startAudioMixing 播放混音音乐文件后,当音乐文件的播放状态发生改变时,会触发该回调。
reason | NERtcConstants.AudioMixingError#AUDIO_MIXING_FINISH 表示正常结束;其他状态码表示播放失败,详细信息请参考 NERtcConstants.AudioMixingError。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioMixingTimestampUpdate | ( | long | timestampMs | ) |
本地用户的音乐文件播放进度回调。
调用 startAudioMixing 播放混音音乐文件后,当音乐文件的播放进度改变时,会触发该回调。
timestampMs | 音乐文件播放进度,单位为毫秒。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onAudioRecording | ( | int | code, |
String | filePath | ||
) |
音频录制状态回调。
code | 音频录制状态码。详细信息请参考 NERtcConstants.AudioRecordingCode。 |
filePath | 音频录制文件保存路径。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onCameraExposureChanged | ( | Rect | rect | ) |
摄像头曝光区域已改变回调。
该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。
rect | 新的曝光区域位置。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onCameraFocusChanged | ( | Rect | rect | ) |
摄像头对焦区域已改变回调。
该回调表示相机的对焦区域发生了改变。
该回调是由本地用户调用 setCameraFocusPosition 方法改变对焦位置触发的。
rect | 新的对焦区域位置。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onConnectionStateChanged | ( | int | state, |
int | reason | ||
) |
房间连接状态已改变回调。
该回调在房间连接状态发生改变的时候触发,并告知用户当前的房间连接状态和引起房间状态改变的原因。
state | 当前的房间连接状态。详细信息请参考 NERtcConstants.ConnectionState。 |
reason | 引起当前房间连接状态发生改变的原因。详细信息请参考 NERtcConstants.ConnectionStateChangeReason。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onConnectionTypeChanged | ( | int | newConnectionType | ) |
本地网络类型已改变回调。
本地网络连接类型发生改变时,SDK 会触发该回调,并在回调中声明当前正在使用的网络连接类型。
newConnectionType | 当前的本地网络类型,详细信息请参考 NERtcConstants.ConnectionType。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onError | ( | int | code | ) |
发生错误回调。
该回调方法表示 SDK 运行时出现了网络或媒体相关的错误。
通常情况下,SDK上报的错误意味着 SDK 无法自动恢复,需要 App 干预或提示用户。
code | NERtcConstants.RuntimeError |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstAudioDataReceived | ( | long | uid | ) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstAudioFrameDecoded | ( | long | userID | ) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoDataReceived | ( | long | uid | ) |
已显示远端视频首帧的回调。
第一帧远端视频显示在视图上时,触发此回调。
uid | 远端用户 ID,指定是哪个用户的视频流。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoDataReceived | ( | NERtcVideoStreamType | streamType, |
long | uid | ||
) |
已显示远端视频首帧的回调。
当远端视频的第一帧画面显示在视窗上时,会触发此回调。
参数名称 | 类型 | 描述 |
---|---|---|
type | video.NERtcVideoStreamType | 视频通道类型:
|
uid | long | 用户 ID,提示是哪个用户的视频流。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoFrameDecoded | ( | long | userID, |
int | width, | ||
int | height | ||
) |
已显示首帧远端视频回调。
引擎收到第一帧远端视频流并解码成功时,触发此调用。 App 可在此回调中设置该用户的视频画布。
userID | 远端用户 ID,指定是哪个用户的视频流。 |
width | 首帧视频宽,单位为 px。 |
height | 首帧视频高,单位为 px。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onFirstVideoFrameDecoded | ( | NERtcVideoStreamType | streamType, |
long | userID, | ||
int | width, | ||
int | height | ||
) |
已接收到远端视频首帧并完成解码的回调。
当 SDK 收到远端视频的第一帧并解码成功时,会触发该回调。应用层可在该回调中设置此用户的视频画布。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
userID | long | 用户 ID,提示是哪个用户的视频流。 |
width | int | 首帧视频的宽度,单位为 px。 |
height | int | 首帧视频的高度,单位为 px。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLastmileProbeResult | ( | LastmileProbeResult | result | ) |
通话前网络上下行 Last mile 质量探测报告回调。
该回调描述本地用户在加入房间前的 last mile 网络探测详细报告,报告中通过客观数据反馈上下行网络质量,包括网络抖动、丢包率等数据。您可以通过该回调客观预测本地用户在音视频通话中的网络状态。
在调用 startLastmileProbeTest 之后,SDK 会在约 30 秒内返回该回调。
result | 上下行 Last mile 质量探测结果。详细信息请参考 LastmileProbeResult。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLastmileQuality | ( | int | quality | ) |
通话前网络上下行 last mile 质量状态回调。
该回调描述本地用户在加入房间前的 last mile 网络探测的结果,以打分形式描述上下行网络质量的主观体验,您可以通过该回调预估本地用户在音视频通话中的网络体验。
在调用 startLastmileProbeTest 之后,SDK 会在约 5 秒内返回该回调。
quality | 网络上下行质量,基于上下行网络的丢包率和抖动计算,探测结果主要反映上行网络的状态。
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLiveStreamState | ( | String | taskId, |
String | pushUrl, | ||
int | liveState | ||
) |
推流状态已改变回调。
taskId | 推流任务 ID。 |
pushUrl | 推流任务对应的 URL 地址。 |
liveState | 推流状态,详细信息请参考 NERtcConstants.LiveStreamState。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalAudioFirstPacketSent | ( | NERtcAudioStreamType | audioStreamType | ) |
本地第一帧音频发送到远端的回调。
参数名称 | 类型 | 描述 |
---|---|---|
audioStreamType | see #NERtcAudioStreamType | 音频通道类型:
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalAudioVolumeIndication | ( | int | volume | ) |
提示房间内本地用户瞬时音量的回调。
该回调默认为关闭状态。可以通过 enableAudioVolumeIndication 方法开启。开启后,本地用户说话,SDK 会按 enableAudioVolumeIndication 方法中设置的时间间隔触发该回调。
volume | 混音后的音量,范围为 0~100。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalAudioVolumeIndication | ( | int | volume, |
boolean | vadFlag | ||
) |
提示房间内本地用户瞬时音量的回调。
该回调默认为关闭状态。可以通过 NERtcEx#enableAudioVolumeIndication(boolean enable, int interval, boolean enableVad) 方法开启;开启后,本地用户说话,SDK 会按该方法中设置的时间间隔触发该回调。
如果本地用户将自己静音(调用了 NERtcEx#muteLocalAudioStream(boolean mute)),SDK 将音量设置为 0 后回调给应用层。
volume | 混音后的音量,范围为 0 ~ 100。 |
vadFlag | 是否检测到人声。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalPublishFallbackToAudioOnly | ( | boolean | isFallback, |
NERtcVideoStreamType | streamType | ||
) |
本地发布流已回退为音频流、或已恢复为音视频流回调。 如果您调用了设置本地推流回退选项 setLocalPublishFallbackOption 接口,并将 option 设置为 AUDIO_ONLY 后,当上行网络环境不理想、本地发布的媒体流回退为音频流时,或当上行网络改善、媒体流恢复为音视频流时,会触发该回调。
isFallback | 本地发布流已回退或已恢复。
|
streamType | 对应的视频流类型,即主流或辅流。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onLocalVideoWatermarkState | ( | NERtcVideoStreamType | videoStreamType, |
int | state | ||
) |
本地视频水印生效结果回调。
videoStreamType | 对应的视频流类型,即主流或辅流。详细信息请参考 video.NERtcVideoStreamType。 |
state | 水印状态。详细信息请参考 NERtcConstants.NERtcLocalVideoWatermarkState。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRelayReceiveEvent | ( | int | event, |
int | code, | ||
String | channelName | ||
) |
跨房间媒体流转发状态发生改变回调。
event | 当前媒体流转发事件。详细信息请参考 NERtcConstants.ChannelMediaRelayEvent。 |
code | 相关错误码。详细信息请参考 NERtcConstants.ErrorCode。 |
channelName | 媒体流转发的目标房间名。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRelayStatesChange | ( | int | state, |
String | channelName | ||
) |
跨房间媒体流转发状态发生改变回调。
state | 当前跨房间媒体流转发状态。详细信息请参考 NERtcConstants.ChannelMediaRelayState。 |
channelName | 媒体流转发的目标房间名。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onMediaRightChange | ( | boolean | isAudioBannedByServer, |
boolean | isVideoBannedByServer | ||
) |
服务端禁言音视频权限变化回调。
isAudioBannedByServer | 是否禁用音频。
|
isVideoBannedByServer | 是否禁用视频。
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onPermissionKeyWillExpire | ( | ) |
权限密钥即将过期事件回调。
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onReconnectingStart | ( | ) |
重连开始回调。
客户端和服务器断开连接时,SDK 会进行重连,重连开始时触发此回调。重连结果请参考 onReJoinChannel、onDisconnect。
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRecvSEIMsg | ( | long | userID, |
String | seiMsg | ||
) |
收到远端流的 SEI 内容回调。
当远端成功发送 SEI 后,本端会收到此回调。
userID | 发送 SEI 的用户 ID。 |
seiMsg | 对应用户的 SEI 信息。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onReJoinChannel | ( | int | result, |
long | channelId | ||
) |
重新加入房间回调。
在弱网环境下,若客户端和服务器失去连接,SDK 会自动重连。自动重连成功后触发此回调方法。
result | 0 成功;其他值表示重新加入失败,错误码请参考NERtcConstants.ErrorCode。 |
channelId | 客户端加入的房间 ID。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRemoteAudioVolumeIndication | ( | NERtcAudioVolumeInfo[] | volumeArray, |
int | totalVolume | ||
) |
提示房间内谁正在说话及说话者瞬时音量的回调。
该回调默认为关闭状态。可以通过 enableAudioVolumeIndication 方法开启。开启后,无论房间内是否有人说话,SDK 都会按 enableAudioVolumeIndication 方法中设置的时间间隔触发该回调。
在返回的数组中:
volumeArray | 每个说话者的用户 ID 和音量信息的数组。详细信息请参考 stats.NERtcAudioVolumeInfo。 |
totalVolume | 混音后的总音量,取值范围为 0~100。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onRemoteSubscribeFallbackToAudioOnly | ( | long | uid, |
boolean | isFallback, | ||
NERtcVideoStreamType | streamType | ||
) |
订阅的远端流已回退为音频流、或已恢复为音视频流回调。
如果你调用了设置远端订阅流回退选项 setRemoteSubscribeFallbackOption 接口并将 option 设置 AUDIO_ONLY 后,当下行网络环境不理想、仅接收远端音频流时,或当下行网络改善、恢复订阅音视频流时,会触发该回调。
uid | 远端用户的 ID。 |
isFallback | 远端订阅流已回退或恢复。
|
streamType | 对应的视频流类型,即主流或辅流。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUpdatePermissionKey | ( | String | key, |
int | error, | ||
int | timeout | ||
) |
更新权限密钥事件回调。
参数名称 | 类型 | 描述 |
---|---|---|
key | String | 新的权限密钥。 |
error | int | 错误码。更多请参考 NERtcConstants.ErrorCode。
|
timeout | int | 更新后的权限密钥剩余有效时间。单位为秒。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserAudioMute | ( | long | uid, |
boolean | muted | ||
) |
远端用户暂停或恢复发送音频流的回调。
uid | 用户 ID,提示是哪个用户的音频流。 |
muted | 是否停止发送音频流。
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamAudioMute | ( | long | uid, |
boolean | muted | ||
) |
远端用户暂停或恢复发送音频辅流的回调。
uid | 用户 ID,提示是哪个用户的音频辅流。 |
muted | 是否停止发送音频辅流。
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamAudioStart | ( | long | uid | ) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamAudioStop | ( | long | uid | ) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamVideoStart | ( | long | uid, |
int | maxProfile | ||
) |
远端用户开启屏幕共享辅流通道的回调。
uid | 远端用户 ID。 |
maxProfile | 远端视频分辨率等级。详细信息请参考 NERtcConstants.VideoProfile。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserSubStreamVideoStop | ( | long | uid | ) |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserVideoMute | ( | long | uid, |
boolean | muted | ||
) |
远端用户暂停或恢复发送视频流回调。
当远端用户调用 muteLocalVideoStream 取消或者恢复发布视频流时,SDK会触发该回调向本地用户报告远程用户的发流状况。
uid | 用户 ID,提示是哪个用户的视频流。 |
muted | 是否停止发送视频流。
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserVideoMute | ( | NERtcVideoStreamType | streamType, |
long | uid, | ||
boolean | muted | ||
) |
远端用户暂停或恢复发送视频回调。
当远端用户调用 NERtcEx#muteLocalVideoStream(NERtcVideoStreamType streamType, boolean mute) 方法取消或者恢复发布视频流时,SDK 会触发该回调向本地用户通知远端用户的发流情况。
参数名称 | 类型 | 描述 |
---|---|---|
uid | long | 用户 ID,提示是哪个用户的视频流。 |
muted | boolean | 是否暂停发送视频流:
|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onUserVideoProfileUpdate | ( | long | uid, |
int | maxProfile | ||
) |
远端用户视频编码配置已更新回调。
uid | 远端用户 ID。 |
maxProfile | 视频编码配置,详细信息请参考 NERtcConstants.VideoProfile。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onVideoDeviceStageChange | ( | int | deviceState | ) |
视频设备状态已改变回调。
该回调提示系统视频设备状态发生改变,比如被拔出或移除。如果设备已使用外接摄像头采集,外接摄像头被拔开后,视频会中断。
deviceState | 设备状态。详细信息请参考 NERtcConstants.VideoDeviceState。 |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onVirtualBackgroundSourceEnabled | ( | boolean | enabled, |
int | reason | ||
) |
通知虚拟背景是否成功开启的回调。
调用 NERtcEx#enableVirtualBackground(boolean enabled, NERtcVirtualBackgroundSource backgroundSource) 接口启用虚拟背景功能后,SDK 会触发此回调。
enabled | 是否已成功开启虚拟背景。
|
reason | 虚拟背景开启出错的原因或开启成功的提示。 NERtcConstants.NERtcVirtualBackgroundSourceStateReason |
void com.netease.lava.nertc.sdk.NERtcCallbackEx.onWarning | ( | int | code | ) |
发生警告回调。
该回调方法表示 SDK 运行时出现了网络或媒体相关的警告。
通常情况下,App 可以忽略 SDK 上报的警告信息,SDK 会自动恢复。
code | 警告码。NERtcConstants.WarningCode |