FMOD_DSP_OBJECTPAN

FMOD Studio API

previous page next page

Firelight Technologies FMOD Studio API

FMOD_DSP_OBJECTPAN

Parameter types for the FMOD_DSP_TYPE_OBJECTPAN DSP. 3D Object panners are meant for hardware 3d object systems like Dolby Atmos or Sony Morpheus. These object panners take input in, and send it to the 7.1 bed, but do not send the signal further down the DSP chain (the output of the dsp is silence).

C/C++ Syntax

typedef enum {
  FMOD_DSP_OBJECTPAN_3D_POSITION,
  FMOD_DSP_OBJECTPAN_3D_ROLLOFF,
  FMOD_DSP_OBJECTPAN_3D_MIN_DISTANCE,
  FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE,
  FMOD_DSP_OBJECTPAN_3D_EXTENT_MODE,
  FMOD_DSP_OBJECTPAN_3D_SOUND_SIZE,
  FMOD_DSP_OBJECTPAN_3D_MIN_EXTENT,
  FMOD_DSP_OBJECTPAN_OVERALL_GAIN,
  FMOD_DSP_OBJECTPAN_OUTPUTGAIN
} FMOD_DSP_OBJECTPAN;

JavaScript Syntax

FMOD.DSP_OBJECTPAN_3D_POSITION
FMOD.DSP_OBJECTPAN_3D_ROLLOFF
FMOD.DSP_OBJECTPAN_3D_MIN_DISTANCE
FMOD.DSP_OBJECTPAN_3D_MAX_DISTANCE
FMOD.DSP_OBJECTPAN_3D_EXTENT_MODE
FMOD.DSP_OBJECTPAN_3D_SOUND_SIZE
FMOD.DSP_OBJECTPAN_3D_MIN_EXTENT
FMOD.DSP_OBJECTPAN_OVERALL_GAIN
FMOD.DSP_OBJECTPAN_OUTPUTGAIN

Values

FMOD_DSP_OBJECTPAN_3D_POSITION

(Type:data) - 3D Position. data of type FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI

FMOD_DSP_OBJECTPAN_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_OBJECTPAN_3D_MIN_DISTANCE

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

FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE

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

FMOD_DSP_OBJECTPAN_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_OBJECTPAN_3D_SOUND_SIZE

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

FMOD_DSP_OBJECTPAN_3D_MIN_EXTENT

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

FMOD_DSP_OBJECTPAN_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_OBJECTPAN_OUTPUTGAIN

(Type:float) - Output gain level. 0.0 to 1.0 linear scale. For the user to scale the output of the object panner's signal.

See Also



Version 1.10.03 Built on Feb 1, 2018


previous page start next page