Microsoft DirectX 8.1 (Visual Basic)

DSFXCOMPRESSOR

The DSFXCOMPRESSOR type contains parameters for a compression effect.

Syntax

Type DSFXCOMPRESSOR
  fAttack As Single
  fGain As Single
  fPreDelay As Single
  fRatio As Single
  fRelease As Single
  fThreshold As Single
End Type

Members

fAttack

Time before compression reaches its full value. The default value is 10 ms. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_ATTACK enumeration. See Remarks.

fGain

Output gain of signal after compression. The default value is 0 dB. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_GAIN enumeration.

fPreDelay

Time after lThreshold is reached before attack phase is started. The default value is 4 ms. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_PREDELAY enumeration.

fRatio

Compression ratio. The default value is 3, which means 3:1 compression. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_RATIO enumeration.

fRelease

Speed at which compression is stopped after input drops below lThreshold. The default value is 200 ms. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_RELEASE enumeration.

fThreshold

Point at which compression begins. The default value is -20 dB. Minimum and maximum values are defined in the CONST_DSFXCOMPRESSOR_THRESHOLD enumeration.

Remarks

For convenience, the minimum value for fAttack is defined as the integer 1 in the CONST_DSFXCOMPRESSOR_ATTACK enumeration. However, the actual minimum value, which is also the default, is 0.01.

See Also