火山引擎 RTC 提供了开源示例项目 API Example Demo。获取该项目后,你可以参照本文进行跑通,体验实时音视频功能;也能通过阅读代码,了解最佳实践。
在开始集成 RTC SDK 前,请确保满足以下要求:
你可以从以下方式中选择一种获取示例项目:
下载离线包。
通过 GitHub 获取示例项目,具体指令如下:
git clone https://github.com/volcengine/VolcEngineRTC.git cd VolcEngineRTC git checkout main cd Windows
示例项目的目录结构如下:
. ├── 3rd │ ├── Windows │ └── mac ├── API_Example.pro ├── CMakeLists.txt ├── README.md ├── Resources ├── bin ├── resources.qrc └── src ├── Basic // 快速开始 https://www.volcengine.com/docs/6348/1169314 │ ├── QuickStartWidget.cpp │ ├── QuickStartWidget.h │ └── QuickStartWidget.ui ├── Advanced │ ├── AudioMixing // 播放音乐文件 https://www.volcengine.com/docs/6348/70141、播放音效 https://www.volcengine.com/docs/6348/1178326 │ ├── ByteBeauty // 智能美化特效(付费版) https://www.volcengine.com/docs/6348/114717 │ ├── CDNStream // 推流到 CDN https://www.volcengine.com/docs/6348/69817 │ ├── CrossRoomPK // 跨房 PK https://www.volcengine.com/docs/6348/104398 │ ├── FuBeauty // 自定义视频处理(相芯美颜) https://www.volcengine.com/docs/6348/79888 │ ├── Message // 发送和接收媒体补充增强信息(SEI) https://www.volcengine.com/docs/6348/70140 │ ├── MultiRoom // 多房间 https://www.volcengine.com/docs/6348/196844 │ ├── RawAudioData // 原始音频数据 https://www.volcengine.com/docs/6348/1178324 │ ├── SoundEffects // 变声、混响、降噪 https://www.volcengine.com/docs/6348/1178327 │ └── VideoConfig // 视频参数配置 https://www.volcengine.com/docs/6348/70122、视频采集旋转方向 https://www.volcengine.com/docs/6348/106458 ├── Info.plist ├── Public ├── app.ico ├── main.cpp ├── mainwindow.cpp ├── mainwindow.h ├── mainwindow.ui └── resources.rc
src/Public/Config.h
中的 g_appid
和 g_appkey
。请正确填写信息,否则编译无法成功。src/Public/Config.h
填写 g_byte_beauty_key
和 g_byte_secret
,请联系智能美化特效商务团队获取相关信息。src/Advanced/FuBeauty/authpack.h
填写 g_auth_package
,请发送邮件至 marketing@faceunity.com 进行咨询。src/Public/Config.h
填写 g_sami_key
和 g_sami_token
,请参考 SDK 快速入门文档获取授权信息章节。打开 Qt 安装路径下的 Qt Creator。使用 Qt Creator 打开 API_Example.pro
,并选择已安装的构建套件。
单击 Qt Creator 窗口左下角的运行按钮(或使用 Command ⌘ + R 快捷键),运行效果如下:
为更好地体验实时音视频互动效果,你可以邀请一位朋友使用另一台设备运行该示例项目(需确保两个设备配置示例项目时填入的 App ID 和 AppKey 一致)。当你们输入相同的房间名加入房间后,即可在同一房间中体验音视频通话。
在完成音视频互动后,你可以阅读以下文档进一步了解: