Firelight Technologies FMOD Studio API

Studio::System::getEventByID

Retrieves an EventDescription by ID.

C++ Syntax

FMOD_RESULT Studio::System::getEventByID(
  const FMOD_GUID *id,
  Studio::EventDescription **event
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetEventByID(
  FMOD_STUDIO_SYSTEM *system,
  const FMOD_GUID *id,
  FMOD_STUDIO_EVENTDESCRIPTION **event
);

C# Syntax

RESULT Studio.System.getEventByID(
  Guid guid,
  out EventDescription _event
);

JavaScript Syntax

System.getEventByID(
  id,                              
  event                            // writes value to event.val
);

Parameters

id

The 128-bit GUID which identifies the event or snapshot.

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::System::getEvent
• Studio::EventDescription::isSnapshot
• Studio::EventDescription::createInstance

Version 1.10.03 Built on Feb 1, 2018