Firelight Technologies FMOD Studio API

Studio::EventInstance::getDescription

Retrieves the EventDescription for the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getDescription(
  Studio::EventDescription **description
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetDescription(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_STUDIO_EVENTDESCRIPTION **description
);

C# Syntax

RESULT Studio.EventInstance.getDescription(
  out EventDescription description
);

JavaScript Syntax

EventInstance.getDescription(
  description                      // writes value to description.val
);

Parameters

description

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.

Version 1.10.03 Built on Feb 1, 2018