Firelight Technologies FMOD Studio API

FMOD_DSP_PAN

Parameter types for the FMOD_DSP_TYPE_PAN DSP.

C/C++ Syntax

typedef enum {
  FMOD_DSP_PAN_MODE,
  FMOD_DSP_PAN_2D_STEREO_POSITION,
  FMOD_DSP_PAN_2D_DIRECTION,
  FMOD_DSP_PAN_2D_EXTENT,
  FMOD_DSP_PAN_2D_ROTATION,
  FMOD_DSP_PAN_2D_LFE_LEVEL,
  FMOD_DSP_PAN_2D_STEREO_MODE,
  FMOD_DSP_PAN_2D_STEREO_SEPARATION,
  FMOD_DSP_PAN_2D_STEREO_AXIS,
  FMOD_DSP_PAN_ENABLED_SPEAKERS,
  FMOD_DSP_PAN_3D_POSITION,
  FMOD_DSP_PAN_3D_ROLLOFF,
  FMOD_DSP_PAN_3D_MIN_DISTANCE,
  FMOD_DSP_PAN_3D_MAX_DISTANCE,
  FMOD_DSP_PAN_3D_EXTENT_MODE,
  FMOD_DSP_PAN_3D_SOUND_SIZE,
  FMOD_DSP_PAN_3D_MIN_EXTENT,
  FMOD_DSP_PAN_3D_PAN_BLEND,
  FMOD_DSP_PAN_LFE_UPMIX_ENABLED,
  FMOD_DSP_PAN_OVERALL_GAIN,
  FMOD_DSP_PAN_SURROUND_SPEAKER_MODE,
  FMOD_DSP_PAN_2D_HEIGHT_BLEND
} FMOD_DSP_PAN;

JavaScript Syntax

FMOD.DSP_PAN_MODE
FMOD.DSP_PAN_2D_STEREO_POSITION
FMOD.DSP_PAN_2D_DIRECTION
FMOD.DSP_PAN_2D_EXTENT
FMOD.DSP_PAN_2D_ROTATION
FMOD.DSP_PAN_2D_LFE_LEVEL
FMOD.DSP_PAN_2D_STEREO_MODE
FMOD.DSP_PAN_2D_STEREO_SEPARATION
FMOD.DSP_PAN_2D_STEREO_AXIS
FMOD.DSP_PAN_ENABLED_SPEAKERS
FMOD.DSP_PAN_3D_POSITION
FMOD.DSP_PAN_3D_ROLLOFF
FMOD.DSP_PAN_3D_MIN_DISTANCE
FMOD.DSP_PAN_3D_MAX_DISTANCE
FMOD.DSP_PAN_3D_EXTENT_MODE
FMOD.DSP_PAN_3D_SOUND_SIZE
FMOD.DSP_PAN_3D_MIN_EXTENT
FMOD.DSP_PAN_3D_PAN_BLEND
FMOD.DSP_PAN_LFE_UPMIX_ENABLED
FMOD.DSP_PAN_OVERALL_GAIN
FMOD.DSP_PAN_SURROUND_SPEAKER_MODE

Values

FMOD_DSP_PAN_MODE

(Type:int) - Panner mode. FMOD_DSP_PAN_MODE_MONO for mono down-mix, FMOD_DSP_PAN_MODE_STEREO for stereo panning or FMOD_DSP_PAN_MODE_SURROUND for surround panning. Default = FMOD_DSP_PAN_MODE_SURROUND

FMOD_DSP_PAN_2D_STEREO_POSITION

(Type:float) - 2D Stereo pan position. -100.0 to 100.0. Default = 0.0.

FMOD_DSP_PAN_2D_DIRECTION

(Type:float) - 2D Surround pan direction. Direction from center point of panning circle. -180.0 (degrees) to 180.0 (degrees). 0 = front center, -180 or +180 = rear speakers center point. Default = 0.0.

FMOD_DSP_PAN_2D_EXTENT

(Type:float) - 2D Surround pan extent. Distance from center point of panning circle. 0.0 (degrees) to 360.0 (degrees). Default = 360.0.

FMOD_DSP_PAN_2D_ROTATION

(Type:float) - 2D Surround pan rotation. -180.0 (degrees) to 180.0 (degrees). Default = 0.0.

FMOD_DSP_PAN_2D_LFE_LEVEL

(Type:float) - 2D Surround pan LFE level. 2D LFE level in dB. -80.0 (db) to 20.0 (db). Default = 0.0.

FMOD_DSP_PAN_2D_STEREO_MODE

(Type:int) - Stereo-To-Surround Mode. FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED to FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE. Default = FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE.

FMOD_DSP_PAN_2D_STEREO_SEPARATION

(Type:float) - Stereo-To-Surround Stereo For FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE mode. Separation/width of L/R parts of stereo sound. -180.0 (degrees) to +180.0 (degrees). Default = 60.0.

FMOD_DSP_PAN_2D_STEREO_AXIS

(Type:float) - Stereo-To-Surround Stereo For FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE mode. Axis/rotation of L/R parts of stereo sound. -180.0 (degrees) to +180.0 (degrees). Default = 0.0.

FMOD_DSP_PAN_ENABLED_SPEAKERS

(Type:int) - Speakers Enabled. Bitmask for each speaker from 0 to 32 to be considered by panner. Use to disable speakers from being panned to. 0 to 0xFFF. Default = 0xFFF (All on).

FMOD_DSP_PAN_3D_POSITION

(Type:data) - 3D Position. Data of type FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI. See remarks on what to fill out.

FMOD_DSP_PAN_3D_ROLLOFF

(Type:int) - 3D Rolloff. FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED to FMOD_DSP_PAN_3D_ROLLOFF_CUSTOM. Default = FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED.

FMOD_DSP_PAN_3D_MIN_DISTANCE

(Type:float) - 3D Min Distance. 0.0 to 1e+18f. Default = 1.0.

FMOD_DSP_PAN_3D_MAX_DISTANCE

(Type:float) - 3D Max Distance. 0.0 to 1e+18f. Default = 20.0.

FMOD_DSP_PAN_3D_EXTENT_MODE

(Type:int) - 3D Extent Mode. FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO to FMOD_DSP_PAN_3D_EXTENT_MODE_OFF. Default = FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO.

FMOD_DSP_PAN_3D_SOUND_SIZE

(Type:float) - 3D Sound Size. 0.0 to 1e+18f. Default = 0.0.

FMOD_DSP_PAN_3D_MIN_EXTENT

(Type:float) - 3D Min Extent. 0.0 (degrees) to 360.0 (degrees). Default = 0.0.

FMOD_DSP_PAN_3D_PAN_BLEND

(Type:float) - 3D Pan Blend. 0.0 (fully 2D) to 1.0 (fully 3D). Default = 0.0.

FMOD_DSP_PAN_LFE_UPMIX_ENABLED

(Type:int) - LFE Upmix Enabled. Determines whether non-LFE source channels should mix to the LFE or leave it alone. 0 (off) to 1 (on). Default = 0 (off).

FMOD_DSP_PAN_OVERALL_GAIN

(Type:data) - Overall gain. For information only, not set by user. Data of type FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN to provide to FMOD, to allow FMOD to know the DSP is scaling the signal for virtualization purposes.

FMOD_DSP_PAN_SURROUND_SPEAKER_MODE

(Type:int) - Surround speaker mode. Target speaker mode for surround panning. Default = FMOD_SPEAKERMODE_DEFAULT.

FMOD_DSP_PAN_2D_HEIGHT_BLEND

(Type:float) - 2D Height blend. When the input or FMOD_DSP_PAN_SURROUND_SPEAKER_MODE has height speakers, control the blend between ground and height. -1.0 (push top speakers to ground), 0.0 (preserve top / ground separation), 1.0 (push ground speakers to top). Default = 0.0.

Remarks

FMOD_DSP_PAN_3D_PAN_BLEND controls the percentage of the effect supplied by FMOD_DSP_PAN_2D_DIRECTION and FMOD_DSP_PAN_2D_EXTENT.

For FMOD_DSP_PAN_3D_POSITION, the following members in the FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI struct should be non zero. - numlisteners - This is typically 1, can be up to 8. Typically more than 1 is only used for split screen purposes. The FMOD Panner will average angles and produce the best compromise for panning and attenuation. - relative[listenernum].position - This is the delta between the listener position and the sound position. Typically the listener position is subtracted from the sound position. - relative[listenernum].forward - This is the sound's forward vector. Optional, set to 0,0,1 if not needed. This is only relevant for more than mono sounds in 3D, that are spread amongst the destination speakers at the time of panning. If the sound rotates then the L/R part of a stereo sound will rotate amongst its destination speakers. If the sound has moved and pinpointed into a single speaker, rotation of the sound will have no effect as at that point the channels are collapsed into a single point.

For FMOD_DSP_PAN_2D_STEREO_MODE, when it is set to FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE, only FMOD_DSP_PAN_2D_STEREO_SEPARATION and FMOD_DSP_PAN_2D_STEREO_AXIS are used. When it is set to FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED, then standard FMOD_DSP_PAN_2D_DIRECTION/FMOD_DSP_PAN_2D_EXTENT parameters are used.

See Also

• DSP::setParameterFloat
• DSP::getParameterFloat
• DSP::setParameterInt
• DSP::getParameterInt
• DSP::setParameterData
• DSP::getParameterData
• FMOD_DSP_TYPE

Version 1.10.03 Built on Feb 1, 2018