Table of Contents

Class AudioTrackEffect

Namespace
VisioForge.Core.Types.VideoEdit
Assembly
VisioForge.Core.dll

Represents the base class for audio effects that can be applied to an audio track.

public class AudioTrackEffect

Inheritance

Derived

Inherited Members

Remarks

The VisioForge.Core.Types.VideoEdit.AudioTrackEffect class serves as the foundation for all audio effects that can be applied to audio tracks in video editing operations. It provides timing control to specify when an effect should start and stop within the track.

Key features:

  • Time-based effect application with start and stop times
  • Support for applying effects to entire tracks or specific segments
  • Automatic duration calculation based on start/stop times
  • Base class for specialized effects like volume, fade, and envelope effects

This is an abstract base class that should be inherited by specific effect implementations such as VisioForge.Core.Types.VideoEdit.AudioVolumeEnvelopeEffect or VisioForge.Core.Types.VideoEdit.AudioVolumeFadeEffect.

Constructors

AudioTrackEffect()

Initializes a new instance of the VisioForge.Core.Types.VideoEdit.AudioTrackEffect class.

public AudioTrackEffect()

Remarks

Creates an audio effect with no time constraints. By default, both VisioForge.Core.Types.VideoEdit.AudioTrackEffect.StartTime and VisioForge.Core.Types.VideoEdit.AudioTrackEffect.StopTime are set to null, which means the effect will be applied to the entire duration of the audio track.

This constructor is typically called by derived classes to initialize the base timing properties. Derived classes can then set specific timing if needed.

Properties

Duration

Gets the duration for which the effect is applied.

public TimeSpan? Duration { get; }

Property Value

TimeSpan?

Remarks

The duration is automatically calculated as the difference between StopTime and StartTime. If either time is not set (null), the duration cannot be determined and returns null.

This property is useful for:

  • Validating effect timing before application
  • Displaying effect duration in user interfaces
  • Calculating overlap between multiple effects

StartTime

Gets or sets the time at which the effect begins to be applied.

public TimeSpan? StartTime { get; set; }

Property Value

TimeSpan?

Remarks

The start time is relative to the beginning of the audio track, not the overall timeline. For example, if an audio track starts at 10 seconds in the timeline and you set StartTime to 5 seconds, the effect will begin 5 seconds after the audio track starts playing.

Common scenarios:

  • Set to null to apply the effect from the track's beginning
  • Set to a specific time to delay the effect application
  • Use with StopTime to create a time window for the effect

StopTime

Gets or sets the time at which the effect stops being applied.

public TimeSpan? StopTime { get; set; }

Property Value

TimeSpan?