文档首页/ 实时音视频 SparkRTC/ 客户端SDK参考/ All Platform C++ SDK/ 接口参考/ IHRTCEngine/ 初始化等基础接口
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

初始化等基础接口

createHRtcEngine

huawei::rtc::IHRTCEngine* createHRtcEngine(void);

【功能说明】

创建IHRTCEngine对象。

【返回参数】

  • huawei::rtc::IHRTCEngine*：IHRTCEngine对象。
  • NULL：创建失败。

getHRtcEngine

huawei::rtc::IHRTCEngine* getHRtcEngine(void);

【功能说明】

调用createHRtcEngine成功后，可通过该函数，获取IHRTCEngine对象。

【返回参数】

  • huawei::rtc::IHRTCEngine*：IHRTCEngine对象。
  • NULL：IHRTCEngine对象不存在时返回。

enableStats

virtual int enableStats(bool enabled)

【功能说明】

开启打点统计，在initialize前调用。

【请求参数】

enabled：是否开启打点，默认开启。

【返回参数】

  • 0：方法调用成功。
  • > 0：方法调用失败。具体请参见HRTCErrorCode。

initialize

virtual int initialize(const HRTCEngineContext &context);

【功能说明】

IHRtcEngine对象初始化函数。

【请求参数】

context：引擎初始化参数, 具体请参见HRTCEngineContext。

【返回参数】

  • 0：方法调用成功。
  • > 0：方法调用失败。具体请参见HRTCErrorCode。

release

virtual void release()

【功能说明】

释放IHRtcEngine对象资源。

如果资源已经释放，需要重新调用createHRtcEngine和initialize进行初始化。

logUpload

virtual int logUpload()

【功能说明】

开启日志上传。

【返回参数】

  • 0：方法调用成功。
  • > 0：方法调用失败。具体请参见HRTCErrorCode。
  • 加入房间后才能主动上传日志。
  • 会触发以下回调：

getVersion

virtual char* getVersion()

【功能说明】

获取当前SDK版本号。

【请求参数】

无

【返回参数】

SDK当前版本号。

getAudioDeviceManager

virtual IHRTCAudioDeviceManager* getAudioDeviceManager()

【功能说明】

获取系统音频设备管理对象。通过该对象进行音频设备管理，具体请参见音频设备管理。

【请求参数】

无

【返回参数】

  • IHRTCAudioDeviceManager*：IHRTCAudioDeviceManager对象。
  • NULL：返回失败。

getVideoDeviceManager

virtual IHRTCVideoDeviceManager* getVideoDeviceManager()

【功能说明】

获取系统视频设备管理对象。通过该对象进行视频设备管理，具体请参见视频设备管理。

【请求参数】

无

【返回参数】

  • IHRTCVideoDeviceManager*：IHRTCVideoDeviceManager对象。
  • NULL：返回失败。

setJniLoadParams

int setJniLoadParams(void *jvm, void *context);

【功能说明】

安卓全平台传递jvm context参数，需要在initialize之前设置。

setEncryption

virtual int setEncryption(const HRTCEncryptionConfig &cryption)

【功能说明】

设置端到端加密模式，必须调用接口，在加入房间前调用生效。

【请求参数】

cryption：加密参数，具体请参见HRTCEncryptionConfig。

【返回参数】
  • 0：方法调用成功。
  • >0：方法调用失败。具体请参见HRTCErrorCode。

setAccessResourceType

virtual int setAccessResourceType(int resType) = 0;

【功能说明】

设置接入的环境，不支持跨房间场景。

【请求参数】

resType：环境类型。

  • 0：公网sfu资源。
  • 1：公司局Sfu。

【返回参数】

  • 0：方法调用成功。
  • <0：方法调用失败。具体请参见HRTCErrorCode。

setAccessResourceType

virtual int setAccessResourceType(const char *resourceTags[HRTCConstant::HRTC_MAX_RESOURCE_TAG_COUNT], int num, int intranetType) = 0;

【功能说明】

指定使用的sfu服务器，设置接入的环境，不支持跨房间场景。

【请求参数】

resourceTags：资源标签，指定连接的sfu

num：资源标签数组长度

intranetType：环境类型。

  • 0：公网sfu资源。
  • 1：公司局Sfu。

【返回参数】

  • 0：方法调用成功。
  • <0：方法调用失败。具体请参见HRTCErrorCode。

setNetworkBandwidth

virtual int setNetworkBandwidth(const HRTCNetworkBandwidth &bandwidthParam)

【功能说明】

设置网络带宽限制，在每次加入房间之前调用。

【请求参数】

bandwidthParam：带宽设置参数，具体请参见HRTCNetworkBandwidth。

【返回参数】
  • 0：方法调用成功。
  • >0：方法调用失败。具体请参见HRTCErrorCode。

renewAppid

virtual int renewAppid(const char* appid)

【功能说明】

设置Appid，用来更新AppId，在加入房间调用前才会生效，否则只能下一次入会生效。

【请求参数】

appid：设置appid。

【返回参数】
  • 0：方法调用成功。
  • >0：方法调用失败。具体请参见HRTCErrorCode。
父主题： IHRTCEngine

相关文档