Firelight Technologies FMOD Studio API

Studio::EventInstance::getPitch

Retrieves the pitch multiplier set by the API on the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getPitch(
  float *pitch,
  float *finalpitch
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetPitch(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  float *pitch,
  float *finalpitch
);

C# Syntax

RESULT Studio.EventInstance.getPitch(
  out float pitch,
  out float finalpitch
);

JavaScript Syntax

EventInstance.getPitch(
  pitch,                           // writes value to pitch.val
  finalpitch                       // writes value to finalpitch.val
);

Parameters

pitch

Address of a variable to receive the pitch as set from the public API. Specify 0 or NULL to ignore.

finalpitch

Address of a variable to receive the final combined pitch. Specify 0 or NULL to ignore.

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 function can return both the pitch set from the last call to Studio::EventInstance::setPitch, as well as the final combined pitch which may be the result of automation and modulation.

NOTE: The final pitch will not change immediately. It will change during subsequent asynchronous updates.

See Also

• Studio::EventInstance::setPitch

Version 1.10.03 Built on Feb 1, 2018