Firelight Technologies FMOD Studio API
Studio::EventInstance::getProperty
Retrieves the value of a built-in event instance property.
C++ Syntax
FMOD_RESULT Studio::EventInstance::getProperty(
FMOD_STUDIO_EVENT_PROPERTY index,
float *value
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_GetProperty(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
FMOD_STUDIO_EVENT_PROPERTY index,
float *value
);
C# Syntax
RESULT Studio.EventInstance.getProperty(
EVENT_PROPERTY index,
out float value
);
JavaScript Syntax
EventInstance.getProperty(
index,
value // writes value to value.val
);
Parameters
- index
- The index of the property to retrieve.
- value
- Address of a variable to receive the property value.
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
Version 1.10.03 Built on Feb 1, 2018