AgoraRtcVideoCanvas

用于设置视频画布的各项属性。

Objective-C

__attribute__((visibility("default"))) @interface AgoraRtcVideoCanvas : NSObject
@property(assign, nonatomic) NSUInteger uid;
@property(assign, nonatomic) NSUInteger subviewUid;
@property(strong, nonatomic) VIEW_CLASS *_Nullable view;
@property(assign, nonatomic) AgoraVideoRenderMode renderMode;
@property(assign, nonatomic) AgoraVideoMirrorMode mirrorMode;
@property(assign, nonatomic) AgoraVideoViewSetupMode setupMode;
@property(nonatomic, assign) AgoraVideoSourceType sourceType;
@property(nonatomic, assign) int mediaPlayerId;
@property(assign, nonatomic) CGRect cropArea;
@property(assign, nonatomic) UInt32 backgroundColor;
@property(assign, nonatomic) BOOL enableAlphaMask;
@property(assign, nonatomic) AgoraVideoModulePosition position;
@end

uid

发布视频源的用户 ID。

subviewUid

视频显示窗口的用户 ID。

信息

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

view

视频显示窗口。

信息

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

renderMode

视频的渲染模式，详见 AgoraVideoRenderMode。

mirrorMode

视图的镜像模式，详见 AgoraVideoMirrorMode。

信息

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

setupMode

视图的设置模式，详见 AgoraVideoViewSetupMode。

sourceType

视频源的类型，详见 AgoraVideoSourceType。

mediaPlayerId

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

cropArea

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

backgroundColor

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

enableAlphaMask

信息

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

是否启用 Alpha 蒙版渲染：

• YES：启用 Alpha 蒙版渲染。
• NO：（默认）不启用 Alpha 蒙版渲染。

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

position

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