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。

当视频源为合图视频流 (AgoraVideoSourceTypeTransCoded) 时，该参数表示发布合图视频流的用户 ID。

subviewUid

发布某一路合图子视频流的用户 ID。

view

视频显示窗口。

注意

在一个 AgoraRtcVideoCanvas 中，你只能选择 view 或 surfaceTexture 其中一个进行设置，如果同时设置，只有 view 中的设置会生效。

renderMode

视频渲染模式，详见 AgoraVideoRenderMode。

mirrorMode

视图镜像模式，详见 AgoraVideoMirrorMode。

注意

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

sourceType

视频源的类型，详见 AgoraVideoSourceType。

setupMode

视图设置模式。详见 AgoraVideoViewSetupMode。

mediaPlayerId

媒体播放器 ID。可通过 getMediaPlayerId 获取。

当 sourceType 为 AgoraVideoSourceTypeMediaPlayer 时，此参数为必填项。

cropArea

（可选）视频帧的展示区域，详见 CGRect。其中，width 和 height 表示该区域的视频像素宽度和高度。默认值为空值 (宽或高为 0)，表示展示实际分辨率的视频帧。

backgroundColor

视频画布的背景颜色，格式为 RGBA。默认值为 0x00000000，代表完全透明的黑色。

enableAlphaMask

（可选）是否开启 Alpha 遮罩渲染：

• YES：开启 Alpha 遮罩渲染。
• NO：（默认）关闭 Alpha 遮罩渲染。

Alpha 遮罩渲染可以创建具有透明效果的图像，还可以提取视频中的人像。与其他方法结合使用时，可以实现人像画中画、添加水印等效果。

position

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