Firelight Technologies FMOD Studio API

Studio::System::getEvent

Retrieves an EventDescription.

C++ Syntax

FMOD_RESULT Studio::System::getEvent(
  FMOD_GUID *id,
  FMOD_STUDIO_LOADING_MODE mode,
  Studio::EventDescription **event
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetEvent(
  FMOD_STUDIO_SYSTEM *system,
  FMOD_GUID *id,
  FMOD_STUDIO_LOADING_MODE mode,
  FMOD_STUDIO_EVENTDESCRIPTION **event
);

Parameters

id

The 128-bit GUID which identifies the event.

mode

Unused parameter - reserved for future functionality. Please specify FMOD_STUDIO_LOAD_BEGIN_NOW here.

event

Address of a variable to receive the EventDescription 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

The event ID can be looked up using Studio::System::lookupID or parsed from a string using Studio::parseID.

See Also

• Studio::parseID
• Studio::System::lookupID
• Studio::EventDescription::createInstance

Version 1.03.06 Built on Apr 17, 2014