本文介紹直播推流Android SDK相關接口說明。
接口說明
互動版
您可以查看最新版API文檔，也可以點擊鏈接可查看對應版本的API文檔，或查看SDK包中的API文檔。
基礎版
您可以查看最新版API文檔，也可以點擊鏈接可查看對應版本的API文檔，或查看SDK包中的API文檔。
基礎函數
API | 描述 | ||||||
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 | 描述 | ||||||
onLicenseCheck | SDK License鑒權結果異步回調。 | ||||||
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 | 預覽開始事件。 | ||||||
onPreviewStopped | 預覽結束事件。 | ||||||
onPushPaused | 推流暫停通知。 | ||||||
onPushRestarted | 推流重啟通知。 | ||||||
onPushResumed | 推流恢復通知。 | ||||||
onPushStarted | 推流開始通知。 | ||||||
onPushStatistics | 直播推流器統計數據回調（每2秒回調一次）。 | ||||||
onPushStopped | 推流停止通知。 | ||||||
onSetLiveMixTranscodingConfig | 設置云端的混流（轉碼）參數回調。 | ||||||
AlivcLivePushBGMListener
API | 描述 | ||||||
onCompleted | 播放結束通知。 | ||||||
onDownloadTimeout | 播放器超時事件，播放器重連并且seek到播放位置。 | ||||||
onOpenFailed | 流無效通知，提示流不可訪問。 | ||||||
onPaused | 播放暫停事件。 | ||||||
onProgress | 播放進度事件。 | ||||||
onResumed | 播放恢復事件。 | ||||||
onStarted | 播放開始事件。 | ||||||
onStopped | 播放停止事件。 | ||||||
AlivcLivePlayInfoListener
API | 描述 | ||||||
onError | 錯誤回調。 | ||||||
onFirstVideoFrameDrawn | 視頻播放回調。 | ||||||
onPlayStarted | 開始播放回調。 | ||||||
onPlayStopped | 結束播放回調。 | ||||||