Class VideoRendererSettings

Namespace

VisioForge.Core.Types

Assembly

VisioForge.Core.dll

Provides comprehensive settings for configuring the video renderer, including mode, rotation, deinterlacing, and aspect ratio.

public class VideoRendererSettings

Inheritance

object

VideoRendererSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Examples

// Example: Configure EVR renderer with 90-degree rotation and letterbox stretching.
var rendererSettings = new VideoRendererSettings
{
    VideoRenderer = VideoRendererMode.EVR,
    RotationAngle = 90,
    StretchMode = VideoRendererStretchMode.Letterbox
};

// Example: Enable aspect ratio override to 4:3.
var customAspectRatioSettings = new VideoRendererSettings
{
    Aspect_Ratio_Override = true,
    Aspect_Ratio_X = 4,
    Aspect_Ratio_Y = 3
};

Remarks

This class allows fine-grained control over how video frames are displayed. It supports various rendering modes (e.g., EVR, VMR-9), visual transformations like rotation and flipping, and adjustments for deinterlacing and aspect ratio correction.

Constructors

VideoRendererSettings()

Initializes a new instance of the VisioForge.Core.Types.VideoRendererSettings class with default values.

public VideoRendererSettings()

Remarks

Default settings include EVR renderer, no rotation, default deinterlacing, no flipping, letterbox stretch mode, no zoom, and a 16:9 aspect ratio (unless overridden).

Properties

Aspect_Ratio_Override

Gets or sets a value indicating whether the aspect ratio should be overridden.

public bool Aspect_Ratio_Override { get; set; }

Property Value

bool

Aspect_Ratio_X

Gets or sets the X component of the custom aspect ratio.

public int Aspect_Ratio_X { get; set; }

Property Value

int

Aspect_Ratio_Y

Gets or sets the Y component of the custom aspect ratio.

public int Aspect_Ratio_Y { get; set; }

Property Value

int

Deinterlace_EVR_Mode

Gets or sets the EVR deinterlace mode.

public VideoRendererEVRDeinterlaceMode Deinterlace_EVR_Mode { get; set; }

Property Value

VideoRendererEVRDeinterlaceMode

Deinterlace_VMR9_Mode

Gets or sets the VMR-9 deinterlace mode.

public string Deinterlace_VMR9_Mode { get; set; }

Property Value

string

Deinterlace_VMR9_UseDefault

Gets or sets a value indicating whether the default deinterlace method should be used in the VMR-9 renderer.

public bool Deinterlace_VMR9_UseDefault { get; set; }

Property Value

bool

Flip_Horizontal

Gets or sets a value indicating whether the video display should be flipped horizontally.

public bool Flip_Horizontal { get; set; }

Property Value

bool

Flip_Vertical

Gets or sets a value indicating whether the video display should be flipped vertically.

public bool Flip_Vertical { get; set; }

Property Value

bool

RotationAngle

Gets or sets the rotation angle for the video display.

public int RotationAngle { get; set; }

Property Value

int

StretchMode

Gets or sets the stretch mode for the video renderer.

public VideoRendererStretchMode StretchMode { get; set; }

Property Value

VideoRendererStretchMode

VideoRenderer

Gets or sets the video renderer mode used for displaying video.

public VideoRendererMode VideoRenderer { get; set; }

Property Value

VideoRendererMode

Zoom_Ratio

Gets or sets the zoom ratio for screen capture, in percentage.

[JsonIgnore]
public int Zoom_Ratio { get; set; }

Property Value

int

Zoom_ShiftX

Gets or sets the horizontal shift for the zoomed screen capture.

[JsonIgnore]
public int Zoom_ShiftX { get; set; }

Property Value

int

Zoom_ShiftY

Gets or sets the vertical shift for the zoomed screen capture.

[JsonIgnore]
public int Zoom_ShiftY { get; set; }

Property Value

int