Firelight Technologies FMOD Studio API
Studio::EventInstance::setPitch
Sets the pitch multiplier for the event instance.
C++ Syntax
FMOD_RESULT Studio::EventInstance::setPitch(
float pitch
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_SetPitch(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
float pitch
);
C# Syntax
RESULT Studio.EventInstance.setPitch(
float pitch
);
JavaScript Syntax
EventInstance.setPitch(
pitch
);
Parameters
- pitch
- The pitch multiplier. 1 = normal pitch.
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
This pitch is applied as a multiplier for the event pitch. It does not override the pitch set in FMOD Studio, nor any internal pitch automation or modulation.
See Also
Version 1.10.03 Built on Feb 1, 2018