Class GainPostProcessor

Changes the gain (volume) of audio samples.

Inheritance
System.Object
AudioPostProcessor
GainPostProcessor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Cosmos.System.Audio.DSP.Processing
Assembly: Cosmos.System2.dll
Syntax
public class GainPostProcessor : AudioPostProcessor

Constructors

| Improve this Doc View Source

GainPostProcessor()

Initializes a new instance of the GainPostProcessor, with its gain set to full volume.

Declaration
public GainPostProcessor()
| Improve this Doc View Source

GainPostProcessor(Single)

Initializes a new instance of the GainPostProcessor with the given gain value.

Declaration
public GainPostProcessor(float gain)
Parameters
Type Name Description
System.Single gain

The gain value. This value must be in the range of [0; 1].
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The provided gain value was outside the range of [0; 1].

Properties

| Improve this Doc View Source

Gain

The amount of the original signal to pass through. This value must be in the range of [0; 1].

Declaration
public float Gain { get; set; }
Property Value
Type Description
System.Single
Exceptions
Type Condition
System.ArgumentOutOfRangeException

The provided value was outside the range of [0; 1].

Methods

| Improve this Doc View Source

Process(AudioBuffer)

Declaration
public override void Process(AudioBuffer buffer)
Parameters
Type Name Description
AudioBuffer buffer
Overrides