ZEGO::EXPRESS::ZegoExpressSDK

Declared in ZegoExpressSDK.h

Includes

ZegoExpressSDK.h

Public Static Func Lists

createEngine - 创建引擎单例对象
destroyEngine - 异步销毁引擎单例对象
getEngine - 获取引擎单例对象
setEngineConfig - 设置引擎进阶配置，仅在创建引擎之前调用才生效
getVersion - 获取 SDK 版本号
setAndroidEnv - 设置 android 平台 JVM 以及 Context，Android 平台下 createEngine 之前必须调用

Public Static Func Docs

createEngine

public IZegoExpressEngine * createEngine (unsigned int appID, const std::string & appSign, bool isTestEnv, ZegoScenario scenario, std::shared_ptr< IZegoEventHandler > eventHandler)

创建引擎单例对象

Parameters
appID	为开发者签发的应用 ID，请从 ZEGO 管理控制台 ZEGO 申请，取值范围为 0~4294967295。
appSign	每个 AppID 对应的应用签名，请从 ZEGO 管理控制台申请。为 64 字符的字符串。每个字符范围为'0'~'9', 'a'~'z'。
isTestEnv	选择使用测试环境还是正式商用环境，正式环境需要在 ZEGO 管理控制台提交工单配置。测试环境为测试开发用，限制房间数为 30，用户数为 230。正式环境 App 正式上线用，ZEGO 会根据开发者在管理控制台提交的配置记录提供相应的服务资源。测试环境与正式环境是两套环境，不可互通。
scenario	所属的应用场景，开发者可根据所开发的 App 的场景选择其中一个，引擎会通过所设置的场景预设置一个针对具体场景的较为通用的设置。当设置具体场景后，开发者若有定制化参数设置，依然可以调用具体接口来设置具体参数。
eventHandler	事件通知回调。传 [nullptr] 则意味着不接收任何回调通知。之后也可通过 [setEventHandler] 进行设置

destroyEngine

public void destroyEngine ( *&IZegoExpressEngine engine, ZegoDestroyCompletionCallback callback)

异步销毁引擎单例对象

Parameters
engine	先前调用 createEngine 方法创建的引擎实例
callback	销毁引擎完成的通知回调，可监听此回调以确保设备硬件资源被释放完成。本回调只作为引擎内部资源释放完成的通知，开发者不可以在此回调内释放与引擎相关的资源。若开发者只使用 SDK 来实现音视频功能，该参数可传 [nullptr]。

getEngine

public IZegoExpressEngine * getEngine ()

获取引擎单例对象

setEngineConfig

public void setEngineConfig (ZegoEngineConfig config)

设置引擎进阶配置，仅在创建引擎之前调用才生效

Parameters
config	引擎进阶配置

getVersion

public std::string getVersion ()

获取 SDK 版本号

setAndroidEnv

public void setAndroidEnv (void * jvm, void * context)

设置 android 平台 JVM 以及 Context，Android 平台下 createEngine 之前必须调用

Parameters
jvm	Java 虚拟机对象
context	Android 上下文。必须保证在SDK生命周期里有效