快速集成

本文介绍Android播放器SDK的环境要求、集成方式及使用参考。

环境要求

类别

说明

系统版本

支持Android 4.3及以上版本。

手机芯片

架构要求:

  • armv7。

  • arm64。

开发工具

推荐使用Android Studio,本文操作步骤基于Android Studio开发。下载地址:Android Studio

前提条件

  • 已注册并获取包含播放器授权的License文件AliVideoCert-********.crt。具体操作,请参见获取License

  • 本地集成SDK时,需要先下载Android播放器SDK包(包含了播放器SDK及Demo源码),从V5.4.6.0版本开始Android播放器SDK提供了支持AndroidX和不支持AndroidX的Demo,请根据您的项目按需选择下载,推荐下载使用最新版本。下载地址请参见播放器SDK

解压后的目录结构如下:

表 1. SDK包目录结构

文件名

作用

demo

播放器的Demo源码。

JavaDoc

播放器API文档。

sdk

播放器SDK的aar库。sdk的目录结构参见sdk目录结构

X.X.XReleaseNote

版本说明。

表 2. sdk目录结构

文件名

说明

AliyunPlayer-x.x.x-full.aar

完整的aar包,包含了FFmpeg动态库的包。

AliyunPlayer-x.x.x-part.aar

aar包,不包含FFmpeg的动态库的包。

AlivcArtp-x.x.x.aar

支持artp协议,非必须。

AlivcArtc-x.x.x.aar

支持artc协议,非必须。

说明
  • 如果不集成短视频SDK,直接依赖AliyunPlayer-x.xx.x-full.aar包即可。

  • 如果集成播放器的同时,也集成短视频SDK,那么播放器的SDK依赖AliyunPlayer-x.x.x-part包,同时使用共通的FFmpeg版本,即需要额外依赖com.aliyun.video.android:AlivcFFmpeg:x.x.x这个包。

  • 如果集成时使用了错误的SDK包,会导致FFmpeg冲突。

使用限制

Android播放器SDK不支持模拟器,集成完成后需要真机运行。

SDK集成(本地集成)

说明

以下步骤以Android Studio Flamingo | 2022.2.1版本的Android Studio开发工具为例,其余开发工具的操作步骤类似。

  1. 拷贝需要的aar包到工程的libs目录下(如果没有libs文件夹,手动创建libs文件夹即可)。

    图片

  2. 修改Project下的build.gradle文件,在allprojects的repositories节点中增加flatDir的设置,示例如下:

    flatDir {
       dirs 'libs'
    }
  3. 修改App的build.gradle文件,dependencies节点中增加对aar的引用和Conan的引用,示例如下:

    dependencies {
          implementation fileTree(dir: 'libs', include: ['*.aar'])
          //阿里云播放器5.3.0 版本以前需要引入AlivcConan库,5.3.0及其以后的版本不需要引入。
          implementation 'com.alivc.conan:AlivcConan:x.x.x'
    }
  4. 混淆配置。

    在App的Proguard-rules.pro文件中添加以下混淆配置,示例如下:

    -keep class com.alivc.**{*;}
    -keep class com.aliyun.**{*;}
    -keep class com.cicada.**{*;}
    -dontwarn com.alivc.**
    -dontwarn com.aliyun.**
    -dontwarn com.cicada.**

SDK集成(Gradle集成)

说明

请确保网络正常,并且可以正常访问阿里云Maven仓库。如果由于网络故障,无法从Maven仓库下载到播放器SDK包,则建议通过本地集成方式来集成SDK,详细请参见SDK集成(本地集成)

  1. 在Project的build.gradle中增加阿里云的Maven地址依赖。示例如下:

    maven { url "https://maven.aliyun.com/repository/releases" }

    操作后的截图如下:gradle集成

  2. 修改App的build.gradle文件,dependencies节点中增加依赖。示例如下:

    说明

    请确保引入的播放器SDK版本号填写正确,否则将报错并引入失败。播放器SDK的版本可以从Android播放器SDK发布历史查看。

    implementation 'com.aliyun.sdk.android:AliyunPlayer:x.x.x-full'
    //阿里云播放器5.3.0 版本以前需要引入AlivcConan库,5.3.0及其以后的版本不需要引入
    implementation 'com.alivc.conan:AlivcConan:x.x.x'

    操作后的截图如下:结果

配置License

说明
  • V5.4.7.1及之后版本的Android播放器SDK必须按以下操作配置License后,方可使用。

  • 播放器SDK现免费提供,License有效期为1年,1年后若无特殊约定我们将为您免费自动续期。届时,播放器SDK会更新本地证书,建议您在App发布版本的时候集成新的本地证书。新的证书可登录点播控制台获取,详情参见管理License

  • License配置完成后,查看日志若无License相关报错,则表示License配置成功。

  • 配置的License文件和LicenseKey和创建License时的应用信息(PackageName和Signature)有严格的对应关系,请确保License文件和LicenseKey和创建时的信息保持一致,否则会出现鉴权失败的情况。

  1. 将获取到的证书文件AliVideoCert-********.crt拷贝到Android Studio项目中,建议放到assets目录下,也可以放到沙箱或者其他路径。

  2. 在AndroidManifest.xml文件中添加如下meta-data。

    license1

    • key为com.aliyun.alivc_license.licensekey(全小写),value为LicenseKey的值。

    • key为com.aliyun.alivc_license.licensefile(全小写),value为步骤二中证书文件的放置路径,请根据实际情况填写。

    <meta-data
        android:name="com.aliyun.alivc_license.licensekey"
        android:value="xxxxxxxxx" />
    <meta-data
        android:name="com.aliyun.alivc_license.licensefile"
        android:value="assets/license.crt" />

常见集成问题

播放器问题

功能使用文档

基础功能

进阶功能