createEngine static method

  1. @Deprecated('此函数在 2.14.0 版本及以上已废弃，请使用不带 [isTestEnv] 参数的同名函数代替。')
Future<void> createEngine(
  1. int appID,
  2. String appSign,
  3. bool isTestEnv,
  4. ZegoScenario scenario,
  5. {bool? enablePlatformView}
)

【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。此函数在 2.14.0 版本及以上已废弃，请使用不带 isTestEnv 参数的同名函数代替。请参考 测试环境废弃说明

支持版本：1.1.0 ~ 2.13.1，此函数在 2.14.0 版本及以上已废弃，请使用不带 isTestEnv 参数的同名函数代替。 详情描述：创建 ZegoExpressEngine 单例对象并初始化 SDK。 调用时机：SDK 其他实例方法调用之前。 使用限制：无。 注意事项：SDK 只支持创建一个实例，如需重复调用 createEngine ，则需在第二次调用 createEngine 前先调用 destroyEngine 函数销毁引擎，否则再次调用此函数返回的都是上次创建的对象。

@deprecated 此函数在 2.14.0 版本及以上已废弃，请使用不带 isTestEnv 参数的同名函数代替。

  • appID ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台 https://console-express.zego.im 申请。appID 取值范围 0~4294967295。
  • appSign 每个 AppID 对应的应用签名，请从 ZEGO 管理控制台申请。该参数为包含 64 个字符的字符串，字符取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。2.17.0 及以上版本 appSign 允许传空或者不传。如果传空或者不传，则必须在调用 loginRoom 接口登录房间时将 token 填入 ZegoRoomConfig 参数中，用于鉴权。token 的生成方式请参考 使用 Token 鉴权 。
  • isTestEnv 【已废弃】为提供更便捷、更标准的服务，ZEGO 已统一环境概念，2021-11-16 之后，不再有正式环境/测试环境之分，2021-11-16 及之前在 ZEGO 控制台 创建项目的用户，可参考 测试环境废弃说明 进行 SDK 升级和调整相关代码。
  • scenario 房间场景，SDK 会针对指定的场景的做一些音视频配置优化以达成在此场景下最优的效果。指定场景后，开发者可以使用 setRoomScenario 来实现在不销毁引擎 destroyEngine 的前提下切换其他场景。指定场景后，开发者可以调用其他 API 来继续调整音视频配置。各个场景之间的差异以及如何选择合适的场景请参考 https://doc-zh.zego.im/article/16316
  • enablePlatformView 设置是否使用 Platform View 渲染；true 表示使用 Platform View 渲染；false 表示使用 Texture 渲染；默认为 false。目前 web 平台只支持使用 Platform View 渲染。使用 createCanvasView 接口时，如果不支持优先使用的渲染模式，则会自动使用另一个渲染模式。

Implementation

@Deprecated('此函数在 2.14.0 版本及以上已废弃，请使用不带 [isTestEnv] 参数的同名函数代替。')
static Future<void> createEngine(
    int appID, String appSign, bool isTestEnv, ZegoScenario scenario,
    {bool? enablePlatformView}) async {
  return await ZegoExpressImpl.createEngine(
      appID, appSign, isTestEnv, scenario,
      enablePlatformView: enablePlatformView);
}