VideoCanvas

  • HarmonyOS

更新时间不可用

视频画布对象的属性。

TypeScript
export class VideoCanvas{
  public static readonly RENDER_MODE_HIDDEN = 1;
  public static readonly RENDER_MODE_FIT = 2;
  public static readonly VIDEO_MIRROR_MODE_ENABLED = 1;
  public static readonly VIDEO_MIRROR_MODE_DISABLED = 2;

  public xcomponentId:string = '';
  public uid:number = 0;
  public renderMode:number = VideoCanvas.RENDER_MODE_HIDDEN;
  public mirrorMode:number = 0;
  public sourceType:Constants.VideoSourceType = Constants.VideoSourceType.CAMERA_PRIMARY;
  constructor(componentId:string) {
    this.xcomponentId = componentId;
  }
}

参数名描述
uid

发布视频源的用户 ID。

xcomponentId

XComponent 的 ID。对应 XComponent 的 libraryname 必须设置为 AGORA_LIB_NAME。如果你将该成员设置为空,表示取消绑定此前设置的 XComponent。

renderMode
  • RENDER_MODE_HIDDEN (1):优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,多出的视频将被截掉。
  • RENDER_MODE_FIT (2):优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频长宽与显示窗口不同,视窗上未被填满的区域将被涂黑。
mirrorMode
  • VIDEO_MIRROR_MODE_AUTO (0):SDK 决定镜像模式。如果你使用前置摄像头,默认启动本地视图镜像模式;如果你启用后置摄像头,默认关闭本地视图镜像模式。
  • VIDEO_MIRROR_MODE_ENABLED (1):开启本地视图的镜像模式。
  • VIDEO_MIRROR_MODE_DISABLED (2):关闭本地视图的镜像模式。

注意:

  • 本地视图镜像模式:如果你使用前置摄像头,默认启动本地视图镜像模式;如果你使用后置摄像头,默认关闭本地视图镜像模式。
  • 远端用户视图镜像模式:默认关闭远端用户的镜像模式。
sourceType

视频源的类型,详见 VideoSourceType。

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

这个页面有帮助吗?