VideoCanvas class
Attributes of the video canvas object.
- Annotations
-
- @JsonSerializable(explicitToJson: true, includeIfNull: false)
Properties
- backgroundColor → int?
-
The background color of the video canvas in RGBA format. The default value is 0x00000000, which represents completely transparent black.
final
- cropArea → Rectangle?
-
(Optional) Display area of the video frame, see Rectangle. width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.
final
- enableAlphaMask → bool?
-
(Optional) Whether the receiver enables alpha mask rendering: true : The receiver enables alpha mask rendering. false : (Default) The receiver disables alpha mask rendering. Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.
The receiver can render alpha channel information only when the sender enables alpha transmission.
To enable alpha transmission,.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- mediaPlayerId → int?
-
The ID of the media player. You can get the Device ID by calling getMediaPlayerId.
final
- mirrorMode → VideoMirrorModeType?
-
The mirror mode of the view. See VideoMirrorModeType.
For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
For the remote user: The mirror mode is disabled by default.
final
- position → VideoModulePosition?
-
The observation position of the video frame in the video link. See VideoModulePosition.
final
- renderMode → RenderModeType?
-
The rendering mode of the video. See RenderModeType.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setupMode → VideoViewSetupMode?
-
Setting mode of the view. See VideoViewSetupMode.
final
- sourceType → VideoSourceType?
-
The type of the video source. See VideoSourceType.
final
- subviewUid → int?
-
The ID of the user who publishes a specific sub-video stream within the mixed video stream.
final
- uid → int?
-
The user ID.
final
- view → int?
-
The video display window. In one VideoCanvas, you can only choose to set either view or surfaceTexture. If both are set, only the settings in view take effect.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited