线上KTV
Android
示例源码
本地下载
服务端
示例源码
本地下载

示例源码分为GO娱乐 Android 客户端和服务端示例源码。下文介绍如何运行示例源码,推荐客户端与服务端配合使用,指引分为两部分:

  1. GO娱乐客户端示例源码运行指引
  2. GO娱乐服务端示例源码运行指引
  • 该示例源码仅供开发者接入时参考,ZEGO 不负责示例源码的后续维护。
  • 若开发者计划将该示例源码用于生产环境,请确保发布前进行充分测试,避免发生潜在问题造成损失。

1 GO娱乐客户端示例源码运行指引

1.1 准备环境

在运行示例源码前,请确保开发环境满足以下要求(以下说明以 macOS 开发电脑为例):

  • Android Studio 3.0 或以上版本。
  • 已经下载 Android SDK 30 和 Android SDK Platform-Tools 30。
  • 建议使用 Android 9.0 或以上版本,且支持音视频的 Android 设备或模拟器(推荐使用真机),如果是真机,请开启“允许调试”选项。
  • Android 设备、macOS 开发电脑已经连接到 Internet。

1.2 前提条件

已在 ZEGO 控制台 创建项目,并申请有效的 AppID 和 AppSign,详情请参考 控制台 - 项目管理

1.3 运行示例源码

  1. 在开发电脑中找到 Android Studio 软件图标。

    /Pics/GoEnjoy/online_KTV/SampleCodes/Android_Studio_icon.png

  2. 打开 Android Studio,单击 “Open an existing project”。

  3. 选择在本文档开头位置已下载好的示例源码并打开。

  4. 下载的示例源码中缺少 SDK 初始化所需的 APP_ID 和 APP_SIGN,需要修改 “src/main/java/im/zego/goEnjoy”(KTV)或 “src/main/java/im/zego/gochat”(互动播客)目录下的 “AuthConstants.java” 文件。请使用本文 2 前提条件 已获取的 AppID 和 AppSign 正确填写(注意:需要在 AppID 后加 “L”),否则示例源码无法正常运行。

    GO娱乐中包含 “KTV” 和“互动播客”两个项目,需要分别填写 APP_ID 和 APP_SIGN。开发者可以使用同一个 APP_ID 和 APP_SIGN,将不做项目区分。

    /**
     * 当从ZEGO申请到 APP_ID 和 APP_SIGN 之后,我们强烈建议将其通过服务器下发到APP,而不是保存在代码当中
     * 这里将其保存在代码当中,只是为了执行demo
     *
     * APP_ID,APP_SIGN: 从官网或者技术支持获取
     */
    public class AuthConstants {
        public final static long APP_ID = ;      // replace_tag:    public final static long APP_ID = YOUR_APP_ID;
        public final static String APP_SIGN = "";   // replace_tag:    public final static String APP_SIGN = YOUR_APP_SIGN;
    }

    同时需要将本地部署的GO娱乐的 host 地址配置在 “BackendApiConstants.java” 的对应字段中。

    /**
     * 独立部署业务后台之后,替换相应环境的地址
     */
    public class BackendApiConstants {
        // 业务后台地址(正式环境)
        public final static String BACKEND_API_URL = "";  
    }
  1. 配置环境参数 “isTestEnv”,可以设置为“测试环境”或“正式环境”,请开发者根据自己的实际环境进行配置。

    public static ZegoExpressEngine createEngine(long appID, String appSign, boolean isTestEnv, ZegoScenario scenario, Application application, IZegoEventHandler eventHandler) {
    
    }
  2. 选择一台 Android 真机设备(推荐)或模拟器链接到开发电脑,当该设备成功开启“开发者模式”和“USB 调试功能”后,可以看到 Android Studio 由下图:

    /Pics/GoEnjoy/online_KTV/SampleCodes/before_link_devices_Android.png

    变为下图:

    /Pics/GoEnjoy/online_KTV/SampleCodes/after_link_devices_Andriod.png

    说明 Android Studio 软件已成功连接到 Android 设备,可以将示例源码运行到该设备上了。

  3. 单击 Android Studio 软件上的 “build and run” 按钮,编译并运行示例源码。

    /Pics/GoEnjoy/online_KTV/SampleCodes/demo_build_Andriod.png

2 GO娱乐服务端示例源码运行指引

2.1 准备环境

在运行示例源码前,请确保开发环境满足以下要求:

  • 部署 Redis 服务器(KTV 的房间、观众、主持人、嘉宾的状态都会存储于 Redis)。
  • 安装 GO 语言开发环境。

2.2 前提条件

已在 ZEGO 控制台 创建项目,并申请有效的 AppID 和 ServerSecret,详情请参考 控制台 - 项目管理

2.3 运行示例源码

  1. 修改 “app.conf” 配置文件中如下配置项,配置好 Redis,以及 AppId、AppSecret。

    roomRedisAddr = "192.168.100.62:6379" # redis host
    roomRedisPassword = ""    # redis password
    roomRedisIndex = 8            # redis数据库
    
    AppId = 1234567890  #zego 控制台获取的AppId
    AppSecret = "eb2280544902dc1b7ab1fde3985bd083" # 从 zego 控制台获取的 ServerSecret
  2. 进入源码目录,然后执行如下命令:

    cd ktv_server/svr_ktv_room/;go run main.go

若运行过程中出现问题,请联系 ZEGO 技术支持。