FMOD_DSP_PARAMETER_OVERALLGAIN

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_DSP_PARAMETER_OVERALLGAIN

Structure for data parameters of type FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN. A parameter of this type is used in effects that affect the overgain of the signal in a predictable way. This parameter is read by the system to determine the effect's gain for voice virtualization.

C/C++ Syntax

typedef struct {
  float linear_gain;
  float linear_gain_additive;
} FMOD_DSP_PARAMETER_OVERALLGAIN;

JavaScript Syntax

struct FMOD_DSP_PARAMETER_OVERALLGAIN
{
  linear_gain,
  linear_gain_additive,
};

Members

linear_gain

[r] The overall linear gain of the effect on the direct signal path

linear_gain_additive

[r] Additive gain, for parallel signal paths

Remarks

Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.
Members marked with [w] mean the variable can be written to. The user can set the value.

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.DSP_PARAMETER_OVERALLGAIN()", no 'new' keyword is required.

See Also




Version 1.10.03 Built on Feb 1, 2018