BASS_FXGetParameters

BASS FX

previous page next page
BASS_FXGetParameters

Retrieves the parameters of an effect.

BOOL BASS_FXGetParameters(
    HFX handle,
    void *params
);

Parameters

handle The effect handle.
params

Pointer to the parameters structure to fill. Depending on the type of effect, the parameters returned will be one of:
BASS_BFX_ROTATE
BASS_BFX_VOLUME
BASS_BFX_PEAKEQ
BASS_BFX_MIX
BASS_BFX_DAMP
BASS_BFX_AUTOWAH
BASS_BFX_PHASER
BASS_BFX_CHORUS
BASS_BFX_DISTORTION
BASS_BFX_COMPRESSOR2
BASS_BFX_VOLUME_ENV
BASS_BFX_BQF
BASS_BFX_ECHO4
BASS_FX_BFX_PITCHSHIFT
BASS_FX_BFX_FREEVERB

Return value
If successful, TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLE The handle is invalid
BASS_ERROR_ILLPARAM One or more of the parameters are invalid, make sure all the values are within the valid ranges

See also
BASS_ChannelSetFX, BASS_ChannelRemoveFX, BASS_FXSetParameters, BASS_FXReset

previous page start next page