RoomKit
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • React Native
  • 产品简介
    • 概述
    • 发布日志
  • 开通 RoomKit 服务
  • 下载
  • 体验 App
  • 快速开始
  • 进阶功能
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • RoomKit
  • 快速开始
  • 跑通示例源码
示例源码
本地下载
说明

1 示例源码运行指引

本文介绍如何快速跑通示例源码,体验基础的 RoomKit 服务。

1.1 准备环境

请确保开发环境满足以下技术要求:

  • Xcode 14.0 或以上版本。
  • iOS 11.0 或以上版本且支持音视频的 iOS 设备或模拟器(推荐使用真机)。
  • iOS 设备已经连接到 Internet。
  • 确保已经安装 CocoaPods。安装 CocoaPods 的方法以及常见问题可参考 CocoaPods 常见问题

1.2 前提条件

已在 RoomKit 管理后台 创建项目,并获取初始化 RoomKit SDK 所必须的 SecretID、SecretSign、ProductID等信息。详见 开通 RoomKit 服务

虽然开发者在示例源码中填入自定义的 SecretID 和 SecretSign 能够正常获取到 SDK Token 并进行后续的登录操作,但是不建议开发者在自己的 App 中使用这种做法。建议开发者使用业务服务器向 ZegoRoomKit 服务器请求 SDK Token 以保证数据安全,详情请参考 获取 SDK Token

1.3 运行示例源码

  1. 打开 AppStore,搜索 Xcode 并下载安装。

  2. 下载示例源码。

  3. 切换到 Podfile 文件所在目录,执行 pod repo update 更新本地依赖库索引。这一步可能会需要比较长的时间,视网络情况而定,大约耗时在 3 mins ~ 20 mins。

  4. 执行 pod install 命令,等待所有依赖库下载完毕(RoomKit 相关 SDK 大小在 300 MB 左右)。

  5. 在解压后的文件夹中双击文件 ZegoRoomkitDemo.xcworkspace。

    workspace_position

  6. 修改开发者证书和 Bundle Identifier。

    a. 打开 Xcode,单击左侧的 ZegoRoomkitDemo 项目。

    choose_project

    b. 分别选中 Target 和 Extension Target,单击 Signing & Capabilities 选项卡,将示例源码中的 Team、Bundle Identifier 和 App Groups,修改成开发者自己的值。

    Targets 中选择 ZegoRoomkitDemo 时,修改页面如下:

    signing_1

    Targets 中选择 ZegoRoomkitDemoScreenShare 时,修改页面如下:

    signing_2

  7. 修改示例源码中 ZegoAuthConstants.h 文件,填充 kSecretID、kSecretSign 和 kProductID。请使用本文 前提条件 中获取的信息正确填写,否则示例源码无法正常运行。

    auth

  8. 将 iOS 设备连接到开发电脑,单击 Xcode 左上角的 Generic iOS Device 选择 iOS 真机或者模拟器。

    choose_device

  1. 单击 Xcode 左上角的 Build & Run 按钮,编译和运行示例源码。

    run

本篇目录