初始化相关
- Flutter
更新时间不可用
registerEventHandler
添加主回调事件。
void registerEventHandler(RtcEngineEventHandler eventHandler);接口类 RtcEngineEventHandler 用于 SDK 向 App 发送回调事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。 接口类的所有方法都有缺省（空）实现，App 可以根据需要只继承关心的事件。在回调方法中，App 不应该做耗时或者调用可能会引起阻塞的 API（如 sendStreamMessage）， 否则可能影响 SDK 的运行。
参数
| 参数名 | 描述 |
|---|---|
eventHandler | 待添加的回调事件，详见 RtcEngineEventHandler。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
createAgoraRtcEngine
创建 RtcEngine 对象。
RtcEngine createAgoraRtcEngine() {
return impl.RtcEngineImpl.create();
}目前 RTC SDK v6.x 只支持每个 App 创建一个 RtcEngine 对象。
返回值
RtcEngine 对象。
所属接口类
createAgoraRtcEngineEx
创建 RtcEngineEx 对象。
RtcEngineEx createAgoraRtcEngineEx() {
return impl.RtcEngineImpl.create();
}目前 RTC v6.x SDK 只支持每个 App 创建一个 RtcEngineEx 对象。
返回值
RtcEngineEx 对象。
所属接口类
getMediaEngine
获取 MediaEngine 对象。
MediaEngine getMediaEngine();注： 该方法需要在初始化 RtcEngine 对象后调用。
返回值
MediaEngine 对象。
所属接口类
initialize
初始化 RtcEngine。
Future<void> initialize(RtcEngineContext context);调用时机
请确保在调用其他 API 前先调用 createAgoraRtcEngine 和 initialize 创建并初始化 RtcEngine。
参数
| 参数名 | 描述 |
|---|---|
context | RtcEngine 实例的配置。详见 RtcEngineContext。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
-
< 0：方法调用失败。
- -1: 一般性的错误（未明确归类）。
- -2: 设置了无效的参数。
- -7: SDK 初始化失败。
- -22: 资源申请失败。当 App 占用资源过多，或系统资源耗尽时，SDK 分配资源失败，会返回该错误。
- -101: App ID 无效。
所属接口类
initialize
创建一个 MediaPlayerController。
Future<void> initialize();所属接口类
release
销毁 RtcEngine 对象。
Future<void> release({bool sync = false});该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，不需要时则将资源释放出来用于其他操作，该方法适用于此类情况。 调用该方法后，你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能， 你必须依次重新调用 createAgoraRtcEngine 和 initialize 方法创建一个新的 RtcEngine 对象。
参数
所属接口类
unregisterEventHandler
删除指定的回调事件。
void unregisterEventHandler(RtcEngineEventHandler eventHandler);该方法用于删除已添加的所有回调事件。
参数
| 参数名 | 描述 |
|---|---|
eventHandler | 待删除的回调事件。详见 RtcEngineEventHandler。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。