Table of Contents

Class VolumeAudioEffect

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

Volume audio effect controls the volume level of an audio stream. Uses the GStreamer 'volume' element to adjust audio amplification and mute state. Implements the VisioForge.Core.Types.X.AudioEffects.BaseAudioEffect.

public class VolumeAudioEffect : BaseAudioEffect, ISharedAudioEffectX, IVideoEditXAudioEffect

Inheritance

Implements

Inherited Members

Remarks

GStreamer element: volume Properties:

  • volume: Volume level (0.0 = silence, 1.0 = normal, >1.0 = amplification)
  • mute: Mute flag (true/false)

Constructors

VolumeAudioEffect(double)

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

public VolumeAudioEffect(double level)

Parameters

level double

The volume level. Range: 0.0 (silence) to 10.0 or higher (amplification). Default/normal is 1.0.

Properties

Level

Gets or sets the volume level. Range: 0.0 (silence) to 10.0 or higher (amplification). Normal volume is 1.0. Values above 1.0 will amplify the audio signal and may cause clipping.

public double Level { get; set; }

Property Value

double

Mute

Gets or sets a value indicating whether the audio stream should be muted. When muted, no audio is output regardless of the level setting.

public bool Mute { get; set; }

Property Value

bool

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

System.String.

See Also