运行示例项目(Demo)
融云提供了功能完整的 QuickDemo 示例应用项目(Github · Gitee),集中演示了融云 RTC 产品的 音视频通话、音视频会议、低延迟直播 在 iOS 端的功能实现。通过体验 QuickDemo,您可以快速了解产品能力,并实现单群聊、音视频通话、语音聊天室、娱乐直播、教学课堂、多人会议等场景需求。
QuickDemo 开源项目按场景和功能分为多个模块,对主要功能进行演示。您可以对感兴趣的部分进行代码改造,以便进一步了解实现细节。
前提条件
在运行 QuickDemo 之前,您需要完成以下准备工作:
1. 创建开发者账号
- 注册融云开发者账号并登录融云控制台。
- 获取您的 App Key / Secret。注册成功后,融云控制台会默认自动创建您的首个应用,生成开发环境下的 App Key / Secret,使用国内数据中心。
2. 开通音视频服务
您需要开通以下服务才能体验 QuickDemo 的全部功能:
- 音视频通话服务
- 音视频直播服务
- 开发环境:可免费开通,每个应用均可享有 10000 分钟免费体验时长。
- 生产环境:需要先预存费用才可开通。
- 生效时间:服务开 通后最长 15 分钟生效。
详细步骤请参见开通音视频服务。
运行步骤
步骤 1:环境检查
在运行 QuickDemo 前,请确保已完成以下准备工作:
- 已注册融云开发者账户
- 已获取 App Key / Secret
- 已开通音视频服务免费体验
- 已等待服务生效(最长 15 分钟),客户端最长 2 小时更新导航,可以卸载重装后获取最新配置进行测试
步骤 2:下载并配置项目
2.1 克隆项目代码
git clone https://github.com/rongcloud/rtc-quickdemo-ios.git
2.2 安装依赖
进入 QuickDemo 文件夹,在终端执行以下命令下载依赖库:
pod install
如果出现找不到相关版本的问题,可先执行 pod repo update
,再执行 pod install
。
2.3 打开项目
使用 Xcode 打开 QuickDemo.xcworkspace
文件(而不是 .xcodeproj
文件)。
2.4 配置 App Key / Secret
- 找到
/RCRTCQuickDemo/Tool/Constant/Constant.m
文件。 - 将
AppKey
和AppSecret
替换为从控制台获取的具体内容。 - 删除或注释掉
#error
提醒行。
/*!
请填写 App Key / Secret
获取地址: https://console.rongcloud.cn/agile/formwork/app/appService
*/
NSString * const AppKey = @"您的 App Key";
/*!
请填写 App Secret
获取 Token 需要提供 App Key / Secret
正式环境请勿在客户端请求 Token,您的客户端代码一旦被反编译,会导致您的 App Secret 泄露。
请务必确保在服务端获取 Token。
*/
NSString * const AppSecret = @"您的 App Secret";
本教程中直接在客户端代码中写入 App Secret
的行为仅为演示目的。App Secret
可用来获取用户身份令牌(Token),以及实现人员禁言、房间踢人等高级能力。存储在客户端代码里很容易被反编译导致泄漏。
App Secret
一旦泄露,攻击者就可以盗取 SDK 服务流量,或进行高权限破坏性操作。正确的方式是将 App Secret
存储在您的应用服务端,并提供面向应用客户端的接口。
更多详情请参见音视频服务端开发文档。
步骤 3:配置 Bundle Identifier
为了确保屏幕共享功能正常工作,您需要正确配置 Bundle Identifier。
3.1 配置主应用 Bundle Identifier
- 选择
RCRTCQuickDemo
target。 - 在
General
→Identity
→Bundle Identifier
中,修改为您的唯一标识符。
示例:cn.rongcloud.rtcquickdemo
3.2 配置屏幕共享扩展 Bundle Identifier
- 选择
ScreenShare
target。 - 在
General
→Identity
→Bundle Identifier
中,使用主应用的 Bundle Identifier 并添加.screenshare
后缀。
示例:cn.rongcloud.rtcquickdemo.screenshare
3.3 配置 App Group
为确保主应用和屏幕共享扩展能够正常通信,需要配置相同的 App Group。
- 选择
RCRTCQuickDemo
target,在Signing & Capabilities
中添加App Groups
能力。 - 选择
ScreenShare
target,同样添加App Groups
能力。 - 两个 target 中使用相同的 App Group ID。
示例:group.cn.rongcloud.rtcquickdemo
步骤 4:编译运行
- 选择您的目标设备(建议使用真实设备而非模拟器)。
- 点击
Run
按钮编译并运行项目。 - 运行成功后,输入用户 ID 即可开始体验各项功能。
- 需要在真实设备上运行,以获得最佳的音视频体验。
- 确保设备已连接网络,并且网络状况良好。
- 如需测试多人场景,可以在多个设备上同时运行 Demo。
功能体验
QuickDemo 包含以下主要功能模块:
- 音视频通话:一对一音视频通话体验
- 音视频会议:多人音视频会议体验
- 直播互动:主播与观众互动直播体验
- 屏幕共享:屏幕内容分享功能
- 美颜特效:实时美颜和滤镜效果
您可以根据实际需求,选择相应的功能模块进行体验和学习。