Studio::EventInstance::setProperty

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::EventInstance::setProperty

Sets the value of a built-in event instance property.

C++ Syntax

FMOD_RESULT Studio::EventInstance::setProperty(
  FMOD_STUDIO_EVENT_PROPERTY index,
  float value
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_SetProperty(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_STUDIO_EVENT_PROPERTY index,
  float value
);

C# Syntax

RESULT Studio.EventInstance.setProperty(
  EVENT_PROPERTY index,
  float value
);

JavaScript Syntax

EventInstance.setProperty(
  index,                           
  value                            
);

Parameters

index
The index of the property to set.
value
The property value to set.

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