# 初始化相关 (/zh-CN/api-reference/rtc/electron/initialize) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## registerEventHandler [#registereventhandler] 添加主回调事件。 ```ts abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; ``` 接口类 [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineeventhandler) 用于 SDK 向 App 发送回调事件通知,App 通过继承该接口类的方法获取 SDK 的事件通知。 接口类的所有方法都有缺省(空)实现,App 可以根据需要只继承关心的事件。在回调方法中,App 不应该做耗时或者调用可能会引起阻塞的 API(如 [sendStreamMessage](/zh-CN/api-reference/rtc/electron/metadata/datastream#api_irtcengine_sendstreammessage)), 否则可能影响 SDK 的运行。 ### 参数 [#参数] 待添加的回调事件,详见 [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineeventhandler)。 ### 返回值 [#返回值] - true:方法调用成功。 - false:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## addListener [#addlistener] 添加一个 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent) 监听器。 ```ts addListener?( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; ``` 成功调用该方法后,你可以通过 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent) 监听对应 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 对象的事件、获取数据。根据业务需要,你可以为同一事件添加多个监听器。 ### 参数 [#参数-1] 需要监听的目标事件名。详见 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent)。 `eventType` 对应的回调函数。以添加 [onJoinChannelSuccess](/zh-CN/api-reference/rtc/electron/channel#callback_irtcengineeventhandler_onjoinchannelsuccess) 为例: ```text const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess); ``` ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## createAgoraRtcEngine [#createagorartcengine] 创建 [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex) 对象。 ```ts export function createAgoraRtcEngine(): IRtcEngineEx { return instance; } ``` 目前 RTC SDK v4.x 只支持每个 App 创建一个 [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex) 对象。 ### 返回值 [#返回值-1] [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex) 对象。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## getMediaEngine [#getmediaengine] 获取 [IMediaEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_imediaengine) 对象。 ```ts abstract getMediaEngine(): IMediaEngine; ``` :::note 注: 该方法需要在初始化 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 对象后调用。 ::: ### 返回值 [#返回值-2] [IMediaEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_imediaengine) 对象。 ### 所属接口类 [#所属接口类-3] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## initialize [#initialize] 创建并初始化 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)。 ```ts abstract initialize(context: RtcEngineContext): number; ``` :::note 注: [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。 SDK 只支持每个 App 创建一个 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 实例。 ::: ### 调用时机 [#调用时机] 请确保在调用其他 API 前先调用 [createAgoraRtcEngine](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_createagorartcengine) 和 [initialize](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_initialize) 创建并初始化 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)。 ### 参数 [#参数-2] [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 实例的配置。详见 [RtcEngineContext](/zh-CN/api-reference/rtc/electron/class-rtcengineconfig)。 ### 返回值 [#返回值-3] - 0: 方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -1: 一般性的错误(未明确归类)。 - -2: 设置了无效的参数。 - -7: SDK 初始化失败。 - -22: 资源申请失败。当 App 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。 - -101: App ID 无效。 ### 所属接口类 [#所属接口类-4] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## release [#release] 销毁 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 对象。 ```ts abstract release(sync?: boolean): void; ``` 该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作,该方法适用于此类情况。 调用该方法后,你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能, 你必须依次重新调用 [createAgoraRtcEngine](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_createagorartcengine) 和 [initialize](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_initialize) 方法创建一个新的 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 对象。 :::note 注: - 该方法为同步调用。需要等待 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 资源释放后才能执行其他操作(例如:创建一个新的 [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) 对象),因此建议在子线程中调用该方法,避免主线程阻塞。 - 不建议在 SDK 的回调中调用 [release](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_release),否则由于 SDK 要等待回调返回才能回收相关的对象资源,会造成死锁。 ::: ### 参数 [#参数-3] 该方法是否为同步调用: - true\:该方法为同步调用。 - false\:该方法为异步调用。目前该方法仅支持同步调用,请不要将该参数设置为该值。 ### 所属接口类 [#所属接口类-5] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## removeAllListeners [#removealllisteners] 移除指定事件类型的所有监听器。 ```ts removeAllListeners?( eventType?: EventType ): void; ``` ### 参数 [#参数-4] 需要监听的目标事件名。详见 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent)。 ### 所属接口类 [#所属接口类-6] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## unregisterEventHandler [#unregistereventhandler] 删除指定的回调事件。 ```ts abstract unregisterEventHandler(eventHandler: IRtcEngineEventHandler): boolean; ``` 该方法用于删除已添加的所有回调事件。 ### 参数 [#参数-5] 待删除的回调事件。详见 [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineeventhandler)。 ### 返回值 [#返回值-4] - true: 方法调用成功。 - false: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-7] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine) ## removeListener [#removelistener] 移除指定的 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent) 监听器。 ```ts removeListener?( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; ``` 对于某些已监听的回调函数,如果你在收到相应回调事件后无需再次接收回调消息,可以调用该方法移除对应的监听器。 ### 参数 [#参数-6] 需要监听的目标事件名。详见 [IRtcEngineEvent](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineevent)。 `eventType` 对应的回调函数。必须传入 [addListener](/zh-CN/api-reference/rtc/electron/initialize#api_irtcengine_addlistener) 中传入的同一个函数对象。以取消监听 [onJoinChannelSuccess](/zh-CN/api-reference/rtc/electron/channel#callback_irtcengineeventhandler_onjoinchannelsuccess) 为例: ```text const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {}; engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess); engine.removeListener('onJoinChannelSuccess', onJoinChannelSuccess); ``` ### 所属接口类 [#所属接口类-8] - [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)