FMOD_STUDIO_EVENT_PROPERTY

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_EVENT_PROPERTY

These definitions describe built-in event properties.

C/C++ Syntax

typedef enum {
  FMOD_STUDIO_EVENT_PROPERTY_CHANNELPRIORITY,
  FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_DELAY,
  FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_LOOKAHEAD,
  FMOD_STUDIO_EVENT_PROPERTY_MINIMUM_DISTANCE,
  FMOD_STUDIO_EVENT_PROPERTY_MAXIMUM_DISTANCE,
  FMOD_STUDIO_EVENT_PROPERTY_MAX
} FMOD_STUDIO_EVENT_PROPERTY;

JavaScript Syntax

FMOD.STUDIO_EVENT_PROPERTY_CHANNELPRIORITY
FMOD.STUDIO_EVENT_PROPERTY_SCHEDULE_DELAY
FMOD.STUDIO_EVENT_PROPERTY_SCHEDULE_LOOKAHEAD
FMOD.STUDIO_EVENT_PROPERTY_MINIMUM_DISTANCE
FMOD.STUDIO_EVENT_PROPERTY_MAXIMUM_DISTANCE
FMOD.STUDIO_EVENT_PROPERTY_MAX
FMOD.STUDIO_EVENT_PROPERTY_FORCEINT

Values

FMOD_STUDIO_EVENT_PROPERTY_CHANNELPRIORITY

Priority to set on low-level channels created by this event instance (-1 to 256).

FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_DELAY

Schedule delay to synchronized playback for multiple tracks in DSP clocks, or -1 for default.

FMOD_STUDIO_EVENT_PROPERTY_SCHEDULE_LOOKAHEAD

Schedule look-ahead on the timeline in DSP clocks, or -1 for default.

FMOD_STUDIO_EVENT_PROPERTY_MINIMUM_DISTANCE

Override the event's 3D minimum distance, or -1 for default.

FMOD_STUDIO_EVENT_PROPERTY_MAXIMUM_DISTANCE

Override the event's 3D maximum distance, or -1 for default.

FMOD_STUDIO_EVENT_PROPERTY_MAX

Maximum number of event properties supported.

Remarks

For FMOD_STUDIO_EVENT_PROPERTY_CHANNELPRIORITY, a value of -1 uses the priority set in FMOD Studio, while other values override it. This property uses the same system as Channel::setPriority; this means lower values are higher priority (i.e. 0 is the highest priority while 256 is the lowest).

See Also



Version 1.10.03 Built on Feb 1, 2018