您可以通过包管理接入 SDK，或直接下载 SDK 离线包。

SDK 概览 #

通过包管理工具接入 SDK #

Android #

推荐使用 Maven 在项目中接入 RTC SDK。

1. 在 Android Studio 左上角将工程视图切换为 Project 模式，在项目根目录的 settings.gradle 文件配置 Maven 仓库地址。

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           ...
           maven {  url 'https://artifact.bytedance.com/repository/Volcengine/' }
           }
   }
   

   Tip

   如果你的 Android Gradle Plugin 版本低于 v7.1.0，则应在项目根目录的 build.gradle 文件配置 Maven 仓库地址。

   allprojects {
       repositories {
           ...
           maven { url 'https://artifact.bytedance.com/repository/Volcengine/' }
       }
   }
   

2. 在 App 的 build.gradle 文件中添加 RTC SDK 依赖。

   Tip

   • 你需要将 '3.x.y.z' 替换为具体的版本号，最新版本号请参看 SDK 概览。如果希望引入先前版本，请咨询技术支持。
   • 集成 3.37 ~ 3.42 版本 SDK 时，需要引入 Kotlin 依赖，Kotlin 版本号请咨询技术支持。3.44+ 版本不需要引入 Kotlin 依赖。
   • 3.50 版本起，RTC SDK 开始拆分为主库加功能插件的形式，你可以按需集成以适应不同的业务场景和 App 体积缩减需求。功能插件详情及集成方式参看减小 App 体积。
   • 如果开发目标平台为 Android 12 (targetSdkVersion >= 31) 及以上版本的应用，请先参考 OpenCL 库 Android 12 适配说明。

   dependencies {
       ...
       implementation 'com.volcengine:VolcEngineRTC:3.x.y.z' // 填写需要接入的 RTC SDK 版本号
   }
   

3. 在项目根目录的 gradle.properties 文件中添加 android.enableJetifier=true，解决兼容性问题。

iOS #

如果你希望使用 CocoaPods 在项目中接入 RTC SDK，配置 Podfile 文件如下：

source 'https://github.com/volcengine/volcengine-specs.git'
target 'your target' do # 将 your target 替换为你的项目名
  pod 'VolcEngineRTC', '3.x.y.z'

end

Flutter #

在 Flutter 项目中接入 RTC SDK，需要同时配置原生平台（Android/iOS）的依赖和添加 Dart 层的 SDK 依赖。

1. 配置原生依赖。
   在添加 Flutter SDK 依赖之前，请先确保你的原生工程已正确配置 RTC SDK 的依赖源。
   Android 端配置

   iOS 端配置

   1. 添加 Maven 仓库地址。
      • Android Gradle Plugin 版本大于等于 v7.1.0：在项目根目录下的 settings.gradle 配置 Maven 仓库地址。

        dependencyResolutionManagement {
            repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
            repositories {
                ...
                maven {  url 'https://artifact.bytedance.com/repository/Volcengine/' }
                }
        }
        

      • Android Gradle Plugin 版本低于 v7.1.0：在项目根目录的 build.gradle 文件配置 Maven 仓库地址。

        allprojects {
            repositories {
                ...
                maven { url 'https://artifact.bytedance.com/repository/Volcengine/' }
            }
        }
        

      2. 在 android/gradle.properties 文件中确保添加以下信息解决兼容性问题：

         android.enableJetifier=true
         

   在 Flutter 项目的 ios/Podfile 文件顶部，添加 RTC SDK 的 specs 仓库源地址。

   # platform :ios, '11.0'  # 确保你的 iOS 部署目标不低于 11.0
   source 'https://github.com/volcengine/volcengine-specs.git'
   source 'https://cdn.cocoapods.org/' # CocoaPods 官方源
   
   target 'Runner' do
     # ...
   end
   

2. 添加 Flutter 依赖。
   在你的 Flutter 项目根目录下执行以下命令，安装 RTC SDK 的 Dart 依赖：

   flutter pub add volc_engine_rtc
   

   说明

   3.50 版本起，RTC SDK 开始拆分为主库加功能插件的形式，你可以按需集成以适应不同的业务场景和 App 体积缩减需求。功能插件详情及集成方式参看减小 App 体积。

3. 检查依赖。
   安装完成后，项目的 pubspec.yaml 文件中将会自动添加对应的 SDK 版本号字段。

   dependencies:
     volc_engine_rtc: ^3.xx.x
   

   如果你已经接入 SDK，可执行以下命令将 SDK 更新至最新版本:

   flutter pub upgrade
   

Web #

通过 npm 接入

你可以使用 npm 安装最新版本 SDK:

npm install @volcengine/rtc --save