Platform SDK: DirectX

DirectSound3DListener.SetRolloffFactor

The DirectSound3DListener.SetRolloffFactor method sets the rolloff factor.

object.SetRolloffFactor(rolloffFactor As Single, _
    applyFlag As CONST_DS3DAPPLYFLAGS)

Parameters

object
Object expression that resolves to a DirectSound3DListener object.
rolloffFactor
Rolloff factor.
applyFlag
Value that indicates when the setting should be applied. This value must be one of the constants of the CONST_DS3DAPPLYFLAGS enumeration.

Error Codes

If the method fails, an error is raised and Err.Number may be set to DSERR_INVALIDPARAM.

Remarks

The rolloff factor has a range of DS3D_MINROLLOFFFACTOR (no rolloff) to DS3D_MAXROLLOFFFACTOR (defined as 10 times the rolloff found in the real world). The default value is DS3D_DEFAULTROLLOFFFACTOR (1.0).

See Also

DirectSound3DListener.GetRolloffFactor