Firelight Technologies FMOD Studio API

Studio::EventDescription::getInstanceList

Retrieves the created EventInstances for this event type.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getInstanceList(
  Studio::EventInstance **array,
  int capacity,
  int *count
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetInstanceList(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  FMOD_STUDIO_EVENTINSTANCE **array,
  int capacity,
  int *count
);

C# Syntax

RESULT Studio.EventDescription.getInstanceList(
  out EventInstance[] array
);

JavaScript Syntax

EventDescription.getInstanceList(
  array,                           // writes value to array.val
  capacity,                        
  count                            // writes value to count.val
);

Parameters

array

An array of memory allocated by the user.

capacity

The capacity of the array passed in as the first parameter

count

Address of a variable to receive the number of Event Instances written to the array

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

Can be used in conjunction with Studio::EventDescription::getInstanceCount to track the playing instances of this event.

See Also

• Studio::EventDescription::getInstanceCount

Version 1.10.03 Built on Feb 1, 2018