初始化相关

  • HarmonyOS

更新时间不可用

createEngine

创建并初始化 RtcEngine。

TypeScript
public static createEngine(context: Context, appID: string, handler: IRtcEngineEventHandler): RtcEngine {
    let config = new RtcEngineConfig();
    config.mContext = context;
    config.mAppId = appID;
    config.mEventHandler = handler;
    return RtcEngineImpl.createEngineImpl(config);
  }

详情

RtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。

注意:

  • 请确保在调用其他 API 前先调用该方法创建并初始化 RtcEngine。
  • SDK 只支持每个 App 创建一个 RtcEngine 实例。

参数

参数名描述
context

上下文。

appId

声网为 App 开发者签发的 App ID。 使用同一个 App ID 的 App 才能进入同一个频道进行通话或直播。一个 App ID 只能用于创建一个 RtcEngine。如需更换 App ID,必须先调用 destroy 销毁当前 RtcEngine 再重新创建。

handler

RtcEngine 的事件句柄,详见 IRtcEngineEventHandler。

表格内容超出当前宽度,可横向滚动查看更多列。

返回/异常

  • 方法调用成功,返回一个 RtcEngine 对象。
  • 方法调用失败,抛出异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

create

创建并初始化 RtcEngine。

TypeScript
public static create(config: RtcEngineConfig): RtcEngine {
    return RtcEngineImpl.createEngineImpl(config);
  }

注意: RtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。

调用时机

请确保在调用其他 API 前先调用该方法创建并初始化 RtcEngine。

调用限制

SDK 只支持每个 App 创建一个 RtcEngine 实例。

参数

参数名描述
config

RtcEngine 实例的配置。详见 RtcEngineConfig。

表格内容超出当前宽度,可横向滚动查看更多列。

返回/异常

  • 方法调用失败,抛出异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

destroy

销毁 RtcEngine 对象。

TypeScript
public static destroy(): Promise<void> {
    return RtcEngineImpl.destroyEngine();
  };

详情

该方法释放 SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,不需要时则将资源释放出来用于其他操作,该方法适用于此类情况。

注意:

  • 该方法为同步调用。需要等待 RtcEngine 资源释放后才能执行其他操作(例如:创建一个新的 RtcEngine 对象),因此建议在子线程中调用该方法,避免主线程阻塞。
  • 不建议在 SDK 的回调中调用 destroy,否则由于 SDK 要等待回调返回才能回收相关的对象资源,会造成死锁。

所属接口类