文档

直播推流接口说明

更新时间:

本文介绍Windows推流各版本接口说明。

接口说明

说明

windows推流SDK同时包含基础版推流功能与连麦互动推流功能。

详细接口说明,可参见Windows推流SDKv6.10.0接口说明,或查看SDK包中的API文档。

基础函数

API

描述

AlivcLiveBase

推流基础接口。

AlivcLivePusher

推流功能类。

AlivcLivePushConfig

推流初始配置。

AlivcLivePushErrorListener

推流错误监听器。

AlivcLivePushNetworkListener

推流网络监听器。

AlivcLivePushInfoListener

推流通知监听器。

AlivcLiveBaseListener

推流基础回调通知。

AlivcLivePlayer

拉流抽象接口。

AlivcLivePlayConfig

拉流初始配置。

AlivcLivePlayInfoListener

拉流播放通知回调。

推流基础接口

AlivcLiveBase

API

描述

GetSDKVersion

获取SDK版本号。

isSupportLiveMode

判断SDK支持的推流模式。

setConsoleEnabled

启用或禁用控制台日志打印。

setListener

设置推流基础回调通知,用于异步接收License注册结果回调。

SetLogDirPath

设置日志路径及日志分片大小,确保路径存在,可写。

SetLogLevel

设置日志级别。

重要

说明

开启全量ALL可能会增加App性能消耗。

推流接口

AlivcLivePusher

API

描述

init

初始化推流参数。

destroy

释放推流。

startPreview

开始预览(互动模式请调用传参FrameLayout的startPreview接口)。

startPreviewAysnc

异步开始预览。

stopPreview

结束预览。

startPush

开始推流。

startPushAysnc

异步开始推流。

stopPush

结束推流。

setMute

是否静音。

setTargetVideoBitrate

设置目标视频码率,取值范围[100,5000],单位为Kbps。

setMinVideoBitrate

设置最小视频码率,取值范围[100,5000],单位为Kbps。

setLivePushErrorListener

设置推流错误事件。

setLivePushInfoListener

设置推流通知事件。

setLivePushNetworkListener

设置网络通知事件。

startCamera

录屏模式下,开启摄像头预览。如果不需要预览,则surfaceview填为null。

stopCamera

录屏模式下,关闭摄像头预览。

setLiveMixTranscodingConfig

设置云端的混流(转码)参数。

拉流相关接口

AlivcLivePlayer

说明

此接口仅限互动模式下拉流使用。

API

描述

setupWithConfig

初始化拉流配置。

setPlayView

设置播放View。

setPlayInfoListener

设置拉流通知事件。

setRemoteAudioVolume

设置播放音量。

startPlay

开始播放音视频流。

stopPlay

停止播放视频流。

destroy

释放拉流。

getMode

获取当前拉流模式。

回调接口

AlivcLivePushErrorListener

API

描述

onSDKError

SDK错误回调。

onSystemError

系统错误回调。

AlivcLivePushNetworkListener

API

描述

onConnectFail

连接失败。

onConnectionLost

连接被断开。

onNetworkPoor

网络差通知。

onNetworkRecovery

网络恢复通知。

onPacketsLost

推流过程丢包回调。

onPushURLAuthenticationOverdue

鉴权过期。

onReconnectFail

重连失败。

onReconnectStart

重连开始。

onReconnectSucceed

重连成功。

onSendDataTimeout

发送数据超时。

onSendMessage

发送sei。

AlivcLivePushInfoListener

API

描述

onFirstFramePreviewed

首帧渲染通知。

onPreviewStarted

预览开始事件。

onPreviewStopped

预览结束事件。

onPushPaused

推流暂停通知。

onPushStarted

推流开始通知。

onLocalVideoStats

本地视频统计信息(每2秒回调一次)。

onLocalAudioStats

本地音频统计信息(每2秒回调一次)。

onPushStopped

推流停止通知。

onSetLiveMixTranscodingConfig

设置云端的混流(转码)参数回调。

AlivcLivePlayInfoListener

API

描述

onError

错误回调。

onFirstVideoFrameDrawn

视频播放回调。

onPlayStarted

开始播放回调。

onPlayStopped

结束播放回调。