Plugin parameter interface

Each of the plugins exposes a C-API that you can interact with via the FMOD Core API. We only document the parameter interface here as that is specific for our plugins. If you are looking for a more general documentation of the plugin API, please refer to official FMOD documentation .

Every FMOD::DSP plugin exposes the following parameter setters:


void setParameterFloat(int index, float value)
void setParameterInt(int index, int value)
void setParameterBool(int index, bool value)
void setParameterDataCallback(int index, void* data)

The following enums show how parameter names are mapped to indices. Note that you need to use the setter corresponding to the respective parameters data type.

Spatializer


enum atmokySpatializerParameterIndex
{
    minDistance,              // float
    maxDistance,              // float
    distanceModel,            // FMOD_DSP_PAN_3D_ROLLOFF_TYPE (int)
    attributes3d,             // FMOD_DSP_PARAMETER_3DATTRIBUTES*
    outputFormat,             // OutputFormat (int, see below)
    gain,                     // float
    lfeGain,                  // float
    width,                    // float
    innerAngle,               // float
    outerAngle,               // float
    outerGain,                // float
    outerLowpass,             // float
    occlusion,                // float
    nfeDistance,              // float
    nfeGain,                  // float
    nfeBassBoost,             // float
    binauralIfStereo,         // float
    spatializerNumParameters,
};

Renderer


enum atmokyRendererParameterIndex
{
    outputFormat,          // OutputFormat (int, see below)
    binauralIfStereo,      // float
    heightFilterStrength,  // float
    rearFilterStrength,    // float
    rendererNumParameters,
};

Externalizer


enum atmokyExternalizerParameterIndex
{
    externalizerAmount,        // float
    externalizerCharacter,     // float
    externalizerNumParameters,
};

AmbisonicRenderer


enum atmokyAmbisonicRendererParameterIndex
{
    attributes3d,                    // FMOD_DSP_PARAMETER_3DATTRIBUTES*
    headlocked,                      // bool
    minDistance,                     // float
    maxDistance,                     // float
    distanceModel,                   // FMOD_DSP_PAN_3D_ROLLOFF_TYPE (int)
    ambisonicRendererNumParameters,
};

Allowable output format values are as follows:


enum class OutputFormat
{
    platform = 0,
    stereo,
    binaural,
    quad,
    fivePointZero,
    fivePointOne,
    sevenPointOne,
    sevenPointOnePointFour,
    max = sevenPointOnePointFour
};