金山云直播推流Android SDK使用说明

最新及历史版本

当前版本为4.x，相对于v3.x有较大的变动，从3.x迁移的用户可参考：
3.x到4.0迁移说明。

KSYLive_Android集成了 libksyplayer，具有播放SDK直播的所有功能，并且集成了 KSYStreamer，具有推流SDK所有功能。

如果使用直播推流、播放功能，请使用 KSYLive_Android ，无需单独集成 KSYStreamer。

当前推流 KSYStreamer支持以下体系结构:

• armeabi

• armeabi-v7a

• arm64-v8a

• x86

为了节省apk size，如果没有特殊缘由，请只集成armeabi-v7a版本。

5.1.1. 下载融合库

5.1.2. 下载单独库

• demo: 示例工程，演示本SDK主要接口功能的使用

• libs: 集成SDK需要的所有库文件

  • libs/[armeabi-v7a|arm64-v8a|x86]: 各平台的so库

  • libs/ksylive.jar: 融合SDK jar包

引入目标库, 将libs目录下的库文件引入到目标工程中并添加依赖。

可参考下述配置方式（以Android Studio为例）：

• 导入SDK

  1. 推荐直接使用gradle方式集成：

     # required
     allprojects {
         repositories {
             jcenter()
         }
     }
     
     dependencies {
         # required, enough for most devices.
         compile 'com.ksyun.media:libksylive-java:2.4.4'
         compile 'com.ksyun.media:libksylive-armv7a:2.4.4'
     
         # Other ABIs: optional
         compile 'com.ksyun.media:libksylive-arm64:2.4.4'
         compile 'com.ksyun.media:libksylive-x86:2.4.4'
     }

  2. 手动下载集成

     • 将libs目录copy到目标工程的根目录下；

     • 修改目标工程的build.gradle文件，配置jniLibs路径：

       sourceSets {
           main {
               ...
               jniLibs.srcDir 'libs'
           }
           ...
       }

• 修改proguard(混淆)文件，添加如下规则：

  -keep class com.ksyun.** {
    *;
  }
  
  -keep class com.ksy.statlibrary.** {
    *;
  }

• 在AndroidManifest.xml文件中申请相应权限

  <!-- 使用权限 -->
  <uses-permission android:name="android.permission.READ_PHONE_STATE" />
  <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.READ_PHONE_SINTERNETWIFI_STATE" />
  <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
  <uses-permission android:name="android.permission.CAMERA" />
  <uses-permission android:name="android.permission.RECORD_AUDIO" />
  <uses-permission android:name="android.permission.FLASHLIGHT" />
  <uses-permission android:name="android.permission.VIBRATE" />
  <!-- 硬件特性 -->
  <uses-feature android:name="android.hardware.camera" />
  <uses-feature android:name="android.hardware.camera.autofocus" />

• 将demo assets目录下的资源文件copy到目标工程的assets目录下

具体可参考demo工程中的 com.ksyun.media.streamer.demo.CameraActivity 类.

1. 在布局文件中加入预览View, 当前支持GLSurfaceView和TextureView

   <android.opengl.GLSurfaceView
       android:id="@+id/camera_preview"
       android:layout_width="match_parent"
       android:layout_height="match_parent"
       android:layout_alignParentBottom="true"
       android:layout_alignParentTop="true" />

2. 初始化预览View

   GLSurfaceView mCameraPreview = (GLSurfaceView)findViewById(R.id.camera_preview);

3. 创建KSYStreamer实例并配置推流相关参数

   // 创建KSYStreamer实例
   mStreamer = new KSYStreamer(this);
   // 设置预览View
   mStreamer.setDisplayPreview(mCameraPreview);
   // 设置推流url（需要向相关人员申请，测试地址并不稳定！）
   mStreamer.setUrl("rtmp://test.uplive.ksyun.com/live/{streamName}");
   // 设置预览分辨率, 当一边为0时，SDK会根据另一边及实际预览View的尺寸进行计算
   mStreamer.setPreviewResolution(480, 0);
   // 设置推流分辨率，可以不同于预览分辨率（不应大于预览分辨率，否则推流会有画质损失）
   mStreamer.setTargetResolution(480, 0);
   // 设置预览帧率
   mStreamer.setPreviewFps(15);
   // 设置推流帧率，当预览帧率大于推流帧率时，编码模块会自动丢帧以适应设定的推流帧率
   mStreamer.setTargetFps(15);
   // 设置视频码率，分别为初始平均码率、最高平均码率、最低平均码率，单位为kbps，另有setVideoBitrate接口，单位为bps
   mStreamer.setVideoKBitrate(600, 800, 400);
   // 设置音频采样率
   mStreamer.setAudioSampleRate(44100);
   // 设置音频码率，单位为kbps，另有setAudioBitrate接口，单位为bps
   mStreamer.setAudioKBitrate(48);
   /**
    * 设置编码模式(软编、硬编)，请根据白名单和系统版本来设置软硬编模式，不要全部设成软编或者硬编,白名单可以联系金山云商务:
    * StreamerConstants.ENCODE_METHOD_SOFTWARE
    * StreamerConstants.ENCODE_METHOD_HARDWARE
    */
   mStreamer.setEncodeMethod(StreamerConstants.ENCODE_METHOD_SOFTWARE);
   // 设置屏幕的旋转角度，支持 0, 90, 180, 270
   mStreamer.setRotateDegrees(0);
   // 设置开始预览使用前置还是后置摄像头
   mStreamer.setCameraFacing(CameraCapture.FACING_FRONT);

4. 创建推流事件监听

   Note	所有回调均运行在KSYStreamer的创建线程，建议在主线程中进行，开发者可以直接在回调中操作 KSYStreamer的相关接口，但不要在这些回调中做任何耗时的操作。

   // 设置Info回调，可以收到相关通知信息
   mStreamer.setOnInfoListener(new KSYStreamer.OnInfoListener() {
       @Override
       public void onInfo(int what, int msg1, int msg2) {
           // ...
       }
   });
   // 设置错误回调，收到该回调后，一般是发生了严重错误，比如网络断开等，
   // SDK内部会停止推流，APP可以在这里根据回调类型及需求添加重试逻辑。
   mStreamer.setOnErrorListener(new KSYStreamer.OnErrorListener() {
       @Override
       public void onError(int what, int msg1, int msg2) {
           // ...
       }
   });

5. 开始推流

   Note	初次开启预览后需要在OnInfoListener回调中收到 StreamerConstants.KSY_STREAMER_CAMERA_INIT_DONE 事件后调用方才有效。 （v4.2.1及之后的版本无此限制）

   mStreamer.startStream();

6. 推流开始前及推流过程中可动态设置的常用方法

   // 切换前后摄像头
   mStreamer.switchCamera();
   // 开关闪光灯
   mStreamer.toggleTorch(true);
   // 设置美颜滤镜，关于美颜滤镜的具体说明请参见专题说明
   mStreamer.getImgTexFilterMgt().setFilter(mStreamer.getGLRender(),
                   ImgTexFilterMgt.KSY_FILTER_BEAUTY_DENOISE);

7. 停止推流

   mStreamer.stopStream();

8. Activity生命周期的回调处理

   public class CameraActivity extends Activity {
   
       // ...
   
       @Override
       public void onResume() {
           super.onResume();
           // 一般可以在onResume中开启摄像头预览
           mStreamer.startCameraPreview();
           // 调用KSYStreamer的onResume接口
           mStreamer.onResume();
           // 如果onPause中切到了DummyAudio模块，可以在此恢复
           mStreamer.setUseDummyAudioCapture(false);
       }
   
       @Override
       public void onPause() {
           super.onPause();
           mStreamer.onPause();
           // 一般在这里停止摄像头采集
           mStreamer.stopCameraPreview();
           // 如果希望App切后台后，停止录制主播端的声音，可以在此切换为DummyAudio采集，
           // 该模块会代替mic采集模块产生静音数据，同时释放占用的mic资源
           mStreamer.setUseDummyAudioCapture(true);
       }
   
       @Override
       public void onDestroy() {
           super.onDestroy();
           // 清理相关资源
           mStreamer.release();
       }
   }

• 主页： 金山云

• 邮箱： zengfanping@kingsoft.com

• QQ讨论群：

  1. 574179720 [视频云技术交流群]

  2. 620036233 [视频云Android技术交流]

  3. 以上两个加一个QQ群即可   

• Issues: https://github.com/ksvc/KSYStreamer_Android/issues