本文介绍如何集成 Android 拉流 SDK。

开发环境要求 #

• Android 4.3 及以上系统。
• armeabi-v7a、arm64-v8a 架构。

前提条件 #

已创建 SDK 应用并获取 License 文件。详见获取 SDK License。

集成方式 #

拉流 SDK 支持在线集成和离线集成 2 种集成方法。

• 在线集成：使用构建工具 Gradle 自动加载。
• 离线集成：手动下载 AAR 文件，再将其导入您当前的工程项目。您可通过提交工单联系技术支持，了解离线集成的具体步骤。

集成步骤 #

本章节为您介绍在线集成的具体步骤。

步骤一：配置 Maven 仓库 #

SDK 的集成需要配置多个 Maven 仓库，以确保所有必要的依赖项都能被正确下载。配置步骤如下：

1. 打开根目录下的 build.gradle 文件。
2. 配置主仓库服务器的 URL。主仓库的 URL 为： https://artifact.bytedance.com/repository/Volcengine/，集成代码示例如下：

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

3. 配置其他 Maven 仓库。由于基础拉流功能和其他相关组件分布在不同的 Maven 仓库中，您需要额外配置其他 Maven 仓库以确保所有依赖项都能被正确获取。
   • 对于 AGP 7.1 以下版本：在根目录下的 build.gradle 文件中，添加以下代码快速集成其他仓库的配置：

     apply from: 'https://ve-vos.volccdn.com/script/vevos-repo-base.gradle'
     

   • 对于 AGP 7.1 及以上版本：将 https://ve-vos.volccdn.com/script/vevos-repo-base.gradle 中的 Maven 配置拷贝到 settings.gradle 文件的 dependencyResolutionManagement 配置块下。

步骤二：配置环境和依赖 #

1. 打开 app/build.gradle 文件并完成以下配置。
   • 在 defaultConfig 中配置 App 使用的 CPU 架构。支持 armeabi-v7a 和 arm64-v8a 架构。
   • 在 dependencies 中添加依赖。

     android {
        defaultConfig {
            ndk {
                // 设置 SO 库架构，支持 armeabi-v7a 和 arm64-v8a 架构。
                abiFilters 'armeabi-v7a', 'arm64-v8a'
             }
        }
     }
     
     dependencies {
        // ...
        // 如需集成 1.49.1.11 及以上版本，并使用基础拉流功能，必须添加以下依赖。
        implementation 'com.bytedanceapi:ttsdk-ttlivepull_standard:x.x.x.x'
     }
     

     其中，
     • 如需集成 1.51.3 及以上版本，并使用拉流超分和视频锐化功能，必须同时添加 implementation 'com.bytedanceapi:ttsdk-ttbmf:x.x.x.x' 和 implementation 'com.bytedanceapi:ttsdk-ttlivepull_premium:x.x.x.x' 依赖。
     • 如需集成 1.49.1.11 及以上版本，并使用拉流 SDK 的高级版 License 功能，必须将 implementation 'com.bytedanceapi:ttsdk-ttlivepull_standard:x.x.x.x' 替换为 implementation 'com.bytedanceapi:ttsdk-ttlivepull_premium:x.x.x.x'。
     • 如需集成 1.49.1.11 及以上版本，并使用 QUIC 协议拉流功能，必须同时添加 implementation 'com.bytedanceapi:ttsdk-ttquic:x.x.x.x' 和 implementation 'com.bytedanceapi:ttsdk-ttlivepull_premium:x.x.x.x' 依赖。

   说明

   • 将 x.x.x.x 替换为 SDK 的指定版本。推荐使用最新版本。版本号详见 Android 拉流 SDK 发布历史。
   • 如需集成 1.48.2.11 版本，
     • 使用基础拉流功能，必须添加的依赖为 implementation 'com.bytedanceapi:ttsdk-ttlivepull_standard:1.48.2.11'。
     • 使用 QUIC 协议拉流功能，必须添加的依赖为 implementation 'com.bytedanceapi:ttsdk-ttquic:1.48.2.11' 和 implementation 'com.bytedanceapi:ttsdk-ttlivepull_standard:1.48.2.11'。
     • 使用 RTM 协议拉流功能，必须添加的依赖为 implementation 'com.bytedanceapi:ttsdk-ttlivepull_premium:1.48.2.11'。
   • 如需集成 1.48.1.103 及以下的版本，
     • 使用基础拉流功能（包含 QUIC 协议拉流），必须添加的依赖为 implementation 'com.bytedanceapi:ttsdk-ttlivepull:x.x.x.x'。
     • 使用 RTM 协议拉流功能，必须添加的依赖为 implementation 'com.bytedanceapi:ttsdk-ttlivepull_rtc:x.x.x.x'。
2. 单击 Sync Now 按钮同步 SDK，SDK 将自动下载集成到工程。如果出现集成失败，请检查您与 Maven 仓库的网络连接。

配置权限 #

在 AndroidManifest.xml 文件中声明使用拉流 SDK 所需的权限。

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

添加 License #

将按照获取 SDK License获取的 License 文件拷贝到工程目录下。例如下图所示，将 License2_test.lic 文件拷贝到 assets 目录下。请记录 License 文件路径，初始化 SDK 时需要使用该路径。

配置混淆规则 #

在 proguard-rules.pro 文件中，将 SDK 相关类加入不混淆名单。

-keep class com.pandora.**{*;}
-keep class com.ss.**{*;}
-keep class com.bytedance.**{*;}
-keep class com.pandora.ttlicense2.**{*;}
-keep class com.bytertc.**{*;}
-keep class log.**{*;}