本文介绍Android端直播推流SDK相关接口说明。
基础类
类 | 描述 | ||||||
AlivcLiveBase | 推流基础接口。 | ||||||
AlivcLivePusher | 推流功能类。 | ||||||
AlivcLivePushConfig | 推流初始配置。 | ||||||
AlivcLivePushErrorListener | 推流错误监听器。 | ||||||
AlivcLivePushNetworkListener | 推流网络监听器。 | ||||||
AlivcLivePushInfoListener | 推流通知监听器。 | ||||||
AlivcLiveBaseListener | 推流基础回调通知。 | ||||||
AlivcLivePushBGMListener | 推流播放通知监听器。 | ||||||
AlivcLivePlayer | 拉流抽象接口。 | ||||||
AlivcLivePlayConfig | 拉流初始配置。 | ||||||
AlivcLivePlayInfoListener | 拉流播放通知回调。 | ||||||
推流基础接口
AlivcLiveBase
API | 描述 | ||||||
getSDKVersion | 获取SDK版本号。 | ||||||
isSupportLiveMode | 判断SDK支持的推流模式。 | ||||||
registerSDK | SDK注册License。 | ||||||
setConsoleEnabled | 启用或禁用控制台日志打印。 | ||||||
setListener | 设置推流基础回调通知，用于异步接收License注册结果回调。 | ||||||
setLogDirPath | 设置日志路径及日志分片大小，确保路径存在，可写。 | ||||||
setLogLevel | 设置日志级别。 重要 开启全量ALL可能会增加App性能消耗。 | ||||||
推流接口
AlivcLivePusher
API | 描述 | ||||||
init | 初始化推流参数。 | ||||||
destroy | 释放推流。 | ||||||
startPreview | 开始预览（互动模式请调用传参FrameLayout的startPreview接口）。 | ||||||
startPreviewAysnc | 异步开始预览。 | ||||||
stopPreview | 结束预览。 | ||||||
startPush | 开始推流。 | ||||||
startPushAysnc | 异步开始推流。 | ||||||
restartPush | 重新开始推流。 | ||||||
restartPushAync | 异步重新开始推流。 | ||||||
reconnectPushAsync | 重新连接进行推流。 | ||||||
stopPush | 结束推流。 | ||||||
pause | 暂停推流。 | ||||||
resume | 恢复推流。 | ||||||
resumeAsync | 异步恢复推流。 | ||||||
switchCamera | 切换摄像头。 | ||||||
setAutoFocus | 设置自动对焦。 | ||||||
focusCameraAtAdjustedPoint | 对焦，对焦点的坐标x[0,屏幕宽度]，y[0,屏幕高度]。 | ||||||
setZoom | 设置缩放，[0,getMaxZoom()]。 | ||||||
getMaxZoom | 获取摄像头支持的最大缩放值。
| ||||||
getCurrentZoom | 获取当前缩放值。 | ||||||
setMute | 是否静音。 | ||||||
setFlash | 是否打开闪光灯。 | ||||||
setPushMirror | 推流镜像开关。 | ||||||
setPreviewMirror | 预览镜像开关。 | ||||||
setTargetVideoBitrate | 设置目标视频码率，取值范围[100,5000]，单位为Kbps。 | ||||||
setMinVideoBitrate | 设置最小视频码率，取值范围[100,5000]，单位为Kbps。 | ||||||
isCameraSupportAutoFocus | 获取是否支持自动对焦。 | ||||||
isCameraSupportFlash | 获取是否支持闪光灯。 | ||||||
isPushing | 是否正在推流。 | ||||||
isNetworkPushing | 获取当前网络推流状态。 | ||||||
setCustomDetect | 设置用户自定义视频人脸识别回调。 | ||||||
setCustomFilter | 设置用户自定义视频美颜回调。 | ||||||
setCustomAudioFilter | 设置用户自定义音频处理回调。 | ||||||
getCurrentStatus | 获取当前状态。 | ||||||
setLivePushErrorListener | 设置推流错误事件。 | ||||||
setLivePushInfoListener | 设置推流通知事件。 | ||||||
setLivePushNetworkListener | 设置网络通知事件。 | ||||||
setLivePushBGMListener | 设置背景播放通知事件。 | ||||||
setLivePushRenderContextListener | 设置render的context监听。 | ||||||
getLivePushStatsInfo | 获取推流统计数据。 | ||||||
getPushUrl | 获取推流URL。 | ||||||
setPreviewOrientation | 设置推流方向，默认竖屏。 | ||||||
setAudioEffectVoiceChangeMode | 设置变声音效模式。 | ||||||
setAudioEffectReverbMode | 设置混响音效模式。 | ||||||
startBGMAsync | 播放背景音乐。 | ||||||
stopBGMAsync | 停止播放背景音乐。 | ||||||
pauseBGM | 暂停播放背景音乐。 | ||||||
resumeBGM | 恢复播放背景音乐。 | ||||||
setBGMLoop | 设置背景音乐是否循环播放。 | ||||||
setBGMEarsBack | 设置耳返开关。 | ||||||
setBGMVolume | 设置背景音乐混音音乐音量。 | ||||||
setCaptureVolume | 设置背景音乐混音人声音量。 | ||||||
setAudioDenoise | 设置音频降噪。 | ||||||
startIntelligentDenoise | 开启音频智能降噪。 | ||||||
stopIntelligentDenoise | 关闭音频智能降噪。 | ||||||
setQualityMode | 设置视频质量模式。 | ||||||
setPreviewMode | 设置预览显示模式。 | ||||||
pauseScreenCapture | 暂停录屏推流（隐私开）。 | ||||||
resumeScreenCapture | 恢复录屏推流（隐私关）。 | ||||||
getLastError | 获取最近的错误值。 | ||||||
changeResolution | 动态调整分辨率。 | ||||||
addWaterMark | 添加水印。起点位置坐标x[0,width)，y[0,height)。宽度(0,width]，最多添加3个，需在startPreview之后调用。 | ||||||
setWatermarkVisible | 设置水印可见。 | ||||||
startCamera | 录屏模式下，开启摄像头预览。如果不需要预览，则surfaceview填为null。 | ||||||
stopCamera | 录屏模式下，关闭摄像头预览。 | ||||||
setScreenOrientation | 录屏模式下，设置感应的屏幕旋转角度。 | ||||||
startCameraMix | 录屏模式下，开启摄像头混流。 | ||||||
stopCameraMix | 录屏模式下，停止摄像头混流。 | ||||||
snapshot | 视频流截图。 | ||||||
inputStreamVideoPtr | 输入自定义视频流。 | ||||||
inputStreamVideoData | 输入自定义视频流。 | ||||||
inputStreamAudioPtr | 输入自定义音频流。 | ||||||
inputStreamAudioData | 输入自定义音频流。 | ||||||
addDynamicsAddons | 添加动态贴纸。 | ||||||
removeDynamicsAddons | 删除动态贴纸。 | ||||||
setExposure | 设置采集曝光。 | ||||||
getCurrentExposure | 获取采集曝光。 | ||||||
getSupportedMinExposure | 获取采集支持最小曝光。 | ||||||
getSupportedMaxExposure | 获取采集支持最大曝光。 | ||||||
sendMessage | 推流端发送SEI自定义消息。 | ||||||
setLiveMixTranscodingConfig | 设置云端的混流（转码）参数。 | ||||||
getLiveTraceId | 获取直播trace ID。 | ||||||
拉流相关接口
AlivcLivePlayer
此接口仅限互动模式下拉流使用。
API | 描述 | ||||||
setupWithConfig | 初始化拉流配置。 | ||||||
setPlayView | 设置播放View。 | ||||||
setPlayInfoListener | 设置拉流通知事件。 | ||||||
setPlayoutVolume | 设置播放音量。 | ||||||
startPlay | 开始播放音视频流。 | ||||||
stopPlay | 停止播放视频流。 | ||||||
pauseAudioPlaying | 暂停播放音频流。 | ||||||
pauseVideoPlaying | 暂停播放视频流。 | ||||||
resumeAudioPlaying | 恢复播放音频流。 | ||||||
resumeVideoPlaying | 恢复播放视频流。 | ||||||
destroy | 释放拉流。 | ||||||
getMode | 获取当前拉流模式。 | ||||||
回调接口
AlivcLiveBaseListener
API | 描述 | ||||||
onLicenceCheck | SDK Licence鉴权结果异步回调。 | ||||||
AlivcLivePushErrorListener
API | 描述 | ||||||
onSDKError | SDK错误回调。 | ||||||
onSystemError | 系统错误回调。 | ||||||
AlivcLivePushNetworkListener
API | 描述 | ||||||
onConnectFail | 连接失败。 | ||||||
onConnectionLost | 连接被断开。 | ||||||
onNetworkPoor | 网络差通知。 | ||||||
onNetworkRecovery | 网络恢复通知。 | ||||||
onPacketsLost | 推流过程丢包回调。 | ||||||
onPushURLAuthenticationOverdue | 鉴权过期。 | ||||||
onReconnectFail | 重连失败。 | ||||||
onReconnectStart | 重连开始。 | ||||||
onReconnectSucceed | 重连成功。 | ||||||
onSendDataTimeout | 发送数据超时。 | ||||||
onSendMessage | 发送sei。 | ||||||
AlivcLivePushInfoListener
API | 描述 | ||||||
onAdjustBitRate | 调整码率。 | ||||||
onAdjustFps | 调整帧率。 | ||||||
onDropFrame | 丢帧通知。 | ||||||
onFirstAVFramePushed | 发送第一个音视频包成功。 | ||||||
onFirstFramePreviewed | 首帧渲染通知。 | ||||||
onPreviewStarted | 预览开始事件。 | ||||||
onPreviewStoped | 预览结束事件。 | ||||||
onPushPaused | 推流暂停通知。 | ||||||
onPushRestarted | 推流重启通知。 | ||||||
onPushResumed | 推流恢复通知。 | ||||||
onPushStarted | 推流开始通知。 | ||||||
onPushStatistics | 直播推流器统计数据回调（每2秒回调一次）。 | ||||||
onPushStoped | 推流停止通知。 | ||||||
onSetLiveMixTranscodingConfig | 设置云端的混流（转码）参数回调。 | ||||||
AlivcLivePushBGMListener
API | 描述 | ||||||
onCompleted | 播放结束通知。 | ||||||
onDownloadTimeout | 播放器超时事件，播放器重连并且seek到播放位置。 | ||||||
onOpenFailed | 流无效通知，提示流不可访问。 | ||||||
onPaused | 播放暂停事件。 | ||||||
onProgress | 播放进度事件。 | ||||||
onResumed | 播放恢复事件。 | ||||||
onStarted | 播放开始事件。 | ||||||
onStoped | 播放停止事件。 | ||||||
AlivcLivePlayInfoListener
API | 描述 | ||||||
onError | 错误回调。 | ||||||
onFirstVideoFrameDrawn | 视频播放回调。 | ||||||
onPlayStarted | 开始播放回调。 | ||||||
onPlayStopped | 结束播放回调。 | ||||||