Firelight Technologies FMOD Studio API

Studio::EventDescription::loadSampleData

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

C++ Syntax

FMOD_RESULT Studio::EventDescription::loadSampleData();

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_LoadSampleData(FMOD_STUDIO_EVENTDESCRIPTION *eventdescription);

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::EventDescription::unloadSampleData is called the same number of times.

See Studio::Bank::loadSampleData for a description of this function's interaction with Studio::Bank::loadSampleData and Studio::Bank::unloadSampleData.

See Also




Version 1.03.06 Built on Apr 17, 2014