Studio::EventInstance::release

Releases the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::release();

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_Release(FMOD_STUDIO_EVENTINSTANCE *eventinstance);

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Immediately invalidates the API handle, and schedules the event instance to be released when appropriate. If the instance is stopped when release is called, it will be released immediately. If the instance is playing when release is called, and will stop in a finite amount of time, it will be released when playback completes. If the instance is playing when release is called, and will never stop (e.g. because it is looping or sustaining), this function will fail and return FMOD_ERR_EVENT_WONT_STOP.

Version 1.03.06 Built on Apr 17, 2014