跑通示例项目

更新时间: 2023/12/28 01:52:08

网易云信为您提供开源的示例项目,您可以参考本文档快速跑通示例项目,体验语聊房的效果。

开发环境

在开始运行示例项目之前,请确保开发环境满足以下要求:

环境要求 说明
iOS 版本 11.0 及以上的 iPhone 或者 iPad 真机
CPU 架构 ARM64、ARMV7
IDE XCode
其他 安装 CocoaPods

前提条件

请确认您已完成以下操作:

运行示例源码

  • 语聊房的示例源码仅供开发者接入参考,实际应用开发场景中,请结合具体业务需求修改使用。
  • 若您计划将源码用于生产环境,请确保应用正式上线前已经过全面测试,以免因兼容性等问题造成损失。

语聊房
  1. 克隆语聊房示例项目源码仓库至本地工程。

    示例项目源码请存放至全英文的路径下。

  2. 打开终端,在 Podfile 文件所在文件夹下(VoiceRoomKit/LiveAudioRoom)执行如下命令进行安装依赖库:

    bashpod install
    
  3. LiveAudioRoom/LiveAudioRoom/AppKey.swift 中,替换您自己的 AppKey 和 AppSecret。

    swift// MARK: 请填写您的 AppKey 和 AppSecret
    let APP_KEY: String = "your appkey" // 请填写应用对应的 AppKey,可在云信控制台的 AppKey管理 页面获取
    let APP_SECRET: String = "your secret" // 请填写应用对应的 AppSecret,可在云信控制台的 AppKey管理 页面获取
    
    // MARK: 如果您的 AppKey 为海外,填 true;如果您的 AppKey 为中国国内,填 false
    let IS_OVERSEA = false
    
    // MARK: BASE_URL 的默认地址仅用于跑通体验Demo,请勿用于正式产品上线。在产品上线前,请换为您自己实际的服务端地址
    let BASE_URL: String = "https://yiyong.netease.im" //云信派对服务端中国国内的体验地址
    let BASE_URL_OVERSEA: String = "http://yiyong-sg.netease.im"  //云信派对服务端海外的体验地址
    
    • 获取 AppKey 和 AppSecret 的方法请参见创建应用并获取 AppKey
    • 配置文件中的 BASE_URL 地址 http://yiyong.netease.im为云信派对服务端体验地址,该地址仅用于体验 Demo,单次最大体验时长为1小时,请勿用于生产环境。
    • 如果您的应用的 AppKey 为海外,设置 IS_OVERSEA 的值为 true,并联系技术支持或商务经理配置抄送地址。
  4. 选中设备直接运行,即可体验 Demo。

    建议在真机上运行,不支持模拟器调试。

  5. 语聊房示例项目结构

    ├── KaraokeKit
    │   └── NEAudioEffectKit // 音效模块
    ├── OneOnOne
    │   └── NELoginSample // 登录模块
    ├── Party
    │   └── NESocialUIKit // 娱乐社交通用UI
    ├── PodConfigs // CocoaPods 配置
    ├── UIKit
    │   └── NEUIKit // 通用UI
    ├── VoiceRoomKit
    │   ├── LiveAudioRoom // 语聊房主工程
    │   ├── NEOrderSong // 点歌模块
    │   ├── NEVoiceRoomBaseUIKit // 语聊房通用UI
    │   ├── NEVoiceRoomKit // 语聊房逻辑模块
    │   └── NEVoiceRoomUIKit // 语聊房UI模块
    └── third_party // 第三方依赖
    
    
游戏房
  1. 克隆游戏房示例项目源码仓库至本地工程。

    示例项目源码请存放至全英文的路径下。

  2. 打开终端,在 Podfile 文件所在文件夹下(VoiceRoomKit/NEGame/NEGameSample)中执行如下命令进行安装依赖库:

    pod install 
    
  3. VoiceRoomKit/NEGame/NEGameSample/NEGameSample/AppKey.swift 中,替换您自己的 AppKey 和 AppSecret 。

    swift// MARK: 请填写您的 AppKey 和 AppSecret
    let APP_KEY: String = "your appkey" // 请填写应用对应的 AppKey,可在云信控制台的 AppKey管理 页面获取
    let APP_SECRET: String = "your secret" // 请填写应用对应的 AppSecret,可在云信控制台的 AppKey管理 页面获取
    
    // MARK: 如果您的 AppKey 为海外,填 true;如果您的AppKey为中国国内,填 false
    let IS_OVERSEA = false
    
    // MARK: BASE_URL 的默认地址仅用于跑通体验Demo,请勿用于正式产品上线。在产品上线前,请换为您自己实际的服务端地址
    let BASE_URL: String = "https://yiyong.netease.im" // 云信派对服务端中国国内的体验地址
    let BASE_URL_OVERSEA: String = "http://yiyong-sg.netease.im"  // 云信派对服务端海外的体验地址
    
    • 获取 AppKey 和 AppSecret 的方法请参见创建应用并获取 AppKey
    • 配置文件中的 BASE_URL 地址 http://yiyong.netease.im为云信派对服务端体验地址,该地址仅用于体验 Demo,请勿用于生产环境。 您可以使用云信派对 Demo 体验 1 小时音视频通话。
    • 如果您的应用的 AppKey 为海外,请设置 IS_OVERSEA 的值为 true
  4. 运行工程。

    建议在真机上运行,不支持模拟器调试。

  5. 游戏房示例项目结构

    ├── OneOnOne
    │   └── NELoginSample // 登录模块
    ├── Party
    │   └── NESocialUIKit // 娱乐社交通用UI
    ├── UIKit
    │   └── NEUIKit // 通用UI
    ├── VoiceRoomKit
    │   ├── NEGame
    │   │   ├── NEGameKit  // 游戏房逻辑
    │   │   ├── NEGameSample // 游戏房主工程
    │   │   └── NEGameUIKit // 游戏房UI组件
    │   ├── NEVoiceRoomBaseUIKit // 语聊房通用UI组件
    │   └── NEVoiceRoomKit // 语聊房逻辑
    └── third_party // 第三方依赖
    
    
一起听
  1. 克隆一起听示例项目源码仓库至本地工程。

    示例项目源码请存放至全英文的路径下。

  2. 打开终端,在 Podfile 文件所在文件夹下(VoiceRoomKit/ListenTogetherExample)中执行如下命令进行安装:

    pod install 
    
  3. ListenTogetherExample/ListenTogether/AppKey.swift 中,替换您自己的 AppKey 和 AppSecret。

    swift// MARK: 请填写您的 AppKey 和 AppSecret
    let APP_KEY: String = "your appkey" // 请填写应用对应的 AppKey,可在云信控制台的 AppKey管理 页面获取
    let APP_SECRET: String = "your secret" // 请填写应用对应的 AppSecret,可在云信控制台的 AppKey管理 页面获取
    
    // MARK: 如果您的 AppKey 为海外,填 true;如果您的 AppKey 为中国国内,填 false
    let IS_OVERSEA = false
    
    // MARK: BASE_URL 的默认地址仅用于跑通体验Demo,请勿用于正式产品上线。在产品上线前,请换为您自己实际的服务端地址
    let BASE_URL: String = "https://yiyong.netease.im" // 云信派对服务端中国国内的体验地址
    let BASE_URL_OVERSEA: String = "http://yiyong-sg.netease.im" // 云信派对服务端海外的体验地址
    
    • 获取 AppKey 和 AppSecret 的方法请参见创建应用并获取 AppKey
    • BASE_URL 地址 https://yiyong.netease.im和BASE_URL_OVERSEA 地址 https://yiyong-sg.netease.im为云信派对服务端体验地址,该地址仅用于体验 Demo,单次最大体验时长为1小时,请勿用于生产环境
    • 如果您的应用的 AppKey 为海外,请设置 IS_OVERSEA 的值为 true
  4. 运行工程。

    建议在真机上运行,不支持模拟器调试。

  5. 一起听示例项目结构

    ├── KaraokeKit
    │   └── NEAudioEffectKit // 音效模块
    ├── OneOnOne
    │   └── NELoginSample // 登录模块
    ├── Party
    │   └── NESocialUIKit // 娱乐社交通用UI
    ├── PodConfigs // CocoaPods 配置
    ├── UIKit
    │   └── NEUIKit // 通用UI
    ├── VoiceRoomKit
    │   ├── ListenTogetherExample // 一起听主工程
    │   ├── NEListenTogetherUIKit // 一起听UI
    │   ├── NEOrderSong // 点歌模块
    │   └── NEVoiceRoomKit // 语聊房模块
    └── third_party // 第三方依赖
    
此文档是否对你有帮助?
有帮助
去反馈
  • 开发环境
  • 前提条件
  • 运行示例源码