通过包管理工具接入 SDK
Android

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

  1. 在根目录下的 build.gradle 文件中,配置 maven 仓库地址,如下所示:
allprojects {
    repositories {
        maven { url "https://artifact.bytedance.com/repository/Volcengine/" }
        google()
    }
}
groovy
  1. 为模块配置构建配置。在 app/build.gradle 文件中添加配置。

引入指定版本(推荐):

dependencies {
    ...
    implementation 'com.volcengine:VolcEngineRTC:3.xx.xxx'
    }
groovy

注意:

  • 版本号参看下载 SDK。如果希望引入先前版本,咨询技术支持人员。
  • 集成 3.37 ~ 3.42 版本 SDK 时,需要引入 Kotlin 依赖。Kotlin 版本号咨询技术支持人员。3.44+ 版本不需要。
  • 如果开发目标平台为 Android 12(targetSdkVersion>=31) 及以上版本的应用,请先参考OpenCL 库 Android 12 适配说明。
iOS

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

引入指定版本(推荐):

source 'https://github.com/volcengine/volcengine-specs.git'
target 'your target' do
  pod 'VolcEngineRTC', '3.xx.xxx'
end

// 如需引入屏幕共享模块,参考如下设置
target 'ScreenShareExtension' do
  use_frameworks!
  pod 'VolcEngineRTC', '3.xx.xx', :subspecs => ['ScreenCapture']
end

注意:

  • 版本号参看下载 SDK。如果希望引入先前版本,咨询技术支持人员。
  • 3.42 版本起提供 effect-sdk.framework 用于美颜特效,暂不支持在线 CocoaPods 方式引入,如需使用请参考 CV SDK 动态库集成方法集成。
  • 3.50 版本起提供 bytenn.xcframework 用于 AI 降噪、音乐场景检测等,暂不支持在线 CocoaPods 方式引入,如需使用请下载 SDK 包后手动引入。
Flutter
  1. 推荐以添加远端依赖的方式在项目中接入 RTC SDK。在终端进入项目根目录,运行如下命令安装依赖项:
flutter pub add volc_engine_rtc
powershell

安装完成后,项目的 pubspec.yaml 文件中将会自动添加对应的 SDK 版本号字段,如:

dependencies:
  volc_engine_rtc: ^3.xx.x
yaml
  1. 你也可以下载 SDK 包并复制到项目文件夹下,在项目 pubspec.yaml 文件中添加 volc_engine_rtc 依赖项:
environment:
  sdk: ">=2.12.0 <3.0.0"

# 依赖项
dependencies:
  flutter:
    sdk: flutter
   
  # 将 <SDK_PATH> 替换为项目下SDK的文件路径
  volc_engine_rtc:
    path: <SDK_PATH>
yaml
Web
npm

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

npm install @volcengine/rtc --save
powershell

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

npm update @volcengine/rtc --save
powershell
Yarn

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

yarn add @volcengine/rtc
powershell

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

yarn upgrade @volcengine/rtc
powershell
Electron

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

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

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

npm update @volcengine/vertc-electron-sdk --save
powershell
下载 SDK

本文档只提供最新版本的 SDK。如果你需要 3.45.2 及以后版本的 SDK,请至老版本文档归档 下载文档获取;如果你需要 3.45.2 以前版本的 SDK,请联系技术支持或使用包管理工具获取。

平台SDK 文件
集成后体积增量
Android【附件下载】: VolcEngineRTC_Android_3.50.301.zip,大小为 42.93MB
  • ARM v7: 11.8MB
  • ARM 64: 17.5MB
  • x86: 23.7MB
iOS【附件下载】: VolcEngineRTC_iOS_3.50.301.zip,大小为 37.82MB
  • ARM v7: 7.94MB
  • ARM 64: 8.04MB
macOS/
Windows/
Linux/
Web
  • 下载离线包:【附件下载】: VolcEngineRTC_Web_4.53.0.js,大小为 715.96KB
  • 从 CDN 引入:
    <script src="https://lf-unpkg.volccdn.com/obj/vcloudfe/sdk/@volcengine/rtc/4.53.0/1686819330120/VolcEngineRTC_Web_4.53.0.js"></script>
  • 微信小程序【附件下载】: VolcEngineRTC_MiniApp_3.0.1.js,大小为 45.54KB/
    Electron
    Flutterhttps://pub.dev/packages/volc_engine_rtc/versions
    注意:最新的可用版本为 3.45.1
    /
    下载快速开始 Demo

    快速开始 Demo 是 RTC 提供的基本音视频通话功能的开源示例工程文件。获取该工程文件后,你可以快速构建应用,感受 RTC 的通话效果;也能通过阅读代码,了解基本音视频通话的最佳实践。本文档只提供最新版本的快速开始 Demo。如果你需要 3.45.2 及以后的版本,请至老版本文档归档 下载文档获取;如果你需要 3.45.2 以前的版本,请联系技术支持获取。

    平台工程文件
    Android【附件下载】: VolcengineRTC_QuickStart_Android_3.50.301.zip,大小为 34.25MB
    iOS【附件下载】: VolcengineRTC_QuickStart_iOS_3.50.301.zip,大小为 24.91MB
    macOS【附件下载】: VolcEngineRTC_QuickStart_macOS_3.50.301.zip,大小为 33.32MB
    Windows【附件下载】: VolcengineRTC_QuickStart_Windows_3.50.301.zip,大小为 136.72MB
    Linux
    Web【附件下载】: VolcengineRTC_Demo_Web_4.51.zip,大小为 564.66KB
    Electron【附件下载】: VolcengineRTC_QuickStart_Electron_3.50.1.zip,大小为 508.01KB
    Flutter【附件下载】: VolcengineRTC_Demo_Flutter_3.45.1.zip,大小为 108.23KB
    微信小程序【附件下载】: VolcengineRTC_Demo_WeChat_Miniapp_3.0.0.zip,大小为 3.97MB

    要获取此前版本的快速开始 Demo 工程文件,访问 VolcEngineRTC 开源 Demo 项目获取。

    下载进阶功能 Demo

    进阶功能 Demo 是 RTC 提供的高级功能的开源示例工程文件。
    获取该工程文件后,你可以了解例如外部视频源、美颜、SEI 帧、屏幕分享、RTS 消息、外部渲染等功能的用法,使用这些能力实现更复杂的业务场景。进阶功能不断迭代,不同平台支持的进阶功能以及每项能力的具体介绍以 GitHub 仓库中的说明为准。

    此 Demo 包含了高级特效相关功能的实现。但在试运行 Demo 并试用高级特效前,你仍需要获取并加入自己的高级特效授权;否则,Demo 中的相关功能会失效。关于高级特效授权的具体信息,查看关于授权。

    平台工程文件GitHub 仓库
    Android【附件下载】: VolcengineRTC_Advanced_Android_3.50.301.zip,大小为 51.67MBAdvanced_Android
    iOS【附件下载】: VolcengineRTC_Advanced_iOS_3.50.301.zip,大小为 63.61MBAdvanced_iOS
    Windows【附件下载】: VolcengineRTC_Advanced_Windows_3.50.301.zip,大小为 193.76MBAdvanced_Windows
    WebWeb 端进阶 Demo 支持推流到直播、美颜、AI 降噪功能,可在移动端及 PC 端在线体验
    下载和体验场景化 Demo

    场景化 Demo 实现了多个场景下的实时音视频通话,包含了特定场景下的最佳实践。您可以下载编译好的场景化 Demo,直观感受实时音视频通信能力。当您在使用 RTC 构建自己的应用时,也可以参考场景化 Demo 工程文件完成音视频能力的接入。

    不同平台上的示例应用能够互联互通。比如,您在 iPhone 上安装了火山引擎 RTC 应用后,能够和在 Windows 上使用火山引擎 RTC 应用的同事进行视频会议。

    平台Demo文件备注
    Android
    【附件下载】: veRTCDemo 12.0.7.apk,大小为 91.2MB
    Demo 版本是 12.0.7,对应的 SDK 版本是 3.50.3
    iOSDemo 版本是 12.0.7,对应的 SDK 版本是 3.50.3
    Windows
    • Windows x86-32:
    【附件下载】: VeRTCDemo(Win32).zip,大小为 48.84MB
    • Windows x86-64:
    【附件下载】: VeRTCDemo(Win64).zip,大小为 58.51MB
    Demo 版本是 12.0.7,对应的 SDK 版本是 3.50.3
    抖音小程序
    抖音小游戏(快速开始)
    抖音小游戏(狼人杀)
    WebDemo 版本是 1.1.1,对应的 SDK 版本是 4.51.0

    要获取此前版本的场景化 Demo 工程文件,请访问各个场景对应的 场景化 Demo 项目获取。