Firelight Technologies FMOD Studio API

FMOD_STUDIO_PARAMETER_TYPE

Describes the type of a parameter.

C/C++ Syntax

typedef enum {
  FMOD_STUDIO_PARAMETER_GAME_CONTROLLED,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_DISTANCE,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_CONE_ANGLE,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_ORIENTATION,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_DIRECTION,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_ELEVATION,
  FMOD_STUDIO_PARAMETER_AUTOMATIC_LISTENER_ORIENTATION,
  FMOD_STUDIO_PARAMETER_MAX
} FMOD_STUDIO_PARAMETER_TYPE;

JavaScript Syntax

FMOD.STUDIO_PARAMETER_GAME_CONTROLLED
FMOD.STUDIO_PARAMETER_AUTOMATIC_DISTANCE
FMOD.STUDIO_PARAMETER_AUTOMATIC_EVENT_CONE_ANGLE
FMOD.STUDIO_PARAMETER_AUTOMATIC_EVENT_ORIENTATION
FMOD.STUDIO_PARAMETER_AUTOMATIC_DIRECTION
FMOD.STUDIO_PARAMETER_AUTOMATIC_ELEVATION
FMOD.STUDIO_PARAMETER_AUTOMATIC_LISTENER_ORIENTATION
FMOD.STUDIO_PARAMETER_MAX
FMOD.STUDIO_PARAMETER_FORCEINT

Values

FMOD_STUDIO_PARAMETER_GAME_CONTROLLED

Controlled via the API using Studio::EventInstance::setParameterValue.

FMOD_STUDIO_PARAMETER_AUTOMATIC_DISTANCE

Distance between the event and the listener.

FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_CONE_ANGLE

Angle between the event's forward vector and the vector pointing from the event to the listener (0 to 180 degrees).

FMOD_STUDIO_PARAMETER_AUTOMATIC_EVENT_ORIENTATION

Horizontal angle between the event's forward vector and listener's forward vector (-180 to 180 degrees).

FMOD_STUDIO_PARAMETER_AUTOMATIC_DIRECTION

Horizontal angle between the listener's forward vector and the vector pointing from the listener to the event (-180 to 180 degrees).

FMOD_STUDIO_PARAMETER_AUTOMATIC_ELEVATION

Angle between the listener's XZ plane and the vector pointing from the listener to the event (-90 to 90 degrees).

FMOD_STUDIO_PARAMETER_AUTOMATIC_LISTENER_ORIENTATION

Horizontal angle between the listener's forward vector and the global positive Z axis (-180 to 180 degrees).

FMOD_STUDIO_PARAMETER_MAX

Maximum number of parameter types supported.

Remarks

There are two primary types of parameters: game controlled and automatic. Game controlled parameters receive their value from the API using Studio::EventInstance::setParameterValue. Automatic parameters are updated inside FMOD based on the positional information of the event and listener.

Horizontal angle means the angle between vectors projected onto the listener's XZ plane (for the EVENT_ORIENTATION and DIRECTION parameters) or the global XZ plane (for the LISTENER_ORIENTATION parameter).

See Also

• FMOD_STUDIO_PARAMETER_DESCRIPTION
• Studio::EventInstance::setParameterValue
• Studio::EventInstance::set3DAttributes
• Studio::System::setListenerAttributes

Version 1.10.03 Built on Feb 1, 2018