AudioEffectAmplify

Adds a volume manipulation audio effect to an audio bus.

1.0.0

class AudioEffectAmplifyReckfellSharpInherits AudioEffect

Adds a volume manipulation audio effect to an audio bus.

Increases or decreases the volume being routed through the audio bus.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectAmplifyConstructor

# AudioEffectAmplify

C#
public AudioEffectAmplify();

Properties2

VolumeDbProperty

# VolumeDb

C#
public float VolumeDb { get; set; }

Amount of amplification in dB. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.

VolumeLinearProperty

# VolumeLinear

C#
public float VolumeLinear { get; set; }

Amount of amplification as a linear value. Note: This member modifies AudioEffectAmplify.VolumeDb for convenience. The returned value is equivalent to the result of @GlobalScope.db_to_linear on AudioEffectAmplify.VolumeDb. Setting this member is equivalent to setting AudioEffectAmplify.VolumeDb to the result of @GlobalScope.linear_to_db on a value.

Methods4

GetVolumeDbfloat

# GetVolumeDb

C#
public float GetVolumeDb();

Returns float

GetVolumeLinearfloat

# GetVolumeLinear

C#
public float GetVolumeLinear();

Returns float

SetVolumeDbvoid

# SetVolumeDb

C#
public void SetVolumeDb(float volume);

Parameters
Name	Type	Default
`volume`	`float`	—

SetVolumeLinearvoid

# SetVolumeLinear

C#
public void SetVolumeLinear(float volume);

Parameters
Name	Type	Default
`volume`	`float`	—

Reckfell Engine documentationBack to top ↑