Firelight Technologies FMOD Studio API

Studio::EventDescription::createInstance

Creates a playable instance of the event / snapshot.

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

C# Syntax

RESULT Studio.EventDescription.createInstance(
  out EventInstance instance
);

JavaScript Syntax

EventDescription.createInstance(
  instance                         // writes value to instance.val
);

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.

Sample data can be loaded ahead of time with Studio::EventDescription::loadSampleData or Studio::Bank::loadSampleData.

See Also

• Studio::EventDescription::isSnapshot
• Studio::EventDescription::getSampleLoadingState
• Studio::EventInstance::release

Version 1.10.03 Built on Feb 1, 2018