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

视频基础功能

视频基础功能

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

enableLocalVideo

enableLocalVideo(enable: boolean): number

功能说明

开启/关闭本地视频采集。

请求参数

enable:必选,boolean类型。true表示开启,false表示关闭。

返回参数

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

muteLocalVideoStream

muteLocalVideoStream(mute: boolean): number

功能说明

停止/恢复发送本地视频流

请求参数

mute:必选,boolean类型。true表示停止,false表示恢复。

返回参数

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

setVideoEncParam

setVideoEncParam(encoderparam: HRTCVideoEncParam ): number

功能说明

设置视频流(默认流或者大流)的编码参数。

请求参数

  • encoderparam:必选,HRTCVideoEncParam 类型。
  • HRTCVideoEncParam: {
    • width:必选,number类型,分辨率的宽度,单位为pixel。
    • height:必选,number类型,分辨率的高度,单位为pixel。
    • frameRate:必选,number类型,视频帧率,单位为帧/秒。
    • bitrate:必选,number类型,视频码率,单位为Kbps。
    • disableAdjustRes:可选,boolean类型,禁用/启用下行分辨率自适应,true表示禁用,false表示启用。 默认为false。
    • minFrameRate:可选,number类型,视频最小帧率,单位为帧/秒。 默认为0。
    • minBitrate:可选,number类型,视频最小码率,单位为Kbps。默认为0。

    }

返回参数

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

enableSmallVideoStream

enableSmallVideoStream(enable: boolean, smallVideoParam:  HRTCVideoEncParam ): number

功能说明

是否激活视频流大小流功能,并设置小流的编码参数。

请求参数

  • enable:必选,boolean类型。true为激活,false表示不激活。
  • params:必选,HRTCVideoEncParam 类型。
  • HRTCVideoEncParam: {
    • width:必选,number类型,分辨率的宽度,单位为pixel。
    • height:必选,number类型,分辨率的高度,单位为pixel。
    • frameRate:必选,number类型,视频帧率,单位为帧/秒。
    • bitrate:必选,number类型,视频码率,单位为Kbps。
    • disableAdjustRes:可选,boolean类型,禁用/启用下行分辨率自适应,true表示禁用,false表示启用。 默认为false。
    • minFrameRate:可选,number类型,视频最小帧率,单位为帧/秒。默认为0。
    • minBitrate:可选,number类型,视频最小码率,单位为Kbps。默认为0。

    }

返回参数

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

【注意事项】

注意小流的编码参数要比大流的低,否则可能出现卡顿等问题。

setPriorRemoteVideoStreamType

setPriorRemoteVideoStreamType (type: HRTCVideoStreamType ): number

功能说明】。

设置默认选看的视频流类型

请求参数

type:必选,HRTCVideoStreamType 类型,0为大流,1为小流。该接口未调用时,默认选看类型为0。

返回参数

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

setRemoteVideoStreamType

setRemoteVideoStreamType (userId: string, type: HRTCVideoStreamType): number

功能说明

设置指定远端用户的当前选看的视频流类型.

请求参数

  • userId:必选,string类型,用户ID。
  • type:必选, HRTCVideoStreamType类型,0为大流,1为小流。

返回参数

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

setViewDisplayMode

setViewDisplayMode(userId: string | "local", mode: HRTCDisplayMode, isAux: boolean | undefined): number

功能说明

设置视频显示窗口的显示模式

请求参数

  • userId:必选,string类型, 用户ID,当设置本地视频的显示模式时,设置为“local”
  • mode:必选,HRTCDisplayMode类型,窗口的显示模式。
    • 0:表示优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,多出的视频将被截掉。
    • 1:表示优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同,视窗上未被填满的区域将被涂黑。
    • 2:表示视频尺寸进行缩放和拉伸以充满显示视窗。
  • isAux:可选,boolean类型, true表示设置辅流窗口的显示模式,false或空表示设置主流窗口的显示模式。

返回参数

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

startPreview

startPreview(): number

功能说明

开始RTC通话前,开启视频预览。

请求参数

返回参数

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

【注意事项】

开启通话前的视频预览后,如果需要发起RTC通话,需要先调用stopPreview将视频预览关闭。

stopPreview

stopPreview(): number

功能说明

开始RTC通话前,停止视频预览。

请求参数

返回参数

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

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问