测试环境废弃说明
  • 平台类型
  • 框架 / 引擎
  • iOS
  • Android
  • macOS
  • Windows
  • Linux
  • Web
  • 小程序

测试环境废弃说明

更新时间:2021-11-18 20:49

概述

为提供更便捷、更标准的服务,ZEGO 已统一环境概念,2021-11-16 之后,不再有正式环境/测试环境之分,2021-11-16 及之前在 ZEGO 控制台 创建项目的用户,可参考本文档进行 SDK 升级和调整相关代码。

各产品指引请参考下表:

  • 不在此表格内的产品及平台/框架,暂不涉及废弃测试环境。
  • 您可以参考以上产品的“示例源码”进行对应代码的调整。

升级说明

实时音视频

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Android

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();

ZegoExpressEngine.createEngine(profile, null);

macOS

  • 如果您使用的是 Objective-C:

    1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

    2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

      ZegoEngineProfile *profile = [ZegoEngineProfile new];
      profile.appID = appID; 
      profile.appSign = appSign; 
      profile.scenario = ZegoScenarioGeneral; 
      
      [ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
  • 如果您使用的是 C++:

    1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

    2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

      ZegoEngineProfile profile;
      profile.appID = appID;
      profile.appSign = appSign;
      profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;
      
      ZegoExpressSDK::createEngine(profile, nullptr);

Windows

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;

ZegoExpressSDK::createEngine(profile, nullptr);

Web

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本平台的功能是默认开启的,可直接使用,正式环境下本平台的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本平台的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

小程序

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本平台的功能是默认开启的,可直接使用,正式环境下本平台的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本平台的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

Flutter

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = ZegoEngineProfile(
    appID, 
    appSign, 
    ZegoScenario.General, 
    true);

ZegoExpressEngine.createEngineWithProfile(profile);

Electron

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 initWithProfile 接口,示例代码如下:

const profile = {
appID : xxx,
appSign : "xxx",
scenario : zgDefines.ZegoScenario.General
};

zgEngine.initWithProfile(profile)
.then(() => {
    console.log("init succeed")
}).catch((e) => {
    console.log("init failed", e)
});

Unity3D

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 CreateEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenario.General; 

ZegoExpressEngine.CreateEngine(profile);

uni-app

  1. 已集成最新版本的 SDK,请参考 实时音视频 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,示例代码如下:

const profile = {
appID : xxx,
appSign : "xxx",
scenario : 0
};

ZegoExpressEngine.createEngineWithProfile(profile)

实时语音

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Android

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();

ZegoExpressEngine.createEngine(profile, null);

macOS

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Windows

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;

ZegoExpressSDK::createEngine(profile, nullptr);

Web

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本平台的功能是默认开启的,可直接使用,正式环境下本平台的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本平台的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

Flutter

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = ZegoEngineProfile(
    appID, 
    appSign, 
    ZegoScenario.General, 
    true);

ZegoExpressEngine.createEngineWithProfile(profile);

Electron

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 initWithProfile 接口,示例代码如下:

const profile = {
appID : xxx,
appSign : "xxx",
scenario : zgDefines.ZegoScenario.General
};

zgEngine.initWithProfile(profile)
.then(() => {
    console.log("init succeed")
}).catch((e) => {
    console.log("init failed", e)
});

Unity3D

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 CreateEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenario.General; 

ZegoExpressEngine.CreateEngine(profile);

uni-app

  1. 已集成最新版本的 SDK,请参考 实时语音 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,示例代码如下:

const profile = {
appID : xxx,
appSign : "xxx",
scenario : 0
};

ZegoExpressEngine.createEngineWithProfile(profile)

低延迟直播

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 低延迟直播 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Android

  1. 已集成最新版本的 SDK,请参考 低延迟直播 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();

ZegoExpressEngine.createEngine(profile, null);

macOS

  1. 已集成最新版本的 SDK,请参考 低延迟直播 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Windows

  1. 已集成最新版本的 SDK,请参考 低延迟直播 - 下载 SDK

  2. 初始化 SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;

ZegoExpressSDK::createEngine(profile, nullptr);

Web

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本平台的功能是默认开启的,可直接使用,正式环境下本平台的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本平台的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

超级白板

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本产品的功能是默认开启的,可直接使用,正式环境下本产品的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本产品的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 超级白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
  1. 初始化 ZegoSuperBoard SDK 时,使用 initWithConfig 接口时,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:
ZegoSuperBoardInitConfig * config = [ZegoSuperBoardInitConfig new];
config.appID = appID;
config.appSign = appSign;

[ZegoSuperBoardManager sharedInstance].delegate = self;

[[ZegoSuperBoardManager sharedInstance] initWithConfig:config complete:^(ZegoSuperBoardError errorCode) {
    if (errorCode == ZegoSuperBoardSuccess) {
         /** 初始化成功 */
    } else {
        /** 初始化失败 */
    }
}];

Android

  1. 已集成最新版本的 SDK,请参考 超级白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();

ZegoExpressEngine.createEngine(profile, null);
  1. 初始化 ZegoSuperBoard SDK 时,使用 init 接口时,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:
ZegoSuperBoardInitConfig config = new ZegoSuperBoardInitConfig();
config.appID = appID;
config.appSign = appSign;

ZegoSuperBoardManager.getInstance().init(this, config, new IZegoSuperBoardInitCallback() {
    @Override
    public void onInit(int errorCode) {
        Log.d(TAG, "init ZegoSuperBoardManager result: errorCode = [" + errorCode + "]");
        if (errorCode == ZegoSuperBoardError.ZegoSuperBoardSuccess) {
            /** 初始化成功 */
        } else {
            /** 初始化失败 */
        }
    }
});

Web

  1. 已集成最新版本的 SDK,请参考 超级白板 - 下载 SDK

  2. 初始化 ZegoSuperBoard SDK 时,使用 init 接口时,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

zegoSuperBoard = ZegoSuperBoardManager.getInstance();
const result = await zegoSuperBoard.init(zg, {
    parentDomID: 'parentDomID',
    appID: 0,
    userID: '',
    token: ''
});

互动白板

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Android

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();

ZegoExpressEngine.createEngine(profile, null);

macOS

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngineWithProfile 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID; 
profile.appSign = appSign; 
profile.scenario = ZegoScenarioGeneral; 

[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];

Windows

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 createEngine 接口,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;

ZegoExpressSDK::createEngine(profile, nullptr);

Web

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本平台的功能是默认开启的,可直接使用,正式环境下本平台的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本平台的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

Electron

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 ZegoExpress-Video SDK 时,请使用最新的 initWithProfile 接口,示例代码如下:

zegoExpressEngine.initWithProfile({ appID: zegoauth.appID, appSign: zegoauth.appSign, scenario: 0 });

文件共享

  • 2021-11-16 及之前在 ZEGO 控制台 创建的项目,测试环境下本产品的功能是默认开启的,可直接使用,正式环境下本产品的功能不是默认开启的,如需使用按原有流程开通。
  • 2021-11-16 之后在 ZEGO 控制台 创建的项目,不再区分正式/测试环境,但是本产品的功能不是默认开启的,使用前请联系 ZEGO 技术支持开通。

各平台/框架的具体实现流程如下:

iOS

  1. 已集成最新版本的 SDK,请参考 文件共享 - 下载 SDK

  2. 初始化 SDK 时,使用 initWithConfig 接口时,不再需要设置 isTestEnv 区分正式/测试环境,示例代码如下:

ZegoDocsViewConfig *config = [ZegoDocsViewConfig new];
config.appSign = appSign; 
config.appID = appID;
config.dataFolder = [[NSHomeDirectory() stringByAppendingPathComponent:@"Documents/ZegoDocs"] stringByAppendingString:@"data"];
config.cacheFolder = [[NSHomeDirectory() stringByAppendingPathComponent:@"Documents/ZegoDocs"] stringByAppendingString:@"doc"];
config.logFolder = [[NSHomeDirectory() stringByAppendingPathComponent:@"Documents/ZegoDocs"] stringByAppendingString:@"log"];

[[ZegoDocsViewManager sharedInstance] initWithConfig:config completionBlock:^(ZegoDocsViewError errorCode) {
    if (errorCode == ZegoDocsViewSuccess) {
        NSLog(@"初始化 SDK 成功");
    } else {
        NSLog(@"初始化 SDK 失败 %ld",errorCode);
    }
}];

Android

  1. 已集成最新版本的 SDK,请参考 文件共享 - 下载 SDK

  2. 初始化 SDK 时,使用 init 接口时,不再需要设置 setTestEnv 区分正式/测试环境,示例代码如下:

ZegoDocsViewConfig config = new ZegoDocsViewConfig();  
config.setAppID(appID);
config.setAppSign(appSign);

ZegoDocsViewManager.getInstance().init(application,config, new IZegoDocsViewInitListener() {
    @Override
    public void onInit(int errorCode) {
        if (errorCode == 0) {
            /** 初始化成功 */
        } else {
            /** 初始化失败 */
        }
    }
});

Web

  1. 已集成最新版本的 SDK,请参考 文件共享 - 下载 SDK

  2. 初始化 SDK 时,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

const zegoExpressDocs = new window.ZegoExpressDocs({appID, token, userID});

Electron

  1. 已集成最新版本的 SDK,请参考 互动白板 - 下载 SDK

  2. 初始化 SDK 时,不再需要设置 isTestEnv 参数区分正式/测试环境,示例代码如下:

const zegoExpressDocs = new ZegoExpressDocs({
    appID, 
    appSign,
    dataFolder, 
    cacheFolder, 
    logFolder
});

本地服务端录制

SetUseTestEnv 即将废弃,请删除该接口的相关代码,还可参考下文 “常见问题” 中的 “如何做项目的数据隔离?”进行区分正式/测试环境。

服务端 API v2

所有接口的公共请求参数 isTest,默认值为 false,表示正式环境。

  • 针对 2021-11-16 及之前在 ZEGO 控制台 创建的项目:
    • 从控制台申请的 AppID 和 AppSign 等信息默认是测试环境。
    • 可根据 AppId 环境类型及业务需求设置本参数。
  • 针对 2021-11-16 之后在 ZEGO 控制台 创建的项目:
    • 从控制台申请的 AppID 和 AppSign 等信息都为正式环境。
    • 必须将此参数修改为 “false”,表示使用正式环境。

常见问题

如何做项目的数据隔离?

您可以在 ZEGO 控制台 创建 2 个项目,1 个作为测试使用,1 个作为正式使用,基于此进行项目的数据隔离。

为方便您的使用,控制台也提供了“项目阶段”的标识,您可以自行给项目标注当前所处阶段,比如“测试中”、“已上线”,方便您有多个项目时,也能进行区分而不混淆。