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
);

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.

See Also

• FMOD_STUDIO_LOADING_STATE
• Studio::EventDescription::loadSampleData
• Studio::Bank::loadSampleData

Version 1.03.06 Built on Apr 17, 2014