Firelight Technologies FMOD Studio API

Studio::Bank::getSampleLoadingState

Retrieves the sample data loading state of the bank.

C++ Syntax

FMOD_RESULT Studio::Bank::getSampleLoadingState(
  FMOD_STUDIO_LOADING_STATE *state
);

C Syntax

FMOD_RESULT FMOD_Studio_Bank_GetSampleLoadingState(
  FMOD_STUDIO_BANK *bank,
  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

Used for tracking the status of the Studio::Bank::loadSampleData operation.

Note that this function is not affected by Studio::EventDescription::loadSampleData, so it can report FMOD_STUDIO_LOADING_STATE_UNLOADED even if all events in a bank have had their sample data loaded individually.

See Also

• FMOD_STUDIO_LOADING_STATE
• Studio::Bank::loadSampleData

Version 1.03.06 Built on Apr 17, 2014