全部產品
Search
文件中心

ApsaraVideo Live:直播推流介面說明

更新時間:Jul 20, 2024

本文介紹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

結束播放回調。