ApsaraVideo Live：功能使用

註冊SDK

申請並配置License請參見License整合指南。

請在較早的位置（使用推流SDK前）調用註冊License介面

AlivcLiveBase.setListener(new AlivcLiveBaseListener() {
  @Override
  public void onLicenceCheck(AlivcLivePushConstants.AlivcLiveLicenseCheckResultCode result, String reason) {
    Log.e(TAG, "onLicenceCheck: " + result + ", " + reason);
  }
});
AlivcLiveBase.registerSDK();

• 通過AlivcLiveBase類，可以設定記錄層級、設定本地日誌路徑、擷取SDK版本等。

• 接入方需要調用AlivcLiveBase中的registerSDK方法，進行SDK License註冊。

• 在AlivcLiveBase#setListener介面的onLicenceCheck方法，非同步判斷License是否配置成功。

  說明

  該回調僅在初始化pusher執行個體後觸發。

推流（網路攝影機推流）

1. 初始化。

   在配置好推流參數後，可以使用推流SDK的init方法進行初始化。範例程式碼如下：

   AlivcLivePusher mAlivcLivePusher = new AlivcLivePusher();
   mAlivcLivePusher.init(mContext, mAlivcLivePushConfig);

   說明

   AlivcLivePusher目前不支援多執行個體，所以一個init必須對應有一個destroy。

2. 註冊預覽回調。

   註冊預覽回調可通過setLivePushInfoListener方法實現：

   /**
    * 設定推流通知事件
    *
    * @param infoListener 通知監聽器
    */
   mAlivcLivePusher.setLivePushInfoListener(new AlivcLivePushInfoListener() {
       @Override
       public void onPreviewStarted(AlivcLivePusher pusher) {
           //預覽開始通知
       }
       //其他Override方法
       //....
       //....
   });

3. 開始預覽。

   livePusher對象初始化及回調配置完成之後，可以進行開始預覽操作。預覽時需要傳入網路攝影機預覽的顯示SurfaceView。範例程式碼如下：

   mAlivcLivePusher.startPreview(mSurfaceView)//開始預覽，也可根據需求調用非同步介面startPreviewAysnc來實現

4. 開始推流。

   在onPreviewStarted回調方法內添加如下代碼。

   mAlivcLivePusher.startPush(mPushUrl);

   說明

   • 推流地址支援RTMP和超低延時直播RTS（artc://）推流地址，地址擷取可參見產生推流地址和播放地址。

   • 阿里雲ApsaraVideo for Live暫不支援同一時間向同一個推流URL進行多路推流（第二路推流會被拒絕）。

/*正在推流狀態下可調用暫停推流。暫停推流後，視頻預覽和視頻推流保留在最後一幀，音頻推流繼續*/
mAlivcLivePusher.pause();
/*暫停狀態下可調用恢複推流。恢複推流後，音視頻預覽與推流恢複正常*/
mAlivcLivePusher.resume();
/*推流狀態下可調用停止推流，完成後推流停止*/
mAlivcLivePusher.stopPush();
/*在預覽狀態下才可以調用停止預覽，正在推流狀態下，調用停止預覽無效。預覽停止後，預覽畫面定格在最後一幀*/
mAlivcLivePusher.stopPreview();
/*推流狀態下或者接收到所有Error相關回調狀態下可調用重新推流, 且Error狀態下只可以調用此介面(或者reconnectPushAsync重連)或者調用destory銷毀推流。完成後重新開始推流，重啟ALivcLivePusher內部的一切資源，包括預覽、推流等等restart*/
mAlivcLivePusher.restartPush();
/*推流狀態下或者接收到AlivcLivePusherNetworkDelegate相關的Error回調狀態下可調用此介面, 且Error狀態下只可以調用此介面(或者restartPush重新推流)或者調用destory銷毀推流。完成後推流重連，重新連結推流RTMP*/
mAlivcLivePusher.reconnectPushAsync();
/*銷毀推流後，推流停止，預覽停止，預覽畫面移除。AlivcLivePusher相關的一切資源銷毀*/
mAlivcLivePusher.destroy();

/*切換前後網路攝影機*/
mAlivcLivePusher.switchCamera();
/*開啟/關閉閃光燈，在自拍時開啟閃關燈無效*/
mAlivcLivePusher.setFlash(true); 
/*焦距調整，即可實現採集畫面的縮放功能。縮放範圍為[0,getMaxZoom()]。*/
mAlivcLivePusher.setZoom(5);
/*手動對焦。手動聚焦需要傳入兩個參數:1.point 對焦的點（需要對焦的點的座標);2.autoFocus 是否需要自動對焦，只有本次對焦操作調用該介面時，該參數才生效。後續是否自動對焦沿用上述自動聚焦介面設定值*/
mAlivcLivePusher.focusCameraAtAdjustedPoint(x, y, true);
/*設定是否自動對焦*/
mAlivcLivePusher.setAutoFocus(true);
/*鏡像設定。鏡像相關介面有兩個，PushMirror推流鏡像和PreviewMirror預覽鏡像。PushMirror設定僅對播放畫面生效，PreviewMirror僅對預覽畫面生效，兩者互不影響*/
mAlivcLivePusher.setPreviewMirror(false);
mAlivcLivePusher.setPushMirror(false);

錄屏推流（螢幕畫面分享推流）

推流SDK支援錄屏推流。使用錄屏推流需在初始化操作、設定預覽及開始推流之後進行相關配置。錄屏採用MediaProjection，需要使用者請求許可權，將許可權請求返回的資料通過此介面設定，即開啟錄屏模式。錄屏情況下，預設不開啟網路攝影機。

//resultData 錄屏系統intent
mAlivcLivePushConfig.setMediaProjectionPermissionResultData(resultData);

mAlivcLivePusher.setScreenOrientation(0);

mAlivcLivePusher.pauseScreenCapture();//開啟隱私保護
mAlivcLivePusher.resumeScreenCapture();//關閉隱私保護

錄屏+網路攝影機推流

在進行錄屏推流時，可以開啟網路攝影機實現錄屏+網路攝影機推流，錄屏+網路攝影機推流分為兩種情況：

1. 主播端有網路攝影機預覽畫面。

   主播和觀眾都能看到網路攝影機的畫面。

2. 主播端沒有網路攝影機預覽畫面。

   比如遊戲直播時，主播不想讓網路攝影機畫面擋住遊戲畫面。而觀眾端觀看到的直播內容包含主播的網路攝影機畫面。

mAlivcLivePusher.startCamera(surfaceView);//開啟網路攝影機預覽
mAlivcLivePusher.stopCamera();//關閉網路攝影機預覽

mAlivcLivePusher.startCameraMix(x, y, w, h);//開啟網路攝影機混流，並設定x,y,w,h混流布局
mAlivcLivePusher.stopCameraMix();//停止網路攝影機混流

預覽顯示模式

推流SDK支援三種預覽模式，預覽顯示模式不影響推流。

• ALIVC_LIVE_PUSHER_PREVIEW_SCALE_FILL：預覽顯示時，鋪滿視窗。當視頻比例和視窗比例不一致時，預覽會有變形。

• ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FIT：預覽顯示時，保持視頻比例。當視頻比例與視窗比例不一致時，預覽會有黑邊。

• ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FILL：預覽顯示時，剪下視頻以適配視窗比例。當視頻比例和視窗比例不一致時，預覽會裁剪視頻。

範例程式碼如下：

mAlivcLivePushConfig.setPreviewDisplayMode(AlivcPreviewDisplayMode.ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FIT);

圖片推流

為了更好的使用者體驗，推流SDK提供了後台圖片推流和碼率過低時進行圖片推流的設定。

當SDK退至後台時預設暫停推流視頻，只推音頻流，此時可以進行圖片推流。例如，在圖片上提醒使用者主播離開片刻，稍後回來。

mAlivcLivePushConfig.setPausePushImage("退後台png圖片路徑");//設定使用者後台推流的圖片

當網路較差時您可以根據自己的需求設定推流一張靜態圖片。設定圖片後，SDK檢測到當前碼率較低時，會推流此圖片，避免視頻流卡頓。範例程式碼如下所示：

mAlivcLivePushConfig.setNetworkPoorPushImage("網路差png圖片路徑");//設定網路較差時推流的圖片

純音頻推流

mAlivcLivePushConfig.setAudioOnly(true);

推送外部音視頻流

推流SDK支援將App外部的音視頻源輸入進行推流，比如推送一個音視頻檔案。

推送外部音視頻流之前，需要開啟自訂音視頻流輸入功能。

/**
* 其他參數：如輸出解析度，音頻採樣率，通道數等在config裡，setResolution，setAudioSamepleRate，setAudioChannels裡設定
*/
mAlivcLivePushConfig.setExternMainStream(true,AlivcImageFormat.IMAGE_FORMAT_YUVNV12,AlivcSoundFormat.SOUND_FORMAT_S16);

開啟自訂音視頻流輸入功能之後，就可以推送外部音視頻流。

/**
* 此介面不控制時序，需要調用方控制輸入音訊框架的時序
*/
mAlivcLivePusher.inputStreamAudioData(byte[] data, int size, int sampleRate, int channels, long pts);

/**
* 此介面不控制時序，需要調用方控制輸入視訊框架的時序
*/
mAlivcLivePusher.inputStreamVideoData(byte[] data, int width, int height, int stride, int size, long pts, int rotation);

配置浮水印

推流SDK提供了添加浮水印功能，並且支援添加多個浮水印。浮水印圖片必須為PNG格式圖片。範例程式碼如下：

mAlivcLivePushConfig.addWaterMark(waterPath,0.1,0.2,0.3);//添加浮水印

設定視頻品質

視頻品質支援三種模式：清晰度優先模式，流暢度優先模式，自訂模式。

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_RESOLUTION_FIRST);//清晰度優先

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_FLUENCY_FIRST);//流暢度優先

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_CUSTOM);//自訂模式
mAlivcLivePushConfig.setTargetVideoBitrate(1000); //目標碼率1000kbps
mAlivcLivePushConfig.setMinVideoBitrate(300); //最小碼率300kbps
mAlivcLivePushConfig.setInitialVideoBitrate(800); //初始碼率800kbps

解析度自適應

解析度自適應即動態調整推流解析度。開啟功能後，當網路較差時會自動降低解析度以提高視頻的流暢度和清晰度。範例程式碼如下：

mAlivcLivePushConfig.setEnableAutoResolution(true); // 開啟解析度自適應，預設為false

背景音樂

推流SDK提供了背景音樂播放、混音、降噪、耳返、靜音等功能。範例程式碼如下：

/*開始播放背景音樂。*/
mAlivcLivePusher.startBGMAsync(mPath)；
/*停止播放背景音樂。若當前現正播放BGM，並且需要切換歌曲，只需要調用開始播放背景音樂介面即可，無需停止當前現正播放的背景音樂*/
mAlivcLivePusher.stopBGMAsync();
/*暫停播放背景音樂，背景音樂開始播放後才可調用此介面*/
mAlivcLivePusher.pauseBGM();
/*恢複播放背景音樂，背景音樂暫停狀態下才可調用此介面*/
mAlivcLivePusher.resumeBGM();
/*開啟迴圈播放音樂*/
mAlivcLivePusher.setBGMLoop(true);
/*設定降噪開關。開啟降噪後，將對採集到的聲音中非人聲的部分進行過濾處理。可能存在對人聲稍微抑製作用，建議讓使用者自由選擇是否開啟降噪功能，預設不使用*/
mAlivcLivePusher.setAudioDenoise(true);
/*設定耳返開關。耳返功能主要應用於KTV情境。開啟耳返後，插入耳機將在耳機中聽到主播說話聲音。關閉後，插入耳機無法聽到人聲。未插入耳機的情況下，耳返不起作用*/
mAlivcLivePusher.setBGMEarsBack(true);
/*混音設定，提供背景音樂和人聲採集音量調整*/
mAlivcLivePusher.setBGMVolume(50);//設定背景音樂音量
mAlivcLivePusher.setCaptureVolume(50);//設定人聲採集音量
/*設定靜音。靜音後音樂聲音和人聲輸入都會靜音。要單獨設定音樂或人聲靜音可以通過混音音量設定介面來調整*/
mAlivcLivePusher.setMute(true);

推流截圖

推流SDK提供了本地視頻流截圖功能，範例程式碼如下：

// 視頻流截圖，參數：截取圖片的個數、每張圖片的間隔、介面回調
pusher.snapshot(1, 1, new AlivcSnapshotListener() {
    @Override
    public void onSnapshot(Bitmap bmp) {
            // 可以將截圖轉儲到本地png檔案，下面是範例程式碼
        String dateFormat = new SimpleDateFormat("yyyy-MM-dd-hh-mm-ss-SS").format(new Date());
        File f = new File(context.getExternalFilesDir(Environment.DIRECTORY_PICTURES), "snapshot-" + dateFormat + ".png");
        if (f.exists()) {
            f.delete();
        }
        try {
            FileOutputStream out = new FileOutputStream(f);
            bmp.compress(Bitmap.CompressFormat.PNG, 90, out);
            out.flush();
            out.close();
        } catch (FileNotFoundException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
});

後台運行和鎖屏

• 當App退至後台或鎖屏時，您可調用AlivcLivePusher的pause()或resume()介面，暫停或恢複推流。

• 對於非系統的音視訊通話，SDK會採集聲音並推送出去，您可以根據業務需求在退後台或鎖屏時調用靜音介面mAlivcLivePusher.setMute（true或false）來決定後台時是否採集音頻。

回調監聽

常用方法和介面

/*在自訂模式下，使用者可以即時調整最小碼率和目標碼率*/
mAlivcLivePusher.setTargetVideoBitrate(800);
mAlivcLivePusher.setMinVideoBitrate(400);
/*是否支援自動對焦*/
mAlivcLivePusher.isCameraSupportAutoFocus();
/*是否支援閃光燈*/
mAlivcLivePusher.isCameraSupportFlash();
/*擷取是否正在推流的狀態*/
mAlivcLivePusher.isPushing()； 
/*擷取推流地址*/
mAlivcLivePusher.getPushUrl()；
/*擷取推流效能調試資訊。推流績效參數具體參數和描述參考API文檔或者介面注釋*/
mAlivcLivePusher.getLivePushStatsInfo();
/*擷取版本號碼*/
mAlivcLivePusher.getSDKVersion();
/*設定log層級，根據需求過濾想要的調試資訊*/
mAlivcLivePusher.setLogLevel(AlivcLivePushLogLevelAll);
/*擷取當前sdk狀態*/
mAlivcLivePusher.getCurrentStatus();
/*擷取上一個錯誤碼，如無錯誤返回：ALIVC_COMMON_RETURN_SUCCESS*/
mAlivcLivePusher.getLastError();

整合美顏功能

如需在推流SDK中使用美顏功能，需要引入美顏庫並配置對應回調。

1. 通過Maven方式引入美顏庫及美顏面板，在工程的build.gradle檔案中添加如下代碼，美顏SDK版本請參考最新Demo：

   implementation "com.aliyun.maliang.android:queen:2.5.0-official-full"
   implementation("com.aliyun.maliang.android:queen_menu:2.5.0-official-full") {
       exclude group: 'com.aliyun.maliang.android', module: 'queen'
   }

   還可以整合Demo中的LiveBeauty模組：

   檔案或檔案夾	功能描述
   live_beauty	美顏基礎抽象類別
   queen_beauty	美顏基礎UI控制項

2. 擷取美顏外掛程式庫LiveBeauty。

   1. 通過clone命令從此路徑（LiveBeauty）下載相關外掛程式庫代碼到本地。

      git clone https://github.com/MediaBox-Demos/amdemos-android-live.git

   2. 在Android Studio專案根目錄下開啟命令列。執行如下代碼，再通過File > New > Import Module 將 LiveBeauty 模組匯入到你的Android專案中。

      git submodule add https://github.com/MediaBox-Demos/amdemos-android-live.git ***/***/***

      說明

      範例程式碼中“***/***/***”是你想要放置LiveBeauty模組的位置

   3. 在專案的settings.gradle檔案中添加模組的路徑：

      include ':app', ':LiveBeauty', ':LiveBeauty:live_queenbeauty'

      說明

      範例程式碼中，“app”為主模組。

   4. 同時在專案主模組的build.gradle檔案中，添加對 LiveBeauty 模組的依賴：

      dependencies {
          implementation project(':LiveBeauty')
          implementation project(':LiveBeauty:live_queenbeauty')
      }

   5. 點擊File > Sync Project with Gradle Files，等待 Gradle 同步完成後，即可使用LiveBeauty模組。

3. 配置美顏外掛程式UI模組。

   1. 在本專案的布局XML檔案中添加 QueenBeautyMenu 的控制項。例如：

      <com.aliyunsdk.queen.menu.QueenBeautyMenu
          android:id="@+id/beauty_beauty_menuPanel"
          android:layout_width="match_parent"
          android:layout_height="wrap_content"
          android:layout_alignParentBottom="true"
          android:layout_centerHorizontal="true" />

   2. 在Activity中初始化QueenBeautyMenu。例如：

      // 初始化美顏菜單面板
      QueenMenuPanel beautyMenuPanel = QueenBeautyMenu.getPanel(context);
      beautyMenuPanel.onHideMenu(); 
      beautyMenuPanel.onHideValidFeatures(); 
      beautyMenuPanel.onHideCopyright(); 
      
      // 在布局中添加美顏菜單
      QueenBeautyMenu beautyBeautyContainerView = findViewById(R.id.beauty_beauty_menuPanel);
      beautyBeautyContainerView.addView(beautyMenuPanel);

4. 設定人臉臉部辨識及美顏回調。

   如果您有接入第三方美顏庫的需求，可設定setCustomDetect和setCustomFilter回調。

   • AlivcLivePushCustomDetect回呼函數customDetectProcess（long data、int width、int height、int rotation、int format、long extra參數）中返回的參數data是採集資料的指標，第三方美顏庫可對資料指標中的資料進行識別或者處理。

   • AlivcLivePushCustomFilter回呼函數customFilterProcess（int inputTexture、inttextureWidth、int textureHeight、long extra參數）中返回的參數inputTexture是映像的紋理texture，第三方美顏庫可對紋理進行處理。如果需要返回一個處理過的紋理texture，則返回texture id。否則，返回原來的inputTexture即可。

   範例程式碼

   /**
    * 人臉臉部辨識回調
    */
   mAlivcLivePusher.setCustomDetect(new AlivcLivePushCustomDetect() {
       @Override
       public void customDetectCreate() {
   
       }
   
       @Override
       public long customDetectProcess(long dataPtr, int width, int height, int rotation, int format, long extra) {
           return 0;
       }
   
       @Override
       public void customDetectDestroy() {
   
       }
   });
   
   /**
    * 美顏回調
    */
    
    /**
    * 初始化BeautyManager
    */
   mAlivcLivePusher.setCustomFilter(new AlivcLivePushCustomFilter() {
       @Override
       public void customFilterCreate() {
           initBeautyManager();
       }
   
    /**
    * 處理推流視頻流，添加美顏效果
    */
       @Override
       public int customFilterProcess(int inputTexture, int textureWidth, int textureHeight, long extra) {
           if (mBeautyManager == null) {
               return inputTexture;
           }
   
           return mBeautyManager.onTextureInput(inputTexture, textureWidth, textureHeight);
       }
   
       @Override
       public void customFilterDestroy() {
           destroyBeautyManager();
       }
   });