Trait EventInstanceCallback 

pub trait EventInstanceCallback {
    // Provided methods
    fn created(event: EventInstance) -> Result<()> { ... }
    fn destroyed(event: EventInstance) -> Result<()> { ... }
    fn starting(event: EventInstance) -> Result<()> { ... }
    fn started(event: EventInstance) -> Result<()> { ... }
    fn restarted(event: EventInstance) -> Result<()> { ... }
    fn stopped(event: EventInstance) -> Result<()> { ... }
    fn start_failed(event: EventInstance) -> Result<()> { ... }
    fn create_programmer_sound(
        event: EventInstance,
        sound_props: ProgrammerSoundProperties<'_>,
    ) -> Result<()> { ... }
    fn destroy_programmer_sound(
        event: EventInstance,
        sound_props: ProgrammerSoundProperties<'_>,
    ) -> Result<()> { ... }
    fn plugin_created(
        event: EventInstance,
        plugin_props: PluginInstanceProperties,
    ) -> Result<()> { ... }
    fn plugin_destroyed(
        event: EventInstance,
        plugin_props: PluginInstanceProperties,
    ) -> Result<()> { ... }
    fn timeline_marker(
        event: EventInstance,
        timeline_props: TimelineMarkerProperties,
    ) -> Result<()> { ... }
    fn timeline_beat(
        event: EventInstance,
        timeline_beat: TimelineBeatProperties,
    ) -> Result<()> { ... }
    fn sound_played(event: EventInstance, sound: Sound) -> Result<()> { ... }
    fn sound_stopped(event: EventInstance, sound: Sound) -> Result<()> { ... }
    fn real_to_virtual(event: EventInstance) -> Result<()> { ... }
    fn virtual_to_real(event: EventInstance) -> Result<()> { ... }
    fn start_event_command(
        event: EventInstance,
        new_event: EventInstance,
    ) -> Result<()> { ... }
    fn nested_timeline_beat(
        event: EventInstance,
        timeline_props: TimelineNestedBeatProperties,
    ) -> Result<()> { ... }
}

Available on crate feature studio only.

Trait for this particular FMOD callback.

No self parameter is passed to the callback!

Provided Methods

fn created(event: EventInstance) -> Result<()>

Called when an instance is fully created.

fn destroyed(event: EventInstance) -> Result<()>

Called when an instance is just about to be destroyed.

fn starting(event: EventInstance) -> Result<()>

EventInstance::start has been called on an event which was not already playing. The event will remain in this state until its sample data has been loaded.

fn started(event: EventInstance) -> Result<()>

The event has commenced playing. Normally this callback will be issued immediately after EventInstanceCallback::starting, but may be delayed until sample data has loaded.

fn restarted(event: EventInstance) -> Result<()>

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

fn stopped(event: EventInstance) -> Result<()>

The event has stopped.

fn start_failed(event: EventInstance) -> Result<()>

EventInstance::start has been called but the polyphony settings did not allow the event to start.

In this case none of EventInstanceCallback::starting, EventInstanceCallback::started and EventInstanceCallback::stopped will be called.

fn create_programmer_sound( event: EventInstance, sound_props: ProgrammerSoundProperties<'_>, ) -> Result<()>

A programmer sound is about to play. FMOD expects the callback to provide an Sound object for it to use.

fn destroy_programmer_sound( event: EventInstance, sound_props: ProgrammerSoundProperties<'_>, ) -> Result<()>

A programmer sound has stopped playing. At this point it is safe to release the Sound object that was used.

fn plugin_created( event: EventInstance, plugin_props: PluginInstanceProperties, ) -> Result<()>

Called when a DSP plug-in instance has just been created.

fn plugin_destroyed( event: EventInstance, plugin_props: PluginInstanceProperties, ) -> Result<()>

Called when a DSP plug-in instance is about to be destroyed.

fn timeline_marker( event: EventInstance, timeline_props: TimelineMarkerProperties, ) -> Result<()>

Called when the timeline passes a named marker.

fn timeline_beat( event: EventInstance, timeline_beat: TimelineBeatProperties, ) -> Result<()>

Called when the timeline hits a beat in a tempo section.

fn sound_played(event: EventInstance, sound: Sound) -> Result<()>

Called when the event plays a sound.

fn sound_stopped(event: EventInstance, sound: Sound) -> Result<()>

Called when the event finishes playing a sound.

fn real_to_virtual(event: EventInstance) -> Result<()>

Called when the event becomes virtual.

fn virtual_to_real(event: EventInstance) -> Result<()>

Called when the event becomes real.

fn start_event_command( event: EventInstance, new_event: EventInstance, ) -> Result<()>

Called when a new event is started by a start event command.

fn nested_timeline_beat( event: EventInstance, timeline_props: TimelineNestedBeatProperties, ) -> Result<()>

Called when the timeline hits a beat in a tempo section of a nested event.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors