Firelight Technologies FMOD Studio API

Studio::EventInstance::getCueByIndex

Retrieves a CueInstance by index.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getCueByIndex(
  int index,
  Studio::CueInstance **cue
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetCueByIndex(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  int index,
  FMOD_STUDIO_CUEINSTANCE **cue
);

Parameters

index

Index of the cue.

cue

Address of a variable to receive the CueInstance 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 can be used in combination with Studio::EventInstance::getParameterCount to enumerate all cue instances within an event instance.

See Also

• Studio::EventInstance::getCueCount

Version 1.03.06 Built on Apr 17, 2014