VideoCanvas class
Properties of the video canvas object.
- Annotations
-
- @JsonSerializable.new(explicitToJson: true, includeIfNull: false)
Properties
- backgroundColor → int?
-
Background color of the video canvas in RGBA format. The default is 0x00000000, which represents black.
final
- cropArea → Rectangle?
-
(Optional) Display area of the video frame. See Rectangle. width and height represent the pixel width and height of the video in this area. The default is null (width or height is 0), which means the actual resolution of the video frame is displayed.
final
- enableAlphaMask → bool?
-
The receiver can only render alpha channel information when the sender enables the alpha transmission feature.
To enable alpha transmission, please contact technical support. (Optional) Whether to enable alpha mask rendering: true : Enable alpha mask rendering. false : (Default) Disable alpha mask rendering. Alpha mask rendering can create images with transparency effects and extract portraits from videos. When used with other methods, it can achieve effects such as portrait picture-in-picture or watermark overlays.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- mediaPlayerId → int?
-
Media player ID. You can get it through getMediaPlayerId.
final
- mirrorMode → VideoMirrorModeType?
-
View mirroring mode. See VideoMirrorModeType.
Local view mirroring mode: If you use the front camera, local view mirroring is enabled by default; if you use the rear camera, it is disabled by default.
Remote user view mirroring mode: Disabled by default.
final
- position → VideoModulePosition?
-
Position of the video frame in the video pipeline. See VideoModulePosition.
final
- renderMode → RenderModeType?
-
Video rendering mode. See RenderModeType.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setupMode → VideoViewSetupMode?
-
View setup mode. See VideoViewSetupMode.
final
- sourceType → VideoSourceType?
-
Type of video source. See VideoSourceType.
final
- subviewUid → int?
-
User ID that publishes a specific composite sub-video stream.
final
- uid → int?
-
For Android and iOS platforms, when the video source is a composite video stream (videoSourceTranscoded), this parameter indicates the user ID that publishes the composite video stream.
final
- view → int?
-
Video display window. In a VideoCanvas, you can only set either view or surfaceTexture. If both are set, only the configuration in view takes effect.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited