Table of Contents

Class VideoStreamDynamicPanSettings

Namespace
VisioForge.Core.Types.X.VideoEffects
Assembly
VisioForge.Core.dll

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

public class VideoStreamDynamicPanSettings

Inheritance

Inherited Members

Constructors

VideoStreamDynamicPanSettings()

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

public VideoStreamDynamicPanSettings()

VideoStreamDynamicPanSettings(double, double, double, double, TimeSpan, TimeSpan)

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

public VideoStreamDynamicPanSettings(double startPanX, double startPanY, double stopPanX, double stopPanY, TimeSpan startTime, TimeSpan stopTime)

Parameters

startPanX double

The starting horizontal pan offset in pixels.

startPanY double

The starting vertical pan offset in pixels.

stopPanX double

The ending horizontal pan offset in pixels.

stopPanY double

The ending vertical pan offset in pixels.

startTime TimeSpan

The start time.

stopTime TimeSpan

The stop time.

Properties

Enabled

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

public bool Enabled { get; set; }

Property Value

bool

StartPanX

Gets or sets the starting horizontal pan offset in pixels.

public double StartPanX { get; set; }

Property Value

double

StartPanY

Gets or sets the starting vertical pan offset in pixels.

public double StartPanY { get; set; }

Property Value

double

StartTime

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

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopPanX

Gets or sets the ending horizontal pan offset in pixels.

public double StopPanX { get; set; }

Property Value

double

StopPanY

Gets or sets the ending vertical pan offset in pixels.

public double StopPanY { get; set; }

Property Value

double

StopTime

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

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Methods

GetInterpolatedValues(TimeSpan, out double, out double)

Calculates the interpolated pan values at the specified timestamp.

public void GetInterpolatedValues(TimeSpan timestamp, out double panX, out double panY)

Parameters

timestamp TimeSpan

The current timestamp.

panX double

The interpolated horizontal pan offset.

panY double

The interpolated vertical pan offset.