Class VolumeSettings

Namespace

VisioForge.Core.Types.X.AudioEffects

Assembly

VisioForge.Core.dll

Settings for VisioForge.Core.MediaBlocks.AudioProcessing.VolumeBlock. The block itself keeps its level and mute state in properties; this type is the serializable form of that state, so a pipeline document can carry a configured gain stage and the block catalog can describe it.

public class VolumeSettings : IMediaBlockSettings

Inheritance

object

VolumeSettings

Implements

IMediaBlockSettings

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

Level

Gets or sets the volume level multiplier: 0.0 is silence, 1.0 the original level, and values above 1.0 amplify. Default is 1.0.

public double Level { get; set; }

Property Value

double

Mute

Gets or sets a value indicating whether the audio is muted. Default is false.

public bool Mute { get; set; }

Property Value

bool

Methods

CreateBlock()

Creates a VisioForge.Core.MediaBlocks.AudioProcessing.VolumeBlock configured from these settings.

public MediaBlock CreateBlock()

Returns

MediaBlock

The configured block.