FMOD_STUDIO_EVENT_CALLBACK_TYPE

These callback types are used with FMOD_STUDIO_EVENT_CALLBACK.

Enumeration

typedef enum {
  FMOD_STUDIO_EVENT_CALLBACK_STARTED,
  FMOD_STUDIO_EVENT_CALLBACK_STOPPED,
  FMOD_STUDIO_EVENT_CALLBACK_IDLE,
  FMOD_STUDIO_EVENT_CALLBACK_CREATE_PROGRAMMER_SOUND,
  FMOD_STUDIO_EVENT_CALLBACK_DESTROY_PROGRAMMER_SOUND,
  FMOD_STUDIO_EVENT_CALLBACK_RESTARTED
} FMOD_STUDIO_EVENT_CALLBACK_TYPE;

Values

FMOD_STUDIO_EVENT_CALLBACK_STARTED

Called when an instance starts. Parameters = FMOD_STUDIO_EVENTINSTANCE, which can be cast to Studio::EventInstance* type.

FMOD_STUDIO_EVENT_CALLBACK_STOPPED

Called when an instance stops. Parameters = FMOD_STUDIO_EVENTINSTANCE, which can be cast to Studio::EventInstance* type.

FMOD_STUDIO_EVENT_CALLBACK_IDLE

Called when an instance enters the idle state. Parameters = FMOD_STUDIO_EVENTINSTANCE, which can be cast to Studio::EventInstance* type.

FMOD_STUDIO_EVENT_CALLBACK_CREATE_PROGRAMMER_SOUND

Called when a programmer sound needs to be created in order to play a programmer instrument. Parameters = FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.

FMOD_STUDIO_EVENT_CALLBACK_DESTROY_PROGRAMMER_SOUND

Called when a programmer sound needs to be destroyed. Parameters = FMOD_STUDIO_PROGRAMMER_SOUND_PROPERTIES.

FMOD_STUDIO_EVENT_CALLBACK_RESTARTED

Called when an instance is restarted. Parameters = FMOD_STUDIO_EVENTINSTANCE, which can be cast to Studio::EventInstance* type.

Remarks

The data passed to the event callback function in the parameters argument varies based on the callback type.

FMOD_STUDIO_EVENT_CALLBACK_STARTED is called when:

Studio::EventInstance::start has been called on an event which was not already playing.

FMOD_STUDIO_EVENT_CALLBACK_RESTARTED is called when:

Studio::EventInstance::start has been called on an event which was already playing.

FMOD_STUDIO_EVENT_CALLBACK_STOPPED is called when:

The event has stopped due to Studio::EventInstance::stop being called with FMOD_STUDIO_STOP_IMMEDIATE.
The event has finished fading out after Studio::EventInstance::stop was called with FMOD_STUDIO_STOP_ALLOWFADEOUT.
The event has stopped naturally by reaching the end of the timeline, and no further sounds can be triggered due to parameter changes.

FMOD_STUDIO_EVENT_CALLBACK_IDLE is called when:

The event has reached the end of the timeline and all sounds have finished, but further sounds could be triggered due to parameter changes.

FMOD_STUDIO_EVENT_CALLBACK_TYPE

Enumeration

Values

Remarks

See Also