Firelight Technologies FMOD Studio API
Studio::EventInstance::release
Schedules the event instance to be destroyed when it stops.
C++ Syntax
FMOD_RESULT Studio::EventInstance::release();C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_Release(FMOD_STUDIO_EVENTINSTANCE *eventinstance);C# Syntax
RESULT Studio.EventInstance.release();JavaScript Syntax
EventInstance.release();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
If the instance is already stopped when release is called, it will be destroyed after the next update.
The handle will remain valid until the event instance stops and is destroyed. Oneshot events will stop naturally, while looping events need to be stopped manually (e.g. by a call to Studio::EventInstance::stop).
See Also
Version 1.10.03 Built on Feb 1, 2018