Testing environment deprecation
Introduction
For providing better and more standardized services, starting from 2021-11-16, ZEGO no longer classifies environments into production environments and testing environments.
If you create your project in ZEGO Admin Console on/before 2021-11-16, refer to this document to upgrade the SDK and adjust related codes.
The following table helps you to quickly locate the specific instructions based on the product and platform:
Item | Product | Platform/Framework |
---|---|---|
Cloud Communications Products |
||
Supporting Services |
||
- |
||
Server API |
- |
Products/platforms/frameworks not included in this table are not currently involved in the testing environment deprecation.
To adjust your codes, refer to the Sample code of the corresponding product.
Upgrade notes
Real-Time Audio and Video
The platform/framework-specific instructions are as follows:
iOS
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Android
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();
ZegoExpressEngine.createEngine(profile, null);
macOS
If you are using Objective-C:
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:ZegoEngineProfile *profile = [ZegoEngineProfile new]; profile.appID = appID; profile.appSign = appSign; profile.scenario = ZegoScenarioGeneral; [ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
If you are using C++:
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:ZegoEngineProfile profile; profile.appID = appID; profile.appSign = appSign; profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL; ZegoExpressSDK::createEngine(profile, nullptr);
Windows
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;
ZegoExpressSDK::createEngine(profile, nullptr);
Web
If you create your project in ZEGO Admin Console on/before 2021-11-16:
- In the testing environment: The Web platform features are enabled by default and can be used directly.
- In the production environment: The Web platform features are not enabled by default. To use these features, you need to activate them according to the original process.
If you create your project in ZEGO Admin Console after 2021-11-16: The Web platform features are not enabled by default. To use these features, contact ZEGO Technical Support to activate them first.
Flutter
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = ZegoEngineProfile(
appID,
appSign,
ZegoScenario.General,
true);
ZegoExpressEngine.createEngineWithProfile(profile);
Electron
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
initWithProfile
method. The sample code is shown below:
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
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the
CreateEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.General;
ZegoExpressEngine.CreateEngine(profile);
uni-app
Integrate the latest version of SDK. For details, refer to the Real-Time Audio and Video - SDK downloads.
When initializing the SDK, you can directly call the createEngineWithProfile method. The sample code is shown below:
const profile = {
appID : xxx,
appSign : "xxx",
scenario : 0
};
ZegoExpressEngine.createEngineWithProfile(profile)
Real-Time Audio
The platform/framework-specific instructions are as follows:
iOS
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Android
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();
ZegoExpressEngine.createEngine(profile, null);
macOS
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Windows
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;
ZegoExpressSDK::createEngine(profile, nullptr);
Web
If you create your project in ZEGO Admin Console on/before 2021-11-16:
- In the testing environment: The Web platform features are enabled by default and can be used directly.
- In the production environment: The Web platform features are not enabled by default. To use these features, you need to activate them according to the original process.
If you create your project in ZEGO Admin Console after 2021-11-16: The Web platform features are not enabled by default. To use these features, contact ZEGO Technical Support to activate them first.
Flutter
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = ZegoEngineProfile(
appID,
appSign,
ZegoScenario.General,
true);
ZegoExpressEngine.createEngineWithProfile(profile);
Electron
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
initWithProfile
method. The sample code is shown below:
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
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the
CreateEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.General;
ZegoExpressEngine.CreateEngine(profile);
uni-app
Integrate the latest version of SDK. For details, refer to the Real-Time Audio - SDK downloads.
When initializing the SDK, you can directly call the createEngineWithProfile method. The sample code is shown below:
const profile = {
appID : xxx,
appSign : "xxx",
scenario : 0
};
ZegoExpressEngine.createEngineWithProfile(profile)
Low-Latency Live Streaming
The platform/framework-specific instructions are as follows:
iOS
Integrate the latest version of SDK. For details, refer to the Low-Latency Live Streaming - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Android
Integrate the latest version of SDK. For details, refer to the Low-Latency Live Streaming - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();
ZegoExpressEngine.createEngine(profile, null);
macOS
Integrate the latest version of SDK. For details, refer to the Low-Latency Live Streaming - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Windows
Integrate the latest version of SDK. For details, refer to the Low-Latency Live Streaming - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;
ZegoExpressSDK::createEngine(profile, nullptr);
Web
If you create your project in ZEGO Admin Console on/before 2021-11-16:
- In the testing environment: The Web platform features are enabled by default and can be used directly.
- In the production environment: The Web platform features are not enabled by default. To use these features, you need to activate them according to the original process.
If you create your project in ZEGO Admin Console after 2021-11-16: The Web platform features are not enabled by default. To use these features, contact ZEGO Technical Support to activate them first.
Collaborative Whiteboard
The platform/framework-specific instructions are as follows:
iOS
Integrate the latest version of SDK. For details, refer to the Collaborative Whiteboard - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Android
Integrate the latest version of SDK. For details, refer to the Collaborative Whiteboard - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario.GENERAL;
profile.application = getApplication();
ZegoExpressEngine.createEngine(profile, null);
macOS
Integrate the latest version of SDK. For details, refer to the Collaborative Whiteboard - SDK downloads.
When initializing the SDK, you can directly call the
createEngineWithProfile
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile *profile = [ZegoEngineProfile new];
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenarioGeneral;
[ZegoExpressEngine createEngineWithProfile:profile eventHandler:self];
Windows
Integrate the latest version of SDK. For details, refer to the Collaborative Whiteboard - SDK downloads.
When initializing the SDK, you can directly call the
createEngine
method and no longer need to set theisTestEnv
property. The sample code is shown below:
ZegoEngineProfile profile;
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_GENERAL;
ZegoExpressSDK::createEngine(profile, nullptr);
Web
If you create your project in ZEGO Admin Console on/before 2021-11-16:
- In the testing environment: The Web platform features are enabled by default and can be used directly.
- In the production environment: The Web platform features are not enabled by default. To use these features, you need to activate them according to the original process.
If you create your project in ZEGO Admin Console after 2021-11-16: The Web platform features are not enabled by default. To use these features, contact ZEGO Technical Support to activate them first.
Electron
Integrate the latest version of SDK. For details, refer to the Collaborative Whiteboard - SDK downloads.
When initializing the SDK, you can directly call the
initWithProfile
method. The sample code is shown below:
zegoExpressEngine.initWithProfile({ appID: zegoauth.appID, appSign: zegoauth.appSign, scenario: 0 });
File Sharing
If you create your project in ZEGO Admin Console on/before 2021-11-16:
- In the testing environment: The product features are enabled by default and can be used directly.
- In the production environment: The product features are not enabled by default. To use these features, you need to activate them according to the original process.
If you create your project in ZEGO Admin Console after 2021-11-16: The product features are not enabled by default. To use these features, contact ZEGO Technical Support to activate them first.
The platform/framework-specific instructions are as follows:
iOS
Integrate the latest version of SDK. For details, refer to the File Sharing - SDK downloads.
When initializing the SDK, you can directly call the
initWithConfig
method and no longer need to set theisTestEnv
property. The sample code is shown below:
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 initialized successfully.");
} else {
NSLog(@"Failed to initialize the SDK. %ld",errorCode);
}
}];
Android
Integrate the latest version of SDK. For details, refer to the File Sharing - SDK downloads.
When initializing the SDK, you can directly call the
init
method and no longer need to set thesetTestEnv
property. The sample code is shown below:
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) {
/** Initialization successful.*/
} else {
/** Initialization failed. */
}
}
});
Web
Integrate the latest version of SDK. For details, refer to the File Sharing - SDK downloads.
When initializing the SDK, you will no longer need to set the
isTestEnv
property. The sample code is shown below:
const zegoExpressDocs = new window.ZegoExpressDocs({appID, token, userID});
Electron
Integrate the latest version of SDK. For details, refer to the File Sharing - SDK downloads.
When initializing the SDK, you will no longer need to set the
isTestEnv
property. The sample code is shown below:
const zegoExpressDocs = new ZegoExpressDocs({
appID,
appSign,
dataFolder,
cacheFolder,
logFolder
});
On-Premises Recording
The method SetUseTestEnv
will be deprecated soon. We recommend you delete the codes related to this method.
To classify the testing environments and production environments, you can also refer to the FAQ - How to isolate the data of different projects? in the following session.
Server API v2
By default, the public request parameter isTest
for all APIs is set to false
, indicating the production environments.
- For the projects created in ZEGO Admin Console on/before 2021-11-16:
- The AppID and AppSign you get from the ZEGO Admin Console are by default for use in the testing environment.
- You can set the "isTest" parameter based on the actual environement type (can tell by the AppID) and business needs.
- For the projects created in ZEGO Admin Console after 2021-11-16:
- The AppID and Appsign you get from the ZEGO Admin Console are by default for use in the production environemtn.
- You need to set the "isTest" parameter to "false" to use the production environment.
FAQ
How to isolate the data of different projects?
You can create two different projects in ZEGO Admin Console, one for testing environment and one for production environment.
To make it easier for you to distinguish your projects, ZEGO Admin Console also provides the "stage of project" tags, such as "testing", "online", etc. You can tag your projects accordingly.