You need to enable JavaScript to run this app.
导航
集成 SDK
最近更新时间:2025.04.02 12:00:48首次发布时间:2021.02.23 10:42:41
我的收藏
有用
有用
无用
无用

本文为您介绍如何将 Android 播放器 SDK 集成至您的项目中,包括开发环境要求、前提条件、操作步骤等内容。

开发环境要求

  • 推荐使用 Android Studio 最新版本。
  • 仅支持基于 armv7 或 arm64 **** 架构的真实设备。暂不支持模拟器。
  • Android 版本需为 5.0(API 级别 21)及以上。
  • 编译时需使用 JDK 11 及其以下版本。

获取 License

视频点播通过 License 管理播放器 SDK 及其增值服务的使用权限和时间。在项目测试阶段,您可以在视频点播控制台申请免费的测试 License。您需完成以下操作:

注意

测试 License 仅限项目测试阶段使用,不可续期。测试 License 到期会导致鉴权失败,进而影响业务的正常使用。项目上线前,请升级至正式 License

集成 SDK

步骤 1:添加 maven 仓库

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

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

操作后的示意图如下:
Image

步骤 2:添加 SDK 依赖

module 目录下 build.gradle 文件中的 dependencies 中添加播放器 SDK 依赖。播放器 SDK 分为基础版、高级版和企业版,各版本之间存在功能差异。请根据购买的 License 选择对应的版本。

说明

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

如果您已购买高级版 License,请参考以下代码添加 SDK 依赖:

dependencies {
    //... your own dependencies...
    // 将 x.x.x.x 替换成最新版本号
    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'
}

操作后的示意图如下:
Image

步骤 3:添加 Java 8 支持

module 目录下的 build.gradle 文件中添加 Java 8 支持,示例代码如下:

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

操作后的示意图如下:
Image

步骤 4:声明权限

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 为非必需权限,可根据您的实际需求设置:

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

步骤 5:配置混淆规则

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 播放视频。详情请见快速开始