Firelight Technologies FMOD Studio API

Studio::Bank::unloadSampleData

Unloads all non-streaming sample data used by events in the bank.

C++ Syntax

FMOD_RESULT Studio::Bank::unloadSampleData();

C Syntax

FMOD_RESULT FMOD_Studio_Bank_UnloadSampleData(FMOD_STUDIO_BANK *bank);

C# Syntax

RESULT Studio.Bank.unloadSampleData();

JavaScript Syntax

Bank.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.

Any sample data that is being used by event instances will not be unloaded until the event instances are released.

See Also

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

Version 1.10.03 Built on Feb 1, 2018