获取 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/' }
           }
   }
   

   说明

   如果你的 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 依赖。

   说明

   • 你需要将 '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

推荐以添加远端依赖的方式在项目中接入 RTC SDK。在终端进入项目根目录，运行如下命令安装依赖项：

flutter pub add volc_engine_rtc

安装完成后，项目的 pubspec.yaml 文件中将会自动添加对应的 SDK 版本号字段，最新版本号参看下载 SDK，如：

dependencies:
  volc_engine_rtc: ^3.xx.x

如果你已经接入 SDK，可通过在项目根目录下执行如下终端命令，将 SDK 更新至最新版本:

flutter pub upgrade

Web

通过 npm 接入

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

npm install @volcengine/rtc --save

如果你已经安装过 Web SDK，可通过以下方式更新到最新版本:

npm update @volcengine/rtc --save

通过 Yarn 接入

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

yarn add @volcengine/rtc

如果你已经安装过 Web SDK，可通过以下方式更新到最新版本:

yarn upgrade @volcengine/rtc

Electron

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

npm install @volcengine/vertc-electron-sdk --save

如果你已经安装过 Electron SDK，可通过以下方式更新到最新版本:

npm update @volcengine/vertc-electron-sdk --save

下载 SDK

平台	SDK 文件	备注
Android	VolcEngineRTC_Android_3.58.1.2700.zip 70.06MB	--
iOS	VolcEngineRTC_iOS_3.58.1.100.zip 42.30MB	RTC SDK 中还包含了第三方 SDK：Abseil，BoringSSL，和 Protobuf。根据 Apple 即将发布的第三方 SDK 要求，从 2024 年春季开始，当你在 App Store Connect 中提交包含 RTC SDK 的新 App 时，或者当提交 App 更新并且 RTC SDK 是更新的一部分时，必须在隐私清单中进行说明。详情参看 即将发布的第三方 SDK 要求。
macOS	x86 架构: VolcEngineRTC_macOS_x86_3.58.1.100.zip 43.23MB ARM 架构: VolcEngineRTC_macOS_arm_3.58.1.300.zip 35.67MB	RTC SDK 中还包含了第三方 SDK：Abseil，BoringSSL，和 Protobuf。根据 Apple 即将发布的第三方 SDK 要求，从 2024 年春季开始，当你在 App Store Connect 中提交包含 RTC SDK 的新 App 时，或者当提交 App 更新并且 RTC SDK 是更新的一部分时，必须在隐私清单中进行说明。详情参看 即将发布的第三方 SDK 要求。
Windows	Windows x86-32 ： VolcEngineRTC_Windows_x86_32_3.58.1.100.zip 39.48MB Windows x86-64 ： VolcEngineRTC_Windows_x86_64_3.58.1.100.zip 45.50MB	--
Linux	Linux 桌面版（x86）： VolcEngineRTC_Linux_x86_64_3.58.1.100.zip 29.78MB Linux 服务器版（x86）： VolcEngineRTC_Linux_x86_64_3.58.1.200.zip 30.14MB	--
Web	下载离线包: VolcengineRTC_Web_4.60.8.js 868.30KB 从 CDN 引入： <script src="https://lf-unpkg.volccdn.com/obj/vcloudfe/sdk/@volcengine/rtc/4.60.8/1713263315816/volengine_Web_4.60.8.js"></script>	--
微信小程序	VolcEngineRTC_MiniApp_3.1.1.js 53.43KB	--
Electron	macOS ARM64： VolcEngineRTC_Electron_3.57.1_macOS_arm64.zip 31.75MB macOS x86-64： VolcEngineRTC_Electron_3.57.1_macOS_x86_64.zip 33.82MB Windows x86-64： VolcEngineRTC_Electron_3.57.1_Windows_x86_64.zip 40.02MB Windows x86-32： VolcEngineRTC_Electron_3.57.1_Windows_ia32.zip 34.66MB	--
Flutter	https://pub.dev/packages/volc_engine_rtc/versions	--
Unity	VolcEngineRTC_Unity_3.57.1.unitypackage 151.25MB	--