初始化相关
- Electron
更新时间不可用
registerEventHandler
添加主回调事件。
abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean;接口类 IRtcEngineEventHandler 用于 SDK 向 App 发送回调事件通知，App 通过继承该接口类的方法获取 SDK 的事件通知。 接口类的所有方法都有缺省（空）实现，App 可以根据需要只继承关心的事件。在回调方法中，App 不应该做耗时或者调用可能会引起阻塞的 API（如 sendStreamMessage）， 否则可能影响 SDK 的运行。
参数
| 参数名 | 描述 |
|---|---|
eventHandler | 待添加的回调事件，详见 IRtcEngineEventHandler。 |
返回值
- true：方法调用成功。
- false：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
addListener
添加一个 IRtcEngineEvent 监听器。
addListener?<EventType extends keyof IRtcEngineEvent>(
eventType: EventType,
listener: IRtcEngineEvent[EventType]
): void;成功调用该方法后，你可以通过 IRtcEngineEvent 监听对应 IRtcEngine 对象的事件、获取数据。根据业务需要，你可以为同一事件添加多个监听器。
参数
| 参数名 | 描述 |
|---|---|
eventType | 需要监听的目标事件名。详见 IRtcEngineEvent。 |
listener |
|
所属接口类
createAgoraRtcEngine
创建 IRtcEngineEx 对象。
export function createAgoraRtcEngine(): IRtcEngineEx {
return instance;
}目前 RTC SDK v4.x 只支持每个 App 创建一个 IRtcEngineEx 对象。
返回值
IRtcEngineEx 对象。
所属接口类
getMediaEngine
获取 IMediaEngine 对象。
abstract getMediaEngine(): IMediaEngine;注： 该方法需要在初始化 IRtcEngine 对象后调用。
返回值
IMediaEngine 对象。
所属接口类
initialize
创建并初始化 IRtcEngine。
abstract initialize(context: RtcEngineContext): number;注： IRtcEngine 类的所有接口函数，如无特殊说明，都是异步调用，对接口的调用建议在同一个线程进行。 SDK 只支持每个 App 创建一个 IRtcEngine 实例。
调用时机
请确保在调用其他 API 前先调用 createAgoraRtcEngine 和 initialize 创建并初始化 IRtcEngine。
参数
| 参数名 | 描述 |
|---|---|
context | IRtcEngine 实例的配置。详见 RtcEngineContext。 |
返回值
-
0: 方法调用成功。
-
< 0：方法调用失败。详见错误码了解详情和解决建议。
- -1: 一般性的错误（未明确归类）。
- -2: 设置了无效的参数。
- -7: SDK 初始化失败。
- -22: 资源申请失败。当 App 占用资源过多，或系统资源耗尽时，SDK 分配资源失败，会返回该错误。
- -101: App ID 无效。
所属接口类
release
销毁 IRtcEngine 对象。
abstract release(sync?: boolean): void;该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，不需要时则将资源释放出来用于其他操作，该方法适用于此类情况。 调用该方法后，你将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通信功能， 你必须依次重新调用 createAgoraRtcEngine 和 initialize 方法创建一个新的 IRtcEngine 对象。
注：
- 该方法为同步调用。需要等待 IRtcEngine 资源释放后才能执行其他操作（例如：创建一个新的 IRtcEngine 对象），因此建议在子线程中调用该方法，避免主线程阻塞。
- 不建议在 SDK 的回调中调用 release，否则由于 SDK 要等待回调返回才能回收相关的对象资源，会造成死锁。
参数
所属接口类
removeAllListeners
移除指定事件类型的所有监听器。
removeAllListeners?<EventType extends keyof IMediaEngineEvent>(
eventType?: EventType
): void;参数
| 参数名 | 描述 |
|---|---|
eventType | 需要监听的目标事件名。详见 IRtcEngineEvent。 |
所属接口类
unregisterEventHandler
删除指定的回调事件。
abstract unregisterEventHandler(eventHandler: IRtcEngineEventHandler): boolean;该方法用于删除已添加的所有回调事件。
参数
| 参数名 | 描述 |
|---|---|
eventHandler | 待删除的回调事件。详见 IRtcEngineEventHandler。 |
返回值
- true: 方法调用成功。
- false: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
removeListener
移除指定的 IRtcEngineEvent 监听器。
removeListener?<EventType extends keyof IRtcEngineEvent>(
eventType: EventType,
listener: IRtcEngineEvent[EventType]
): void;对于某些已监听的回调函数，如果你在收到相应回调事件后无需再次接收回调消息，可以调用该方法移除对应的监听器。
参数
| 参数名 | 描述 |
|---|---|
eventType | 需要监听的目标事件名。详见 IRtcEngineEvent。 |
listener |
|