Firelight Technologies FMOD Studio API

Studio::Bank::loadSampleData

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

C++ Syntax

FMOD_RESULT Studio::Bank::loadSampleData();

C Syntax

FMOD_RESULT FMOD_Studio_Bank_LoadSampleData(FMOD_STUDIO_BANK *bank);

C# Syntax

RESULT Studio.Bank.loadSampleData();

JavaScript Syntax

Bank.loadSampleData();

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

You can use this function to preload sample data ahead of time so that events can be played immediately when required.

Each time this function is called, it will increment the reference count, so the sample data will not be unloaded until Studio::Bank::unloadSampleData is called the same number of times.

It is valid to mix calls to Studio::Bank::loadSampleData with calls to Studio::EventDescription::loadSampleData. If you do this, the sample data will be loaded when either reference count is non-zero, and will be unloaded when both reference counts go to zero.

See Also

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

Version 1.10.03 Built on Feb 1, 2018