Table of Contents

Class CsoundAudioEffect

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

Advanced audio synthesis and processing using the Csound programming language. Uses the GStreamer 'csoundfilter' element to apply custom Csound algorithms to audio streams. Enables sophisticated audio effects, synthesis, and real-time audio programming capabilities. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect. Implements the VisioForge.Core.Types.X.AudioEffects.IVideoEditXAudioEffect.

public class CsoundAudioEffect : BaseAudioEffect, ISharedAudioEffectX, IVideoEditXAudioEffect

Inheritance

Implements

Inherited Members

Remarks

GStreamer element: csoundfilter

Csound is a powerful audio programming language for sound synthesis and processing.

CSD (Csound Document) files or text contain the Csound orchestra and score.

Allows creation of custom effects not available through standard audio processing.

Loop parameter enables continuous processing for indefinite duration.

ScoreOffset allows starting playback from a specific time point in the Csound score.

Constructors

CsoundAudioEffect(string)

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.CsoundAudioEffect class.

public CsoundAudioEffect(string name)

Parameters

name string

Unique name for this effect instance.

CsoundAudioEffect(string, string)

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.CsoundAudioEffect class with CSD text.

public CsoundAudioEffect(string name, string csdText)

Parameters

name string

Unique name for this effect instance.

csdText string

Csound CSD document content as text string.

CsoundAudioEffect(string, string, bool, double)

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.CsoundAudioEffect class with full configuration.

public CsoundAudioEffect(string name, string csdText, bool loop, double scoreOffset)

Parameters

name string

Unique name for this effect instance.

csdText string

Csound CSD document content as text string.

loop bool

Whether to loop the Csound score continuously.

scoreOffset double

Starting time offset in seconds within the Csound score.

Properties

CsdText

Gets or sets the Csound CSD (Csound Document) content as text.

public string CsdText { get; set; }

Property Value

string

Location

Gets or sets the file path to a Csound CSD file.

public string Location { get; set; }

Property Value

string

Loop

Gets or sets whether to loop the Csound score continuously.

public bool Loop { get; set; }

Property Value

bool

ScoreOffset

Gets or sets the starting time offset in the Csound score.

public double ScoreOffset { get; set; }

Property Value

double

Methods

GenerateDescription()

Generates the GStreamer element description for the Csound filter.

public string GenerateDescription()

Returns

string

GStreamer pipeline description string for the csoundfilter element.

See Also