VideoTransformEffectDefinition VideoTransformEffectDefinition VideoTransformEffectDefinition VideoTransformEffectDefinition Class

Definition

Represents the definition of a video transform effect.

public : sealed class VideoTransformEffectDefinition : IVideoEffectDefinition, IVideoTransformEffectDefinitionpublic sealed class VideoTransformEffectDefinition : IVideoEffectDefinition, IVideoTransformEffectDefinitionPublic NotInheritable Class VideoTransformEffectDefinition Implements IVideoEffectDefinition, IVideoTransformEffectDefinition// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Use this class to add transformation effects to a video stream. Supported effects include rotation, mirroring, source clipping, destination mapping, and setting a padding color for areas in the frame that are not filled with input video.

Constructors

VideoTransformEffectDefinition() VideoTransformEffectDefinition() VideoTransformEffectDefinition() VideoTransformEffectDefinition()

Initializes a new instance of the VideoTransformEffectDefinition class.

public : VideoTransformEffectDefinition()public VideoTransformEffectDefinition()Public Sub New()// You can use this method in JavaScript.

Properties

ActivatableClassId ActivatableClassId ActivatableClassId ActivatableClassId

Gets the activatable class ID of the video transform effect definition.

public : PlatForm::String ActivatableClassId { get; }public string ActivatableClassId { get; }Public ReadOnly Property ActivatableClassId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The activatable class ID of the video transform effect definition.

CropRectangle CropRectangle CropRectangle CropRectangle

Gets or sets the rectangle within which the video will be cropped, specified in pixels.

public : Rect CropRectangle { get; set; }public Rect CropRectangle { get; set; }Public ReadWrite Property CropRectangle As Rect// You can use this property in JavaScript.
Value
Rect Rect Rect Rect

The rectangle within which the video will be cropped

Mirror Mirror Mirror Mirror

Gets or sets the direction in which the video will be mirrored.

public : MediaMirroringOptions Mirror { get; set; }public MediaMirroringOptions Mirror { get; set; }Public ReadWrite Property Mirror As MediaMirroringOptions// You can use this property in JavaScript.
Value
MediaMirroringOptions MediaMirroringOptions MediaMirroringOptions MediaMirroringOptions

The direction in which the video will be mirrored.

OutputSize OutputSize OutputSize OutputSize

Gets or sets the output size of the video, in pixels.

public : Size OutputSize { get; set; }public Size OutputSize { get; set; }Public ReadWrite Property OutputSize As Size// You can use this property in JavaScript.
Value
Size Size Size Size

The output size of the video, in pixels.

Remarks

When video is scaled using this property, the aspect ratio of the video is preserved.

PaddingColor PaddingColor PaddingColor PaddingColor

Gets or sets the color that will be used to fill pixels in the frame that are not filled with video, such as when video is letterboxed.

public : Color PaddingColor { get; set; }public Color PaddingColor { get; set; }Public ReadWrite Property PaddingColor As Color// You can use this property in JavaScript.
Value
Color Color Color Color

The color that will be used to fill pixels in the frame that are not filled with video

ProcessingAlgorithm ProcessingAlgorithm ProcessingAlgorithm ProcessingAlgorithm

Gets or sets the media processing algorithm that is used for the video transform.

public : MediaVideoProcessingAlgorithm ProcessingAlgorithm { get; set; }public MediaVideoProcessingAlgorithm ProcessingAlgorithm { get; set; }Public ReadWrite Property ProcessingAlgorithm As MediaVideoProcessingAlgorithm// You can use this property in JavaScript.
Value
MediaVideoProcessingAlgorithm MediaVideoProcessingAlgorithm MediaVideoProcessingAlgorithm MediaVideoProcessingAlgorithm

The media processing algorithm that is used for the video transform.

Remarks

Set this value to MrfCrf444 to cause the video transform to use a high-quality resampler so that all operations are done using 4:4:4 sampling for the highest video quality. The algorithm applies to all transform properties except for PaddingColor.

Properties Properties Properties Properties

Gets the set of properties for configuring the VideoTransformEffectDefinition object.

public : IPropertySet Properties { get; }public IPropertySet Properties { get; }Public ReadOnly Property Properties As IPropertySet// You can use this property in JavaScript.
Value
IPropertySet IPropertySet IPropertySet IPropertySet

The set of properties for configuring the VideoTransformEffectDefinition object.

Rotation Rotation Rotation Rotation

Gets or sets the angle and direction in which the video will be rotated.

public : MediaRotation Rotation { get; set; }public MediaRotation Rotation { get; set; }Public ReadWrite Property Rotation As MediaRotation// You can use this property in JavaScript.
Value
MediaRotation MediaRotation MediaRotation MediaRotation

The angle and direction in which the video will be rotated.