# 初始化相关 (/zh-CN/api-reference/rtc/unreal-blueprint/initialize) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## GetAgoraRtcEngine [#getagorartcengine] 创建 IRtcEngine 对象。 ```cpp UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine") static UAgoraBPuRtcEngine* GetAgoraRtcEngine(); ``` ### 详情 [#详情] 目前 RTC SDK v4.x 只支持每个 App 创建一个 IRtcEngine 对象。 ### 返回值 [#返回值] 指向 IRtcEngine 对象的指针。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine) ## Initialize [#initialize] 初始化 IRtcEngine。 ```cpp UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") int Initialize(const FRtcEngineContext& context); ``` :::caution 注意: IRtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。 ::: ### 调用时机 [#调用时机] 请确保在调用其他 API 前先调用 [GetAgoraRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_createagorartcengine) 和 Initialize 创建并初始化 IRtcEngine。 ### 调用限制 [#调用限制] SDK 只支持每个 App 创建一个 IRtcEngine 实例。 ### 参数 [#参数] [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine) 实例的配置。详见 [FRtcEngineContext](/zh-CN/api-reference/rtc/unreal-blueprint/class-rtcengineconfig)。 ### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0:方法调用失败。 - -1: 一般性的错误(未明确归类)。 - -2: 设置了无效的参数。 - -7: SDK 初始化失败。 - -22: 资源申请失败。当 App 占用资源过多,或系统资源耗尽时,SDK 分配资源失败,会返回该错误。 - -101: App ID 无效。 ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine) ## GetEventHandler [#geteventhandler] 获取事件处理器。 ```cpp UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine") void GetEventHandler(EAgoraBPuEventHandlerType& HandlerType, UAgoraBPuIRtcEngineEventHandler*& EventHandler, UAgoraBPuIRtcEngineEventHandlerEx* & EventHandlerEx); ``` 调用该方法获取事件处理器后,你可以调用 [AddBlueprintCallbackExecutor](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengine_addblueprintcallbackexecutor) 或 [AddBlueprintCallbackExecutorEx](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengineex_addblueprintcallbackexecutorex) 绑定对应的回调执行器。 ### 调用时机 [#调用时机-1] 调用 [GetAgoraRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_createagorartcengine) 后。 ### 调用限制 [#调用限制-1] 无。 ### 参数 [#参数-1] 输出参数,事件处理器类型。 - 1: EventHandler。 - 2: EventHandlerEx。 输出参数,返回一个指向 `UAgoraBPuIRtcEngineEventHandler` 事件处理器的指针。 输出参数,返回一个指向 `UAgoraBPuIRtcEngineEventHandlerEx` 事件处理器的指针。 ## AddBlueprintCallbackExecutor [#addblueprintcallbackexecutor] 添加一个蓝图回调执行器。 ```cpp UFUNCTION(BlueprintCallable, Category = "Agora|Event") void AddBlueprintCallbackExecutor(UAgoraBPuIRtcEngineEventHandlerCBExecutor* Executor); ``` 获取事件处理器后,你可以调用该方法绑定回调执行器,用于执行 [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengineeventhandler) 接口类下的相关回调。 ### 调用时机 [#调用时机-2] 调用 [GetEventHandler](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengine_geteventhandler) 获取事件处理器后。 ### 调用限制 [#调用限制-2] 无。 ### 参数 [#参数-2] 指向 `UAgoraBPuIRtcEngineEventHandlerCBExecutor` 类型的指针,用于执行 IRtcEngineEventHandler 接口类下的回调逻辑。 ## AddBlueprintCallbackExecutorEx [#addblueprintcallbackexecutorex] 添加一个蓝图回调执行器。 ```cpp UFUNCTION(BlueprintCallable, Category = "Agora|Event") void AddBlueprintCallbackExecutorEx(UAgoraBPuIRtcEngineEventHandlerExCBExecutor* Executor); ``` 获取事件处理器后,你可以调用该方法绑定回调执行器,用于执行 `IRtcEngineEventHandlerEx` 接口类下的相关回调。 ### 调用时机 [#调用时机-3] 调用 [GetEventHandler](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengine_geteventhandler) 获取事件处理器后。 ### 调用限制 [#调用限制-3] 无。 ### 参数 [#参数-3] 指向 `UAgoraBPuIRtcEngineEventHandlerExCBExecutor` 类型的指针,用于执行 `IRtcEngineEventHandlerEx` 接口类下的回调逻辑。 ## ClearAllEventHandlerCBExecutors [#clearalleventhandlercbexecutors] 清除所有已添加的回调执行器。 ```cpp UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") void ClearAllEventHandlerCBExecutors(); ``` 调用该方法后,所有回调执行器将被移除。如果需要继续处理事件回调,需要重新添加回调执行器。 ### 调用时机 [#调用时机-4] 调用 [AddBlueprintCallbackExecutor](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengine_addblueprintcallbackexecutor)、[AddBlueprintCallbackExecutorEx](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengineex_addblueprintcallbackexecutorex) 或 [AddBlueprintCallbackExecutor](/zh-CN/api-reference/rtc/unreal-blueprint/play/mediaplayer/mediaplayer-observer#api_imediaplayer_addblueprintcallbackexecutor) 添加回调执行器后。 ### 调用限制 [#调用限制-4] 无。 ## Release [#release] 销毁 IRtcEngine 对象。 ```cpp static void Release(bool sync = false); ``` ### 详情 [#详情-1] 该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作,该方法适用于此类情况。 调用该方法后,你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能, 你必须依次重新调用 [GetAgoraRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_createagorartcengine) 和 [Initialize](/zh-CN/api-reference/rtc/unreal-blueprint/initialize#api_irtcengine_initialize) 方法创建一个新的 IRtcEngine 对象。 :::caution 注意: - 该方法为同步调用。需要等待 IRtcEngine 资源释放后才能执行其他操作(例如:创建一个新的 IRtcEngine 对象),因此建议在子线程中调用该方法,避免主线程阻塞。 - 不建议在 SDK 的回调中调用 Release,否则由于 SDK 要等待回调返回才能回收相关的对象资源,会造成死锁。 ::: ### 参数 [#参数-4] 该方法是否为同步调用: - `true`\:该方法为同步调用。 - `false`\:该方法为异步调用。目前该方法仅支持同步调用,请不要将该参数设置为该值。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine)