Firelight Technologies FMOD Studio API

Studio::EventDescription::unloadSampleData

Unloads all non-streaming sample data used by the event.

C++ Syntax

FMOD_RESULT Studio::EventDescription::unloadSampleData();

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_UnloadSampleData(FMOD_STUDIO_EVENTDESCRIPTION *eventdescription);

C# Syntax

RESULT Studio.EventDescription.unloadSampleData();

JavaScript Syntax

EventDescription.unloadSampleData();

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

Each time this function is called, it will decrement the reference count. If the reference count goes to zero, the sample data will be unloaded.

If any instances of this event exist, sample data will not be unloaded until all instances are released.

See Also

• Studio::EventDescription::loadSampleData
• Studio::EventDescription::getSampleLoadingState
• Studio::Bank::loadSampleData
• Studio::Bank::unloadSampleData

Version 1.10.03 Built on Feb 1, 2018