Firelight Technologies FMOD Studio API
Studio::EventDescription::getSampleLoadingState
Retrieves the sample data loading state of the event.
C++ Syntax
FMOD_RESULT Studio::EventDescription::getSampleLoadingState(
FMOD_STUDIO_LOADING_STATE *state
);
C Syntax
FMOD_RESULT FMOD_Studio_EventDescription_GetSampleLoadingState(
FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
FMOD_STUDIO_LOADING_STATE *state
);
C# Syntax
RESULT Studio.EventDescription.getSampleLoadingState(
out LOADING_STATE state
);
JavaScript Syntax
EventDescription.getSampleLoadingState(
state // writes value to state.val
);
Parameters
- state
- Address of a variable to receive the loading state.
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
Event sample data loading can be triggered by calls to Studio::EventDescription::loadSampleData, Studio::Bank::loadSampleData or Studio::EventDescription::createInstance.
If the event is invalid, then the state will be set to FMOD_STUDIO_LOADING_STATE_UNLOADED.
See Also
Version 1.10.03 Built on Feb 1, 2018