文档首页 > > SDK参考> Electron SDK> 接口参考> HRTCEngine>

基础接口

基础接口

分享
更新时间:2021/01/07 GMT+08:00

initialize

initialize(appId: string, domain: string): number

功能说明

初始化RTCEngine 实例。

请求参数

  • appId:必选,string[128]类型,应用的APP ID需提交工单申请。
  • domain:可选,string[128]类型,服务器的域名。需要与注册到RTC平台的合法企业域名保持一致。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

release

release(): number

功能说明

释放RTCEngine实例。

请求参数

返回参数

number类型,0表示调用成功,其它表示调用失败。

getVersion

getVersion(): string

功能说明

获取SDK版本号。

请求参数

返回参数

string类型。

joinRoom

joinRoom(roomId: string, userInfo: HRTCUserInfo): number

功能说明

加入房间。

请求参数

  • roomId:必选,string[128]类型,房间ID。
  • userInfo:必选,HRTCUserInfo类型。
  • HRTCUserInfo: {
    • userId:必选,string[128]类型,用户标识,userId需要保证应用内唯一。
    • userName:可选,string[128]类型,用户昵称,该昵称为UTF-8编码。
    • signature:必选,string[512]类型,鉴权签名字串,具体生成方法请参见接入鉴权
    • ctime:必选,number类型,UTC时间戳,单位秒。
    • role:必选,number类型,用户角色,可以标识媒体方向。
      • 0: 表示joiner,能够发送音视频和接受音视频。
      • 1: 表示publisher,只发送自己的音视频媒体,不接收别人的音视频。
      • 2: 表示player,只接受别人的音视频,不发送自己的音视频媒体。
    • optionInfo:可选,string类型,optionInfo是一个Key,Value的JSON字串。

    }

返回参数

number类型,0表示调用成功,其它值表示调用失败。

leaveRoom

leaveRoom(): number

功能说明

离开房间。

请求参数

返回参数

number类型,0表示调用成功,其它值表示调用失败。

setUserRole

setUserRole(role: HRTCRoleType): number

功能说明

设置用户角色

请求参数

  • role:必选,HRTCRoleType类型,新的签名字符串。
  • HRTCRoleType: {
    • 0:双向流角色,可以发送流,也可以接受流。
    • 1:发布者角色,只发送流,不接收流。
    • 2:观看者角色,只接收流,不发送流。

    }

返回参数

number类型,0表示调用成功,其它值表示调用失败。

renewSignature

renewSignature(newSig: string, ctime: number): number

功能说明

更新签名

请求参数

  • newSig:必选,string类型,新的签名字符串。
  • ctime:必选,number类型,UTC时间戳,单位秒。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

setupLocalView

setupLocalView(view:Element):number

功能说明

设置本地视图及本地视图的显示模式。

请求参数

view:必选,Element类型,本地视频流先使用的本地视图。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

startRemoteStreamView

startRemoteStreamView(userId: string, view: Element, disableAdjustRes: boolean): number

功能说明

选看/订阅远端主流。

请求参数

  • userId:必选,string类型,远端视频流所属的用户ID。
  • view:必选,Element类型,本地视频流先使用的本地视图。
  • disableAdjustRes:必选, boolean类型,是否禁用下行分辨率自适应, true为禁用,false为启用。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

stopRemoteStreamView

stopRemoteStreamView(userId: string): number

功能说明

取消订阅远端主流。

请求参数

userId:必选,string类型,远端视频流所属的用户ID。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

startRemoteSubStreamView

startRemoteSubStreamView(userId:string,view:Element, disableAdjustRes: boolean):number

功能说明

订阅远端辅流。

请求参数

  • userId:必选,string类型,远端视频流所属的用户ID。
  • view:必选,Element类型,本地视频流先使用的本地视图。
  • disableAdjustRes:必选, boolean类型,是否禁用下行分辨率自适应, true为禁用,false为启用。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

stopRemoteSubStreamView

stopRemoteStreamView(userId: string): number

功能说明

取消订阅远端辅流。

请求参数

userId:必选,string类型,远端视频流所属的用户ID。

返回参数

number类型,0表示调用成功,其它值表示调用失败。

on

on(eventName: string, eventHandler: function): this

功能说明

监听运行时的事件。

请求参数

  • eventName:必选,string类型,监听的事件名称。
  • eventHandler:必选,function类型,事件对应的回调方法。

返回参数

this类型,返回HRTCEngine对象。

off

off(eventName: string, eventHandler: function): this

功能说明

取消监听运行时的事件。

请求参数

  • eventName:必选,string类型,监听的事件名称。
  • eventHandler:必选,function类型,事件对应的回调方法。

返回参数

this类型,返回HRTCEngine对象。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区论坛频道来与我们联系探讨

智能客服提问云社区提问