VideoCanvas

用于配置视频画布的属性。

C++

struct VideoCanvas {
  uid_t uid;
  uid_t subviewUid;
  view_t view;
  uint32_t backgroundColor;
  media::base::RENDER_MODE_TYPE renderMode;
  VIDEO_MIRROR_MODE_TYPE mirrorMode;
  VIDEO_VIEW_SETUP_MODE setupMode;
  VIDEO_SOURCE_TYPE sourceType;
  int mediaPlayerId;
  Rectangle cropArea;
  bool enableAlphaMask;
  media::base::VIDEO_MODULE_POSITION position;
};

uid

发布视频源的用户 ID。

subviewUid

在视频合流中发布特定子视频流的用户 ID。

view

视频显示窗口。

信息

在一个 VideoCanvas 中，只能设置 view 或 surfaceTexture 其中之一。如果两者都设置，仅 view 的设置生效。

backgroundColor

视频画布的背景颜色，使用 RGBA 格式。默认值为 0x00000000，表示黑色。

renderMode

视频的渲染模式。详见 RENDER_MODE_TYPE。

mirrorMode

视图的镜像模式。详见 VIDEO_MIRROR_MODE_TYPE。

信息

• 本地视频视图的镜像模式：使用前置摄像头时，SDK 默认开启镜像模式；使用后置摄像头时，SDK 默认关闭镜像模式。
• 远端用户默认关闭镜像模式。

setupMode

视图的设置模式。详见 VIDEO_VIEW_SETUP_MODE。

sourceType

视频源的类型。详见 VIDEO_SOURCE_TYPE。

mediaPlayerId

媒体播放器的 ID。可通过调用 getMediaPlayerId 获取设备 ID。

cropArea

视频帧的显示区域。width 和 height 表示该区域的视频像素宽度和高度。默认值为 NULL（即 width 或 height 为 0），表示显示视频帧的实际分辨率。详见 Rectangle。

enableAlphaMask

信息

• 仅当发送端开启 Alpha 通道传输时，接收端才能渲染 Alpha 通道信息。
• 如需开启 Alpha 通道传输，请联系技术支持。

是否启用 Alpha 蒙版渲染：

• true：启用 Alpha 蒙版渲染。
• false：（默认）关闭 Alpha 蒙版渲染。

Alpha 蒙版渲染可创建具有透明效果的图像，并从视频中提取人像。结合其他方法使用时，可实现画中画、人像水印等效果。

position

视频帧在视频链路中的观测位置。详见 VIDEO_MODULE_POSITION。