Table of Contents

Class VideoEffect

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

Represents the base abstract class for all video effects in the VisioForge SDK.

public abstract class VideoEffect : IVideoEffect

Inheritance

Derived

Implements

Inherited Members

Remarks

The VisioForge.Core.Types.VideoEffects.VideoEffect class provides common properties and functionality shared by all video processing effects, such as timing control (start/stop), enabling/disabling, and identifying the target stream.

Specific effects like VisioForge.Core.Types.VideoEffects.VideoEffectBlur or VisioForge.Core.Types.VideoEffects.VideoEffectGrayscale inherit from this class and implement the specific processing logic and parameter management.

To apply an effect, create an instance of a derived class, configure its parameters, and add it to the video effect collection of the processing engine.

Constructors

VideoEffect()

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

protected VideoEffect()

Properties

Enabled

Gets or sets a value indicating whether the video effect is enabled.

public bool Enabled { get; set; }

Property Value

bool

Remarks

This property allows you to temporarily toggle the effect on or off without removing it from the pipeline.

Name

Gets or sets the effect name.

public string Name { get; set; }

Property Value

string

Remarks

This name can be used to retrieve the effect interface from a collection for dynamic control during playback. It is recommended to assign unique names if you plan to update effects at runtime.

StartTime

Gets or sets the start time of the effect relative to the video timeline.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopTime

Gets or sets the stop time of the effect relative to the video timeline.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Stream

Gets or sets the target video stream for the effect.

public VideoStreamType Stream { get; set; }

Property Value

VideoStreamType

Remarks

Most effects are applied to the main video stream. However, in PIP (Picture-in-Picture) or multi-stream scenarios, this property allows you to specify which stream the effect should be applied to.

Methods

GetEffectType()

Gets the effect type.

public VideoEffectType GetEffectType()

Returns

VideoEffectType

The VisioForge.Core.Types.VideoEffects.VideoEffectType enum value corresponding to the concrete effect class.

Exceptions

Exception

Thrown if the derived class does not override this method.