文档中心

集成准备

最近更新时间：2024.01.12 16:20:52

首次发布时间：2021.02.23 10:42:41

本文为您介绍集成 Android 点播 SDK 前的准备工作，包括环境准备、License 获取、集成操作等内容。

环境要求

类别	说明
开发环境	Android Studio（推荐使用最新版本）
系统版本	minSdkVersion: 16
ABI 兼容性	架构要求：armv7 或 arm64

创建应用并获取 License

集成 Android 点播 SDK 前，您需要登录视频点播控制台，完成以下操作：

创建应用
购买 License 包
绑定 License 与应用
下载 License 文件

详情请见创建应用和 License 包管理。

说明

测试版 License 不能在线上业务 App 使用，原因如下：

测试版 License 仅供联调测试，到期后无法续期。
测试版 License 到期会导致 App 鉴权不通过，从而影响业务使用。

添加 maven 仓库

确保 project 根目录下 build.gradle 文件中的 repositories 中配置了 mavenCentral() 和火山引擎 maven 服务。

allprojects {
    repositories {
        google()
        jcenter()
        mavenCentral()
        maven {
            url "https://artifact.bytedance.com/repository/Volcengine/" // volc public maven repo
        }
    }
}

操作后的截图如下所示。

alt

获取 SDK 最新版本号

请参见发布历史获取 SDK 最新版本号。

添加 SDK 依赖

接下来，在 module 目录下 build.gradle 文件中的 dependencies 中添加点播 SDK 依赖。不同版本对应的详细说明如下所示。

说明

点播 SDK 分为基础版、高级版，各版本之间存在功能差异，请根据购买的 License 选择对应的版本。

高级版

基础版

如果您已购买高级版 License，在添加 SDK 依赖时，需要进行的代码设置如下所示。

dependencies {
    //... your own dependencies...
    // 推荐使用最新稳定版，版本信息见「获取 SDK 最新版本号」小节
    implementation "com.bytedanceapi:ttsdk-player_premium:x.x.x.x" 
    // 1.40.2.8 之前的版本还需要添加以下 AppLog 依赖，用于上报日志
    // implementation "com.bytedance.applog:RangersAppLog-Lite-cn:6.15.4"
    // 用于视频源获取
    implementation 'com.squareup.okhttp3:okhttp:4.2.1'
}

操作后的示意图如下所示。

如果您已购买基础版 License，在添加 SDK 依赖时，需要进行的代码设置如下所示。

dependencies {
    //... your own dependencies...
    // 推荐使用最新稳定版，版本信息见「获取 SDK 最新版本」小节
    implementation "com.bytedanceapi:ttsdk-player_standard:x.x.x.x"
    // 1.40.2.8 之前的版本还需要添加以下 AppLog 依赖，用于上报日志
    // implementation "com.bytedance.applog:RangersAppLog-Lite-cn:6.15.4"
    // 用于视频源获取
    implementation 'com.squareup.okhttp3:okhttp:4.2.1'
}

操作后的示意图如下所示。

Java 8 支持

使用点播 SDK，需要支持 Java 8。更新 module 目录下的 build.gradle 文件，代码示例如下所示。

android {
    // ...
  compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

操作后的截图如下所示。

alt

权限声明

接下来，在 AndroidManifest.xml 文件中声明 SDK 需要的权限。

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

说明

WRITE_EXTERNAL_STORAGE 为非必需权限，可根据您的实际需求设置：

如果您无需播放外置存储上的音视频资源，也不将下载的视频储存至外置存储，则无需申请此权限。视频下载缓存文件夹默认在应用内置存储中，无需申请权限，详见快速开始 - 初始化点播 SDK。
如果您需要申明 WRITE_EXTERNAL_STORAGE 权限，请参考 Android 存储用例和最佳做法。

混淆规则

接下来，在 proguard-rules.pro 文件中配置 SDK 混淆规则。

# 点播模块
-keep class com.ss.ttm.** {*;} 
-keep class com.ss.ttvideoengine.** {*;} 
-keep class com.ss.mediakit.** {*;} 
-keep class com.ss.texturerender.** {*;}
-keep class com.bytedance.**{*;}
-keep class com.pandora.ttlicense2.**{*;}
-keep class com.pandora.common.applog.**{*;}
-keep class com.pandora.vod.VodSDK {*;} 
-keep class com.bytertc.volcbaselog.VolcBaseLogConfig{*;}
-keep class com.bytertc.volcbaselog.VolcBaseLogNative{*;}

后续操作

至此，您已完成点播 SDK 的集成准备。下面演示如何使用点播 SDK 播放视频。详情请见：快速开始。