BASS.NET API for the Un4seen BASS Audio LibraryBASS_FX_VOLUME_PARAM ClassBASS.NET API for the Un4seen BASS Audio Library
Used with BASS_FXGetParameters(Int32, Object) and BASS_FXSetParameters(Int32, Object) to retrieve and set the parameters of a volume level effect.
Inheritance Hierarchy


Namespace: Un4seen.Bass
Assembly: Bass.Net (in Bass.Net.dll) Version:

[StructLayoutAttribute(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
public sealed class BASS_FX_VOLUME_PARAM

The BASS_FX_VOLUME_PARAM type exposes the following members.


Default constructor.
Public methodBASS_FX_VOLUME_PARAM(Single, Single, Single, Int32)
constructor already setting the members

Public fieldfCurrent
The current volume level... -1 = leave existing current level when setting parameters. The default value is 1.
Public fieldfTarget
The new volume level... 0 = silent, 1.0 = normal, above 1.0 = amplification. The default value is 1.
Public fieldfTime
The time to take to transition from the current level to the new level, in seconds. The default value is 0.
Public fieldlCurve
The curve to use in the transition... 0 = linear, 1 = logarithmic. The default value is 0.

The fTime value is based on the channel's original sample rate. If the playback rate is changed via the BASS_ATTRIB_FREQ attribute, then the transition time that is heard will be affected accordingly.

When retrieving parameters, the returned fCurrent value is the level that is currently being applied, not necessarily the level that was last set via BASS_FXSetParameters(Int32, Object). During playback, it may not be the value that is currently being heard, due to buffering.

Unlike the BASS_ATTRIB_VOL attribute, this effect modifies the channel's sample data, so it can be used to change the level of decoding channels and recording channels. The BASS_CONFIG_CURVE_VOL setting does not affect this effect; the fTarget and fCurrent values are always linear.

See Also