本文介紹直播推流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 | 設定使用者自訂視頻Face Service回調。 | ||||||
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 | 結束播放回調。 |