Flutter推流SDK支援的介面 - ApsaraVideo Live

本文為您介紹Flutter推流SDK相關的介面詳情。

背景資訊

更多關於介面的資訊，請參見LIBRARIES。

基礎函數

API	dart	說明
AlivcLiveBase	live_base.dart	推流基礎介面。
AlivcLivePusherConfig	live_push_config.dart	推流配置介面。
AlivcLivePusher	live_pusher.dart	推流引擎配置介面。
AlivcPusherPreview	live_pusher_preview.dart	推流預覽視圖控制項。
-	live_push_def.dart	推流參數定義類。

推流基礎介面

AlivcLiveBase

API	說明
init	建立AlivcLiveBase執行個體。
getSdkVersion	擷取SDK版本號碼。
setObserver	設定監聽回調介面。
setLogLevel	設定Log層級。
setConsoleEnable	啟用或禁用控制台日誌列印。
setLogPath	設定Log路徑。
registerSDK	註冊SDK。
setOnLicenceCheck	SDK Licence校正介面回調。監聽setObserver回調。

推流配置介面

AlivcLivePusherConfig

API	說明
init	建立AlivcLivePusherConfig執行個體。
setResolution	設定解析度。
getResolution	擷取解析度。
setEnableAutoBitrate	設定碼率自適應。
getEnableAutoBitrate	擷取碼率自適應。
setEnableAutoResolution	設定解析度自適應。
getEnableAutoResolution	擷取解析度自適應。
setQualityMode	設定碼率模式。
getQualityMode	擷取碼率模式。
setTargetVideoBitrate	設定目標視頻編碼碼率。
getTargetVideoBitrate	擷取目標視頻編碼碼率。
setMinVideoBitrate	設定最小視頻編碼碼率。
getMinVideoBitrate	擷取最小視頻編碼碼率。
setInitialVideoBitrate	設定初始視頻編碼碼率。
getInitialVideoBitrate	擷取初始視頻編碼碼率。
setAudioBitrate	設定音頻編碼碼率。
getAudioBitrate	擷取音頻編碼碼率。
setAudioSampleRate	設定音頻採樣率。
getAudioSampleRate	擷取音頻採樣率。
setFps	設定視頻採集幀率。
getFps	擷取視頻採集幀率。
setMinFps	設定最小視頻採集幀率。
getMinFps	擷取最小視頻採集幀率。
setVideoEncodeGop	設定主要畫面格間隔。
getVideoEncodeGop	擷取主要畫面格間隔。
setAudioEncoderProfile	設定音頻編碼格式。
getAudioEncoderProfile	擷取音頻編碼格式。
setAudioChannel	設定聲道數。
getAudioChannel	擷取聲道數。
setAudioOnly	設定是否純音頻推流。
getAudioOnly	擷取是否純音頻推流。
setVideoOnly	設定是否純視頻推流。
getVideoOnly	擷取是否純視頻推流。
setAudioEncoderMode	設定音頻編碼模式。
getAudioEncoderMode	擷取音頻編碼模式。
setVideoEncoderMode	設定視頻編碼模式。
getVideoEncoderMode	擷取視頻編碼模式。
setVideoHardEncoderCodec	設定視頻寫入程式碼方式。
getVideoHardEncoderCodec	擷取視頻寫入程式碼方式。
setOpenBFrame	設定視頻硬編模式下是否開啟B幀。
getOpenBFrame	擷取視頻硬編模式下是否開啟B幀。
setOrientation	設定推流方向。
getOrientation	擷取推流方向。
setPreviewDisplayMode	設定預覽顯示模式。
getPreviewDisplayMode	擷取預覽顯示模式。
setConnectRetryInterval	設定重連時間長度。
getConnectRetryInterval	擷取重連時間長度。
setConnectRetryCount	設定重連次數。
getConnectRetryCount	擷取重連次數。
setPushMirror	設定推流鏡像。
getPushMirror	擷取推流鏡像。
setPreviewMirror	設定預覽鏡像。
getPreviewMirror	擷取預覽鏡像。
setCameraType	設定網路攝影機類型。
getCameraType	擷取網路攝影機類型。
setAutoFocus	設定自動聚焦。
getAutoFocus	擷取自動聚焦。
setPauseImg	設定暫停推流圖片。
setNetworkPoorImg	設定碼率低圖片。
setExternAudioFormat	設定外部自訂音頻資料。
getExternAudioFormat	擷取外部自訂音頻資料。
setExternVideoFormat	設定外部自訂視頻資料。
getExternVideoFormat	擷取外部自訂視頻資料。
setAudioScene	設定音頻應用情境。
getAudioScene	擷取音頻應用情境。
setExternMainStream	是否外部自訂資料推流。
getExternMainStream	擷取是否外部自訂資料推流。

推流引擎配置介面

AlivcLivePusher

API	說明
init	建立AlivcLivePusher執行個體。
createConfig	建立Config，將AlivcLivePusherConfig和AlivcLivePusher聯絡起來。
initLivePusher	建立一個推流引擎執行個體。
setErrorDelegate	設定推流錯誤監聽回調。
setInfoDelegate	設定推流狀態監聽回調。
setNetworkDelegate	設定推流網路監聽回調。
setBGMDelegate	設定背景音樂監聽回調。
startPreview	開始預覽，同步介面。
startPreviewAsync	開始預覽，非同步介面。
startPushWithURL	開始推流，同步介面。
startPushWithURLAsync	開始推流，非同步介面。
stopPreview	停止預覽。
stopPush	停止推流。
restartPush	重新推流，同步介面。
restartPushAsync	重新推流，非同步介面。
pause	暫停網路攝影機推流。
resume	恢複網路攝影機推流，同步介面。
resumeAsync	恢複推流，非同步介面。
switchCamera	切換網路攝影機。
reconnectPushAsync	重連，非同步介面。
reconnectPushAsyncWithPushURL	推流URL的重連，非同步介面。
destroy	銷毀推流引擎。
destroyConfigForIOS	iOS系統下重設Config。iOS系統執行此方法，在不使用AlivcLivePusherConfig的時候，及時清理設定的Config屬性方法。
setAutoFocus	設定自動對焦。
focusCameraAtAdjustedPoint	對焦。
setZoom	縮放。
getMaxZoom	擷取支援的最大變焦值。
getCurrentZoom	擷取當前變焦值。
setFlash	閃光燈開關。
setExposure	設定曝光度。
getCurrentExposure	擷取當前曝光度。
getSupportedMinExposure	擷取支援最小曝光度。
getSupportedMaxExposure	擷取支援最大曝光度。
setPushMirror	推流鏡像開關。
setPreviewMirror	預覽鏡像開關。
setMute	靜音推流。
setQualityMode	設定推流模式。
setTargetVideoBitrate	設定目標碼率。
setMinVideoBitrate	設定最小碼率。
setPreviewDisplayMode	設定預覽顯示模式。
setResolution	設定推流解析度。只在預覽模式下生效，推流中不能設定。
startBGMWithMusicPathAsync	播放背景音樂。
stopBGMAsync	停止播放背景音樂。
pauseBGM	暫停播放背景音樂。
resumeBGM	恢複播放背景音樂。
setBGMLoop	設定背景音樂是否迴圈播放。
setBGMEarsBack	設定背景音樂耳返開關。
setAudioDenoise	設定降噪開關。
setAudioEffectVoiceChangeMode	設定變聲音效模式。
setAudioEffectReverbMode	設定混響音效模式。
setBGMVolume	設定背景音樂混音，音樂音量。
setCaptureVolume	設定背景音樂混音，人聲音量。
sendMessage	設定自訂Message（SEI）。
isPushing	擷取是否正在推流。
getPushURL	擷取當前推流URL。
getLiveStatus	擷取當前推流狀態。
addWatermark	添加浮水印。
setWatermarkVisible	設定浮水印顯示和隱藏。
addDynamicWaterMarkImageData	添加動態貼紙。
removeDynamicWaterMark	刪除動態貼紙。
snapshot	截圖。
setSnapshotDelegate	設定截圖監聽回調，需要在調用snapshot後調用。
sendVideoData	發送自訂視頻資料。
sendPCMData	發送自訂音頻資料。
setOnSDKError	SDK錯誤回調，監聽setErrorDelegate回調。
setOnSystemError	系統錯誤回調，監聽setErrorDelegate回調。
setOnPreviewStarted	開始預覽回調，監聽setInfoDelegate回調。
setOnPreviewStoped	停止預覽回調，監聽setInfoDelegate回調。
setOnFirstFramePreviewed	渲染第一幀回調，監聽setInfoDelegate回調。
setOnPushStarted	推流開始回調，監聽setInfoDelegate回調。
setOnPushPaused	網路攝影機推流暫停回調。監聽setInfoDelegate回調。
setOnPushResumed	網路攝影機推流恢複回調，監聽setInfoDelegate回調。
setOnPushRestart	重新推流回調，監聽setInfoDelegate回調。
setOnPushStoped	推流停止回調，監聽setInfoDelegate回調。
setOnConnectFail	推流連結失敗，監聽setNetworkDelegate回調。
setOnConnectRecovery	網路恢複，監聽setNetworkDelegate回調。
setOnConnectionLost	串連被斷開，監聽setNetworkDelegate回調。
setOnNetworkPoor	網路差回調，監聽setNetworkDelegate回調。
setOnReconnectError	重連失敗回調，監聽setNetworkDelegate回調。
setOnReconnectStart	重連開始回調，監聽setNetworkDelegate回調。
setOnReconnectSuccess	重連成功回調，監聽setNetworkDelegate回調。
setOnSendDataTimeout	發送資料逾時，監聽setNetworkDelegate回調。
setOnSendSeiMessage	發送SEI Message 通知，監聽setNetworkDelegate回調。
setOnBGMCompleted	背景音樂播放完畢，監聽setBGMDelegate回調。
setOnBGMDownloadTimeout	背景音樂下載播放逾時，監聽setBGMDelegate回調。
setOnBGMOpenFailed	背景音樂開啟失敗，監聽setBGMDelegate回調。
setOnBGMPaused	背景音樂暫停播放，監聽setBGMDelegate回調。
setOnBGMProgress	背景音樂當前播放進度，監聽setBGMDelegate回調。
setOnBGMResumed	背景音樂恢複播放，監聽setBGMDelegate回調。
setOnBGMStarted	背景音樂開始播放，監聽setBGMDelegate回調。
setOnBGMStoped	背景音樂停止播放，監聽setBGMDelegate回調。
setOnSnapshot	截圖回調，監聽setSnapshotDelegate回調。