Class VideoStreamDynamicZoomSettings

Namespace

VisioForge.Core.Types.X.VideoEffects

Assembly

VisioForge.Core.dll

Settings for dynamic zoom transformation of the original video stream. The zoom values are interpolated between start and stop values based on the timestamp. This is applied before any overlays are drawn.

public class VideoStreamDynamicZoomSettings

Inheritance

object

VideoStreamDynamicZoomSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

VideoStreamDynamicZoomSettings()

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.VideoStreamDynamicZoomSettings class.

public VideoStreamDynamicZoomSettings()

VideoStreamDynamicZoomSettings(double, double, double, double, TimeSpan, TimeSpan)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.VideoStreamDynamicZoomSettings class with specified parameters.

public VideoStreamDynamicZoomSettings(double startZoomX, double startZoomY, double stopZoomX, double stopZoomY, TimeSpan startTime, TimeSpan stopTime)

Parameters

startZoomX double

The starting horizontal zoom factor.

startZoomY double

The starting vertical zoom factor.

stopZoomX double

The ending horizontal zoom factor.

stopZoomY double

The ending vertical zoom factor.

startTime TimeSpan

The start time.

stopTime TimeSpan

The stop time.

Properties

Enabled

Gets or sets a value indicating whether the dynamic zoom is enabled.

public bool Enabled { get; set; }

Property Value

bool

StartCenterX

Gets or sets the starting horizontal center point for the zoom (0.0 to 1.0). A value of 0.5 means the center of the video.

public double StartCenterX { get; set; }

Property Value

double

StartCenterY

Gets or sets the starting vertical center point for the zoom (0.0 to 1.0). A value of 0.5 means the center of the video.

public double StartCenterY { get; set; }

Property Value

double

StartTime

Gets or sets the start time when the dynamic zoom effect begins.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StartZoomX

Gets or sets the starting horizontal zoom factor. A value of 1.0 means no zoom.

public double StartZoomX { get; set; }

Property Value

double

StartZoomY

Gets or sets the starting vertical zoom factor. A value of 1.0 means no zoom.

public double StartZoomY { get; set; }

Property Value

double

StopCenterX

Gets or sets the ending horizontal center point for the zoom (0.0 to 1.0). A value of 0.5 means the center of the video.

public double StopCenterX { get; set; }

Property Value

double

StopCenterY

Gets or sets the ending vertical center point for the zoom (0.0 to 1.0). A value of 0.5 means the center of the video.

public double StopCenterY { get; set; }

Property Value

double

StopTime

Gets or sets the stop time when the dynamic zoom effect ends.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

StopZoomX

Gets or sets the ending horizontal zoom factor. A value of 1.0 means no zoom.

public double StopZoomX { get; set; }

Property Value

double

StopZoomY

Gets or sets the ending vertical zoom factor. A value of 1.0 means no zoom.

public double StopZoomY { get; set; }

Property Value

double

Methods

GetInterpolatedValues(TimeSpan, out double, out double, out double, out double)

Calculates the interpolated zoom values at the specified timestamp.

public void GetInterpolatedValues(TimeSpan timestamp, out double zoomX, out double zoomY, out double centerX, out double centerY)

Parameters

timestamp TimeSpan

The current timestamp.

zoomX double

The interpolated horizontal zoom factor.

zoomY double

The interpolated vertical zoom factor.

centerX double

The interpolated horizontal center point.

centerY double

The interpolated vertical center point.