互动视频
  • 平台类型
  • 框架 / 引擎

ZEGO Android API Reference

更新时间:2020-08-10 20:25

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。

基本功能方法

此分类下主要包括初始化 SDK 和基本音视频通信的方法,适用于语音通话、视频通话、语音/视频直播等应用场景。

基础功能

方法 描述
初始化 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
initSDK 初始化 App 相关信息
unInitSDK 释放 SDK 资源,停止各种系统监听
setUser 设置用户信息
setConfig 设置sdk配置信息
setSDKContext 设置 SDK 上下文,如日志路径、Application Context 等,同时检查 so 库是否成功加载
环境配置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
version 获取 SDK 版本信息
version2 获取 SDK 引擎版本信息
setVerbose 调试信息输出开关
setTestEnv 测试环境开关
SDK 日志 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
uploadLog 上传SDK日志
登录登出 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setZegoRoomCallback 设置房间回调接口
setRoomConfig 设置房间配置信息
setCustomToken 设置自定义token信息
loginRoom 登录房间
switchRoom 切换房间
logoutRoom 退出房间

推拉流功能

方法 描述
推流 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setZegoLiveEventCallback 设置直播事件回调接口
setZegoLivePublisherCallback 设置主播回调接口
setZegoLivePublisherCallback2 设置主播回调接口2,采集视频分辨率变化监听
setZegoLivePublisherExCallback 设置高级主播回调接口
startPublishing 开始推流
startPublishing2 开始推流,可推两路流
stopPublishing 停止推流
拉流 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setZegoLivePlayerCallback 设置观众回调接口
startPlayingStream 开始拉流
updatePlayView 更新播放流的View
stopPlayingStream 停止拉流
enableViewMirror 开启播放镜像.
takeSnapshotOfStream 截取观看直播view图像
推流基础配置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
requireHardwareEncoder 硬件编码开关
setAVConfig 设置推流配置
setAudioBitrate 设置音频码率
推流高级配置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
updateStreamExtraInfo 更新流的附加信息
setPublishConfig 设置推流参数
setPublishEncryptKey 设置推流加密密钥
addPublishTarget 添加转推地址
deletePublishTarget 删除转推地址
setVideoCaptureDeviceId 设置视频采集设备ID。 通过设置设备ID,可以切换视频采集设备
setVideoCodecId 设置选用分层编码
enableRateControl 码率控制开关
setLatencyMode 设置延迟模式
SetLatencyModeByChannel 按通道设置推流延迟模式
enablePreviewMirror 预览镜像开关
setVideoEncoderRateControlConfig 设置编码器码率控制策略
enableTrafficControl 流量控制(帧率、分辨率)开关
setAudioChannelCount 设置推流音频声道数
SetAudioChannelCountByChannel 按通道设置推流音频声道数
enableDTX 是否开启离散音频包发送
enableVAD 是否开启语音活动检测
setPublishQualityMonitorCycle 设置推流质量监控周期
pauseModule 暂停设备模块。 用于需要暂停指定模块的场合,例如来电时暂定音频模块; 暂停指定模块后,注意在合适时机下恢复模块
resumeModule 恢复设备模块。 用于需要恢复指定模块的场合,例如来电结束后恢复音频模块
setPreviewViewBackgroundColor 设置推流端预览控件的背景颜色
setChannelExtraParam 设置推流通道扩展参数
muteAudioPublish 推流时是否发送音频数据
muteVideoPublish 推流时是否发送视频数据
拉流基础配置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
requireHardwareDecoder 硬件解码开关
enableSpeaker 静音开关
setBuiltInSpeakerOn 内置扬声器开关
setPlayVolume 统一设置所有拉流的播放音量
setViewMode 设置用于拉流的View的播放模式
setViewRotation 设置播放渲染朝向
setViewBackgroundColor 设置拉流播放控件的背景颜色
拉流高级配置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setPlayStreamFocus 设置拉流优先级的权重,被置为 focus 的流,优先保证其质量
updatePlayDecryptKey 设置拉流解密密钥(只用于拉流之后更新密钥)
getMaxPlayChannelCount 获取最大拉流路数
enableCheckPoc 帧顺序检测开关
getSoundLevelOfStream 获取当前播放视频的音量
setPlayQualityMonitorCycle 设置拉流质量监控周期
activateAudioPlayStream 拉流是否接收音频数据
activateVideoPlayStream 拉流是否接收视频数据
视频采集设置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
enableCamera 摄像头开关
setFrontCam 切换前后摄像头
setCapturePipelineScaleMode 设置视频采集缩放时机
enableTorch 手电筒开关
setAppOrientation 设置app朝向
视频预览设置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setPreviewView 设置本地预览视频的View
startPreview 启动本地预览
stopPreview 结束本地预览
setPreviewViewMode 设置预览模式
setPreviewRotation 设置预览朝向
setVideoMirrorMode 是否启用预览和推流镜像
takePreviewSnapshot 获取预览截图
音频采集设置 以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中
setAudioDeviceMode 设置音频设备模式
enableMic 麦克风开关
enableMicDevice 设置是否允许SDK使用麦克风设备。调用时机为引擎创建后的任意时刻。接口由于涉及对设备的操作,极为耗时,不建议随便调用,只在真正需要让出麦克风给其他应用的时候才调用
setAECMode 设置回声消除模式
enableAEC 回声消除开关
enableAGC 音频采集自动增益开关
enableNoiseSuppress 音频采集噪声抑制开关
enableTransientNoiseSuppress 智能消噪,可消除键盘、敲桌子等瞬态噪音
setNoiseSuppressMode 设置音频采集降噪等级
enableAECWhenHeadsetDetected 耳机插入状态下是否使用回声消除
enableCaptureStereo 设置音频设备采集时是否开启双声道模式
enableLoopback 开启采集监听
setLoopbackVolume 设置采集监听音量
setCaptureVolume 设置采集音量
网络测速管理类 以下 API 位于 com.zego.zegoavkit2.networkprobe.ZegoNetWorkProbe 中
startUplinkSpeedTest 开始上行网络测速,InitSDK 后调用
setQualityCallbackInterval 设置刷新网络质量的时间间隔
stopUplinkSpeedTest 停止上行网络测速
startConnectivityTest 启动连通性测试,InitSDK 后调用
stopConnectivityTest 停止网络连通性测试
startDownlinkSpeedTest 开始下行网络测速,InitSDK 后调用
stopDownlinkSpeedTest 停止下行网络测速
网络探测管理类 以下 API 位于 com.zego.zegoavkit2.networktrace.ZegoNetworktrace 中
startNetworkTrace 开始网络trace测试
stopNetworkTrace 停止trace测试

IM

以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
setZegoIMCallback 设置 IM 回调接口,用于接收即时通信内容
setZegoRoomCallback 设置房间回调接口
sendRoomMessage 发送房间内广播消息
sendBigRoomMessage 发送房间内不可靠信道的广播消息,用于高并发情景下,服务端会根据高并发情况有策略的丢弃一些消息
自定义消息
sendCustomCommand 发送自定义消息

进阶功能方法

此分类下的方法主要包括了 Zego SDK 的特性,在基础的音视频通话基础上增加更丰富的功能,满足开发者的其它诉求,适用于语音通话、视频通话、互动直播、音视频录制等应用场景。

连麦

本组方法适用于互动直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
requestJoinLive 观众向主播请求连麦
respondJoinLiveReq 主播响应观众的"连麦请求"
inviteJoinLive 主播邀请观众连麦
respondInviteJoinLiveReq 观众响应主播的"连麦邀请"
endJoinLive 主播向连麦观众发送结束连麦信令

视频外部采集

本组方法为开发者提供自定义视频采集源的功能,适用于直播场景。

方法 描述
视频外部采集 以下 API 位于 com.zego.zegoavkit2.ZegoExternalVideoCapture 中
setVideoCaptureFactory 设置外部采集设备工厂
视频外部采集工厂 以下 API 位于 com.zego.zegoavkit2.ZegoVideoCaptureFactory 中
create 创建外部采集设备实例
destroy 销毁外部采集设备实例
视频外部采集设备 以下 API 位于 com.zego.zegoavkit2.ZegoVideoCaptureDevice 中
allocateAndStart 初始化采集使用的资源,例如启动线程,保存SDK传递的回调
stopAndDeAllocate 停止并且释放采集占用的资源,同时调用client的Destroy方法,这里的client指的是allocateAndStart传递的client
supportBufferType 获取采集数据的类型,SDK会根据此类型,使用对应的接口传输数据
startCapture 开启音频外部采集
stopCapture 关闭音频外部采集
setFrameRate 设置采集帧率
setResolution 设置采集分辨率,采集的分辨率最大不能超过1920 * 1080
setFrontCam 切换前后摄像头
setView 设置显示视频的view
setViewMode 设置用于拉流的View的播放模式
setViewRotation 设置播放渲染朝向
startPreview 启动本地预览
stopPreview 结束本地预览
takeSnapshot 对采集预览进行截图,完成后通过client的OnTakeSnapshot方法通知SDK
enableTorch 手电筒开关
setPowerlineFreq 设置采集刷新率
视频外部采集设备 Client 以下 API 位于 com.zego.zegoavkit2.ZegoVideoCaptureClient 中
destroy 通知SDK销毁采集回调
onError 出错回调
onByteBufferFrameCaptured 通知SDK采集到视频数据,SDK会同步拷贝数据,切换到内部线程进行编码,如果缓冲队列不够,SDK会自动丢帧
onEncodedFrameCaptured 向SDK传递视频编码数据
onTextureCaptured 向SDK传递视频画面的贴图
onTakeSnapshot 对采集预览进行截图的回调
setFillMode 设置填充模式
setFlipMode 设置翻转模式 supportBufferType为PIXEL_BUFFER_TYPE_GL_TEXTURE_2D 时才有效 默认值 ZegoVideoFlipMode.Vertical,如果不需要,设置为None
getSurfaceTexture 获取 SurfaceTexture
录屏工厂 以下 API 位于 com.zego.zegoavkit2.screencapture.ZegoScreenCaptureFactory 中
create 创建录屏采集设备
destroy 销毁录屏采集设备
setCaptureResolution 设置采集分辨率
setMediaProjection 设置MediaProjection

视频外部滤镜

本组方法为开发者提供可以自定义视频滤镜或者第三方视频滤镜的功能,适用于直播场景。

方法 描述
视频外部滤镜 以下 API 位于 com.zego.zegoavkit2.videofilter.ZegoExternalVideoFilter 中
setVideoFilterFactory 设置外部滤镜工厂
视频外部滤镜工厂 以下 API 位于 com.zego.zegoavkit2.videofilter.ZegoVideoFilterFactory 中
create 创建外部滤镜
destroy 销毁外部滤镜
滤镜设置 以下 API 位于 com.zego.zegoavkit2.videofilter.ZegoVideoFilter 中
allocateAndStart 初始化采集使用的资源(例如启动线程等)回调
stopAndDeAllocate 停止并且释放采集占用的资源
supportBufferType 获取滤镜处理类型,SDK会根据此类型,使用对应的接口传输数据
dequeueInputBuffer SDK 请求外部滤镜返回内存池的下标,进行内存拷贝
getInputBuffer 获取内存地址索引
queueInputBuffer 外部滤镜处理数据并返回给SDK
getSurfaceTexture 获取SurfaceTexture
onProcessCallback 同步处理视频帧数据
滤镜 Client 以下 API 位于 com.zego.zegoavkit2.videofilter.ZegoVideoFilterClient 中
destroy 销毁滤镜 client
dequeueInputBuffer SDK 请求外部滤镜返回内存池的下标,进行内存拷贝
getInputBuffer 获取内存地址索引
queueInputBuffer 外部滤镜处理数据并返回给SDK
getSurfaceTexture 获取SurfaceTexture
onProcessCallback 同步处理视频帧数

视频外部渲染

本组方法为开发者提供可以自处理视频渲染的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.videorender.ZegoExternalVideoRender 中。

方法 描述
setVideoRenderCallback 设置外部渲染回调
setVideoDecodeCallback 设置外部渲染回调
setVideoRenderType 设置开启外部渲染时要求 SDK 提供的数据格式
enableVideoPreview 是否开启外部视频渲染(推流)
enableVideoRender 是否开启外部视频渲染(拉流)

媒体播放器

以下 API 位于 com.zego.zegoavkit2.ZegoMediaPlayer 中。

方法 描述
setEventWithIndexCallback 设置播放回调监听
setVideoPlayWithIndexCallback 设置播放器视频帧数据回调
setAudioPlayCallback 获取音频数据回调监听
init 初始化媒体播放器
setVolume 设置音量
setPlayVolume 设置本地播放音量
setPublishVolume 设置推流音量
start 开始播放
stop 结束播放
pause 暂停播放
resume 恢复播放
enableAccurateSeek 设置是否开启精准搜索
setAccurateSeekTimeout 设置精确搜索的超时时间
setActiveAudioChannel 设置播放声道
setAudioChannelKeyShift 设置声道音调
seekTo 设置指定的进度进行播放
getDuration 获取整个文件的播放时长
getCurrentDuration 获取当前的播放时间
setView 设置显示视频的view
setAudioStream 设置播放媒体文件的音轨
setPlayerType 设置播放器类型
getAudioStreamCount 获取音轨个数
enableRepeatMode 设置是否循环播放
takeSnapshot 获取当前播放视频的截图
clearView 播放器清屏
setBackgroundColor 设置播放器的背景颜色
setViewMode 设置需要的播放器显示模式
uninit 反初始化媒体播放器
setOnlineResourceCache 设置网络素材最大的缓存时长和缓存数据大小, 以先达到者为准
setBufferThreshold 设置缓冲回调的阈值, 缓冲区可播放时长大于阈值时, 开始播放, 并回调 OnBufferEnd
GetOnlineResourceCacheStat 获取网络素材缓存队列的缓存数据可播放的时长和缓存数据大小
setLoadResourceTimeout 设置加载资源的超时时间

音效播放器

方法 描述
setCallback 设置音效播放器的回调
playEffect 播放音效
stopEffect 停止播放音效
pauseEffect 暂停播放音效
resumeEffect 恢复播放音效
setVolume 设置单个音效的音量
setVolumeAll 设置所有音效的音量
pauseAll 暂停全部音效
resumeAll 恢复全部音效
stopAll 停止全部音效
preloadEffect 预加载音效
unloadEffect 删除预加载音效
seekTo 设置进度
getDuration 获取音效的总时长
getCurrentDuration 获取音效的当前进度
destroyAudioPlayer 销毁音效播放器

媒体次要信息

本组方法为开发者提供在直播时同步其它信息的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.mediaside.ZegoMediaSideInfo 中。

方法 描述
setZegoMediaSideCallback 设置流媒体次要信息回调接口
setMediaSideFlags 发送媒体次要信息开关,支持 SEI
sendMediaSideInfo 发送媒体次要信息

音频外部采集与渲染

本组方法为开发者提供推流时采用自定义的音频数据及拉流时自渲染音频数据的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.audiodevice.ZegoExternalAudioDevice 中。

方法 描述
enableExternalAudioDevice 音频外部采集、渲染总开关
setAudioSrcForAuxiliaryPublishChannel 选择辅助推流通道的音频采集源
startCapture 开启音频外部采集
stopCapture 关闭音频外部采集
startRender 开启音频外部渲染
stopRender 关闭音频外部渲染
onRecordAudioFrame 发送外部采集数据
onPlaybackAudioFrame 获取sdk采集的数据,用于外部渲染

音频前处理设置

本组方法为开发者提供自处理 SDK 采集的音频数据的功能,适用于直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
setAudioPrepCallback 设置音频前处理回调。

音频后处理设置

本组方法为开发者提供自处理拉流的音频数据的功能,适用于直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
setAudioPostpCallback 设置音频后处理回调,并设置预处理参数。
enableAudioPostp 开启或关闭音频后处理功能

音频加解密设置

适用于直播场景。以下 API 位于 com.zego.zegoavkit2.audioencryptdecrypt.ZegoAudioEncryptDecrypt 中。

方法 描述
setAudioEncryptDecryptCallback 设置回调,接收音频数据进行加密或者解密后,再回传给sdk
enableAudioEncryptDecrypt 音频解密、解密开关

音频录制设置

适用于直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
setZegoAudioRecordCallback 设置音频录制回调接口
enableSelectedAudioRecord 开启音源回调,常用于音频录制

本地媒体录制

仅适用于推流或预览时的录制,不支持拉流时的音视频录制。以下 API 位于 com.zego.zegoavkit2.mediarecorder.ZegoMediaRecorder 中。

方法 描述
setZegoMediaRecordCallback 设置媒体录制回调
startRecord 开始录制
stopRecord 停止录制

自动混流音频

适用于直播场景。

方法 描述
setCallback 设置自动混流的事件回调
setSoundLevelCallback 设置自动混流中的发言者及其说话音量的回调通知
startAutoMixStream 开始自动混流
stopAutoMixStream 停止自动混流

混流设置

适用于直播场景。以下 API 位于 com.zego.zegoavkit2.mixstream.ZegoStreamMixer 中。

方法 描述
setMixStreamExCallback 设置对应 MixStreamEx 的回调
setSoundLevelInMixStreamCallback 设置接收混流中的音量信息的回调
mixStreamEx 混流接口,支持混流一路或者多路输出

混音设置

本组方法为开发者提供自处理 SDK 采集的音频数据的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.audioaux.ZegoAudioAux 中。

方法 描述
setZegoAuxCallbackEx 设置混音数据输入回调监听
enableAux 混音开关
muteAux 混音静音开关。 当设置为 true 后,主播听不到混音内容
setAuxVolume 设置混音音量
setAuxPublishVolume 设置混音推流音量
setAuxPlayVolume 设置混音本地播放音量

变声设置

适用于直播场景。以下 API 位于 com.zego.zegoavkit2.audioprocessing.ZegoAudioProcessing 中。

方法 描述
enableVirtualStereo 设置虚拟立体声。
enableReverb 设置音频混响。
setVoiceChangerParam 设置变声器参数。

美颜配置

本组方法为开发者提供调整美颜效果的功能,适用于直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
enableBeautifying 开启美颜
setPolishStep 设置美颜磨皮的采样步长
setPolishFactor 设置美颜采样颜色阈值
setWhitenFactor 设置美颜美白的亮度修正参数
setSharpenFactor 设置锐化参数
setFilter 设置滤镜

频域功率谱设置

本组方法为开发者提供获取直播音频在各频点的能量的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.frequencyspectrum.ZegoFrequencySpectrumMonitor 中。

方法 描述
setCallback 设置频域功率谱回调
getInstance 获取 ZegoFrequencySpectrumMonitor 监听实例,在整个应用生命周期有效
setCycle 设置频域功率谱的监控周期,该设置会影响回调频率
start 启动频域功率谱监听
stop 停止频域功率谱监听

音浪设置

本组方法为开发者提供获取直播音量的功能,适用于直播场景。以下 API 位于 com.zego.zegoavkit2.soundlevel.ZegoSoundLevelMonitor 中。

方法 描述
setCallback 设置音量回调
getInstance 获取 ZegoSoundLevelMonitor 监听实例,在整个应用生命周期有效
setCycle 设置 soundLevel 的监控周期
start 启动 soundLevel 监听
stop 停止 soundLevel 监听

水印设置

本组方法为开发者提供加入特定水印到直播画面中的功能,适用于直播场景。以下 API 位于 com.zego.zegoliveroom.ZegoLiveRoom 中。

方法 描述
setWaterMarkImagePath 设置水印图片的路径
setPublishWaterMarkRect 设置推流水印图片的位置
setPreviewWaterMarkRect 设置预览水印图片的位置

摄像头曝光设置

以下 API 位于 com.zego.zegoavkit2.camera.ZegoCamera 中。

方法 描述
setCamFocusMode 设置对焦模式
setCamExposureMode 设置曝光模式
setCamExposureCompensation 设置曝光补偿度
setCamFocusPoint 设置对焦位置
setCamFocusPointInPreview 设置预览视图中的对焦点
setCamExposurePointInPreview 设置预览视图中的曝光参考点
setCamZoomFactor 设置摄像头变焦倍数
getCamMaxZoomFactor 获取摄像头最大变焦倍数

基本功能回调

音视频引擎事件回调

方法 描述
setZegoAVEngineCallback 设置音视频引擎回调接口,位于 com.zego.zegoliveroom.ZegoLiveRoom 中
onAVEngineStop 音视频引擎停止时回调,位于 com.zego.zegoliveroom.callback.IZegoAVEngineCallback 中

设备事件回调

方法 描述
setZegoDeviceEventCallback 设置设备事件回调接口,位于 com.zego.zegoliveroom.ZegoLiveRoom 中
onDeviceError 设备出错回调,位于 com.zego.zegoliveroom.callback.IZegoDeviceEventCallback 中
onAudioRouteChange (音频路由)事件变化通知,当有耳机插拔、扬声器和听筒切换等音频路由变化时业务层可感知到,方便通知用户设备相关的变化
onNetTypeChange 网络状态回调,以根据回调的当前网络状态,提示用户网络状态的变化

基础功能事件回调

方法 描述
登录登出相关事件回调 以下 API 位于 com.zego.zegoliveroom.callback.IZegoRoomCallback 中
onKickOut 用户被踢出房间
onDisconnect 与 server 断开通知
onReconnect 与 server 重连成功通知
onTempBroken 与 server 连接中断通知,SDK会尝试自动重连
流更新事件回调 以下 API 位于 com.zego.zegoliveroom.callback.IZegoRoomCallback 中
onStreamUpdated 流信息更新
onStreamExtraInfoUpdated 流附加信息更新

推拉流功能事件回调

方法 描述
推流事件回调
onLiveEvent 直播事件回调,位于 com.zego.zegoliveroom.callback.IZegoLiveEventCallback 中
onPublishStateUpdate 推流状态更新,位于 com.zego.zegoliveroom.callback.IZegoLivePublisherCallback 中
onPublishQualityUpdate 推流质量更新,位于 com.zego.zegoliveroom.callback.IZegoLivePublisherCallback 中
onRelayCDNStateUpdate 转推CDN状态信息更新, 位于 com.zego.zegoliveroom.callback.IZegoLivePublisherExCallback 中
onCaptureAudioFirstFrame 采集音频的首帧通知
onCaptureVideoFirstFrame 采集视频的首帧通知
拉流事件回调 以下 API 位于 com.zego.zegoliveroom.callback.IZegoLivePlayerCallback 中
onPlayStateUpdate 播放流事件
onPlayQualityUpdate 观看质量更新
onVideoSizeChangedTo 视频宽高变化通知
视频采集事件回调
onCaptureVideoSizeChangedTo 采集视频的宽度和高度变化通知,位于 com.zego.zegoliveroom.callback.IZegoLivePublisherCallback 中
拉流事件回调2 以下 API 位于 com.zego.zegoliveroom.callback.IZegoLivePlayerCallback2,此接口继承于 com.zego.zegoliveroom.callback.IZegoLivePlayerCallback
onRenderRemoteVideoFirstFrame 所拉视频流的首帧渲染完成通知
onRemoteCameraStatusUpdate 所拉流的摄像头状态通知
onRemoteMicStatusUpdate 所拉流的麦克风状态通知
onRecvRemoteAudioFirstFrame 接收到所拉流的首帧音频的通知
onRecvRemoteVideoFirstFrame 接收到所拉流的首帧视频的通知

IM 事件回调

方法 描述
以下 API 位于 com.zego.zegoliveroom.callback.im.IZegoIMCallback 中
onRecvRoomMessage 收到房间的广播消息
onRecvBigRoomMessage 收到房间的不可靠消息广播
自定义消息事件回调 以下 API 位于 com.zego.zegoliveroom.callback.IZegoRoomCallback 中
onRecvCustomCommand 收到自定义消息
用户状态更新事件回调 以下 API 位于 com.zego.zegoliveroom.callback.im.IZegoIMCallback 中
onUserUpdate 用户状态更新通知
onUpdateOnlineCount 房间在线用户数量更新通知

进阶功能回调

连麦事件回调

方法 描述
onJoinLiveRequest 收到连麦请求,位于 com.zego.zegoliveroom.callback.IZegoLivePublisherCallback 中
onJoinLiveResponse 收到连麦请求结果,位于 com.zego.zegoliveroom.ZegoLiveRoom 中
onInviteJoinLiveRequest 收到主播端的邀请连麦请求,位于 com.zego.zegoliveroom.callback.IZegoLivePlayerCallback 中
onResponse 主播邀请连麦时观众的响应结果,或者观众请求连麦时主播的响应结果,位于 com.zego.zegoliveroom.callback.IZegoResponseCallback 中
onRecvEndJoinLiveCommand 收到结束连麦信令,位于 com.zego.zegoliveroom.callback.IZegoLivePlayerCallback 中
onEndJoinLive 主动结束连麦回调,位于com.zego.zegoliveroom.callback.IZegoEndJoinLiveCallback 中

媒体播放器事件回调

以下 API 位于 com.zego.zegoavkit2.IZegoMediaPlayerWithIndexCallback 中。

方法 描述
onPlayStart 开始播放
onPlayError 播放错误
onVideoBegin 视频开始播放(在支持视频播放后才生效)
onAudioBegin 音频开始播放
onPlayEnd 播放结束
onSeekComplete 完成快进到指定时刻
onPlayPause 暂停播放
onPlayResume 恢复播放
onPlayStop 用户主动停止播放的回调
onBufferBegin 网络音乐资源播放不畅,开始尝试缓存数据
onBufferEnd 网络音乐资源可以顺畅播放
onReadEOF 网络文件读完结尾的回调
onSnapshot 截图
onLoadComplete 预加载完成
onPlayVideoData 视频帧数据回调,位于 com.zego.zegoavkit2.IZegoMediaPlayerVideoPlayCallback 中

音效播放器事件回调

以下 API 位于 com.zego.zegoavkit2.audioplayer.IZegoAudioPlayerCallback 中。

方法 描述
onPlayEffect 播放音效结果通知
onPlayEnd 播放音效完成通知
onPreloadComplete 预加载音效完成通知
onPreloadEffect 预加载音效结果通知

媒体次要信息事件回调

以下 API 位于 com.zego.zegoavkit2.mediaside.IZegoMediaSideCallback 中。

方法 描述
onRecvMediaSideInfo 收到媒体次要信息

音频前处理事件回调

以下 API 位于 com.zego.zegoliveroom.callback.IZegoAudioPrepCallback2 中。

方法 描述
onAudioPrep 音频前处理回调通知

音频后处理事件回调

以下 API 位于 com.zego.zegoliveroom.callback.IZegoAudioPostpCallback 中。

方法 描述
onAudioPostp 音频后处理回调通知

音频加解密事件回调

以下 API 位于 com.zego.zegoavkit2.audioencryptdecrypt.IZegoAudioEncryptDecryptCallback 中。

方法 描述
onAudioEncryptDecrypt 音频加密、解密回调

音频录制事件回调

以下 API 位于 com.zego.zegoliveroom.callback.IZegoAudioRecordCallback2 中。

方法 描述
onAudioRecordCallback 音频录制回调

本地媒体录制事件回调

以下 API 位于 com.zego.zegoavkit2.mediarecorder.IZegoMediaRecordCallback 中。

方法 描述
onMediaRecord 媒体录制回调
onRecordStatusUpdate 录制信息更新回调

自动混流音频事件回调

以下 API 位于 com.zego.zegoavkit2.automixstream.IZegoAutoMixStreamCallback 中。

方法 描述
onStartAutoMixStream 启动自动混流结果通知
onStopAutoMixStream 停止自动混流结果通知
onSoundLevelInAutoMixStream 混流中的发言者及其说话音量信息的回调,是高频率同步回调,请勿在回调中处理耗时事务,位于 com.zego.zegoavkit2.automixstream.IZegoSoundLevelInAutoMixStreamCallback 中

混流事件回调

方法 描述
onMixStreamConfigUpdate 混流配置更新回调,位于 com.zego.zegoavkit2.mixstream.IZegoMixStreamExCallback
onMixStreamRelayCDNStateUpdate 混流转推CDN的状态回调,位于 com.zego.zegoavkit2.mixstream.IZegoMixStreamRelayCDNCallback 中
onSoundLevelInMixStream 混流音量回调,是同步回调,请勿在回调中处理事务,位于 com.zego.zegoavkit2.mixstream.IZegoSoundLevelInMixStreamCallback 中

混音事件回调

以下 API 位于 com.zego.zegoavkit2.audioaux.IZegoAudioAuxCallbackEx 中。

方法 描述
onAuxCallback 混音回调

频域功率谱设置事件回调

以下 API 位于 com.zego.zegoavkit2.frequencyspectrum.IZegoFrequencySpectrumCallback 中。

方法 描述
onCaptureFrequencySpectrumUpdate 获取采集的频域功率谱信息
onFrequencySpectrumUpdate 获取拉流的频域功率谱信息

音浪设置事件回调

以下 API 位于 com.zego.zegoavkit2.soundlevel.IZegoSoundLevelCallback 中。

方法 描述
onSoundLevelUpdate soundLevel 更新回调
onCaptureSoundLevelUpdate captureSoundLevel 更新回调