功能使用

注册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://）推流地址，地址获取可参见生成推流地址和播放地址。

   • 阿里云视频直播暂不支持同一时间向同一个推流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);//开启摄像头混流
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();
       }
   });

连麦互动（互动版）

直播推流SDK互动版V4.4.4及以上版本提供基于RTC的连麦互动能力，V4.4.5及以上版本提供基于RTC的连麦PK互动能力，用户可以使用推流SDK互动版本完成主播和连麦观众超低延时（300ms以内）互动，直播连麦相关的功能使用，请参见连麦互动开发指南和主播PK互动开发指南。