Studio::EventDescription::createInstance

Creates a playable instance of the event.

C++ Syntax

FMOD_RESULT Studio::EventDescription::createInstance(
  Studio::EventInstance **instance
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_CreateInstance(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  FMOD_STUDIO_EVENTINSTANCE **instance
);

Parameters

instance: Address of a variable to receive the EventInstance object.

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

This function creates playable instances of the EventDescription. Many instances can be created from a single EventDescription. When an event instance is created, it begins loading the required sample data asynchronously; use Studio::EventDescription::getSampleLoadingState to check the loading status.