初始化相关
createAgoraRtcEngine
initialize
初始化 IRtcEngine
。
C++
virtual int initialize(const RtcEngineContext& context) = 0;
注意
IRtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。
调用时机
请确保在调用其他 API 前先调用 createAgoraRtcEngine 和 initialize 创建并初始化 IRtcEngine。
调用限制
SDK 只支持每个 App 创建一个 IRtcEngine 实例。
参数
- context
IRtcEngine 实例的配置。详见 RtcEngineContext。
返回值
- 0: 方法调用成功。
- < 0:方法调用失败。
- -1: 一般性的错误(未明确归类)。
- -2: 设置了无效的参数。
- -7: SDK 初始化失败。
- -22: 资源申请失败。当 App 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。
- -101: App ID 无效。
release
销毁 IRtcEngine
对象。
C++
virtual void release(bool sync = false) = 0;
详情
该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作,该方法适用于此类情况。
调用该方法后,你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能, 你必须依次重新调用 createAgoraRtcEngine 和 initialize 方法创建一个新的 IRtcEngine 对象。
注意
- 该方法为同步调用。需要等待 IRtcEngine 资源释放后才能执行其他操作(例如:创建一个新的 IRtcEngine 对象),因此建议在子线程中调用该方法,避免主线程阻塞。
- 不建议在 SDK 的回调中调用 release,否则由于 SDK 要等待回调返回才能回收相关的对象资源,会造成死锁。
参数
- sync
该方法是否为同步调用:
true
:该方法为同步调用。false
:该方法为异步调用。目前该方法仅支持同步调用,请不要将该参数设置为该值。