Firelight Technologies FMOD Studio API

Studio::EventInstance::getCue

Retrieves a CueInstance by name.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getCue(
  const char *name,
  Studio::CueInstance **cue
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetCue(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  const char *name,
  FMOD_STUDIO_CUEINSTANCE **cue
);

Parameters

name

Name of the cue (case-insensitive).

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.

See Also

• Studio::CueInstance::trigger

Version 1.03.06 Built on Apr 17, 2014