更新时间:2023.06.08 20:22:13
推荐使用 Maven 在项目中接入 RTC SDK。
build.gradle
文件中,配置 maven 仓库地址,如下所示:allprojects { repositories { maven { url "https://artifact.bytedance.com/repository/Volcengine/" } google() } }
app/build.gradle
文件中添加配置。引入指定版本(推荐):
dependencies { ... implementation 'com.volcengine:VolcEngineRTC:3.xx.xxx' }
注意:
- 版本号参看下载 SDK。如果希望引入先前版本,咨询技术支持人员。
- 集成 3.37 ~ 3.42 版本 SDK 时,需要引入 Kotlin 依赖。Kotlin 版本号咨询技术支持人员。3.44+ 版本不需要。
- 如果开发目标平台为 Android 12(targetSdkVersion>=31) 及以上版本的应用,请先参考OpenCL 库 Android 12 适配说明。
如果你希望使用 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 pub add volc_engine_rtc
安装完成后,项目的 pubspec.yaml
文件中将会自动添加对应的 SDK 版本号字段,如:
dependencies: volc_engine_rtc: ^3.xx.x
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>
你可以使用 npm 安装最新版本 SDK:
npm install @volcengine/rtc --save
如果你已经安装过 Web SDK,可通过以下方式更新到最新版本:
npm update @volcengine/rtc --save
你也可以使用 Yarn 安装最新版本 SDK:
yarn add @volcengine/rtc
如果你已经安装过 Web SDK,可通过以下方式更新到最新版本:
yarn upgrade @volcengine/rtc
你可以使用 npm 安装最新版本 SDK:
npm install @volcengine/vertc-electron-sdk --save
如果你已经安装过 Electron SDK,可通过以下方式更新到最新版本:
npm update @volcengine/vertc-electron-sdk --save
本文档只提供最新版本的 SDK。如果你需要 3.45.2 及以后版本的 SDK,请至老版本文档归档 下载文档获取;如果你需要 3.45.2 以前版本的 SDK,请联系技术支持或使用包管理工具获取。
平台 | SDK 文件 | 集成后体积增量 |
---|---|---|
Android |
| |
iOS |
| |
macOS |
| / |
Windows |
| / |
Linux |
| / |
Web | <script src="https://lf-unpkg.volccdn.com/obj/vcloudfe/sdk/@volcengine/rtc/4.52.1/1685523812430/VolcEngineRTC_Web_4.52.1.js" /> | |
微信小程序 | / | |
Electron |
| |
Flutter | https://pub.dev/packages/volc_engine_rtc/versions 注意:最新的可用版本为 3.45.1 | / |
快速开始 Demo 是 RTC 提供的基本音视频通话功能的开源示例工程文件。获取该工程文件后,你可以快速构建应用,感受 RTC 的通话效果;也能通过阅读代码,了解基本音视频通话的最佳实践。本文档只提供最新版本的快速开始 Demo。如果你需要 3.45.2 及以后的版本,请至老版本文档归档 下载文档获取;如果你需要 3.45.2 以前的版本,请联系技术支持获取。
平台 | 工程文件 |
---|---|
Android | |
iOS | |
macOS | |
Windows | |
Linux |
|
Web | |
Electron | |
Flutter | |
微信小程序 |
要获取此前版本的快速开始 Demo 工程文件,访问 VolcEngineRTC 开源 Demo 项目获取。
进阶功能 Demo 是 RTC 提供的高级功能的开源示例工程文件。
获取该工程文件后,你可以了解例如外部视频源、美颜、SEI 帧、屏幕分享、RTS 消息、外部渲染等功能的用法,使用这些能力实现更复杂的业务场景。进阶功能不断迭代,不同平台支持的进阶功能以及每项能力的具体介绍以 GitHub 仓库中的说明为准。
此 Demo 包含了高级特效相关功能的实现。但在试运行 Demo 并试用高级特效前,你仍需要获取并加入自己的高级特效授权;否则,Demo 中的相关功能会失效。关于高级特效授权的具体信息,查看关于授权。
平台 | 工程文件 | GitHub 仓库 |
---|---|---|
Android | Advanced_Android | |
iOS | Advanced_iOS | |
Windows | Advanced_Windows |
场景化 Demo 实现了多个场景下的实时音视频通话,包含了特定场景下的最佳实践。您可以下载编译好的场景化 Demo,直观感受实时音视频通信能力。当您在使用 RTC 构建自己的应用时,也可以参考场景化 Demo 工程文件完成音视频能力的接入。
不同平台上的示例应用能够互联互通。比如,您在 iPhone 上安装了火山引擎 RTC 应用后,能够和在 Windows 上使用火山引擎 RTC 应用的同事进行视频会议。
平台 | Demo文件 | 备注 |
---|---|---|
Android | ![]() | Demo 版本是 12.0.7,对应的 SDK 版本是 3.50.3 |
iOS | ![]() | Demo 版本是 12.0.7,对应的 SDK 版本是 3.50.3 |
Windows |
| Demo 版本是 12.0.7,对应的 SDK 版本是 3.50.3 |
抖音小程序 | ![]() | |
抖音小游戏(快速开始) | ![]() | |
抖音小游戏(狼人杀) | ![]() | |
Web | Demo 版本是 1.1.1,对应的 SDK 版本是 4.51.0 |
要获取此前版本的场景化 Demo 工程文件,请访问各个场景对应的 场景化 Demo 项目获取。