Channel::getPitch

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::getPitch

Retrieves the pitch value.

C++ Syntax

FMOD_RESULT Channel::getPitch(
  float *pitch
);

C Syntax

FMOD_RESULT FMOD_Channel_GetPitch(
  FMOD_CHANNEL *channel,
  float *pitch
);

C# Syntax

RESULT Channel.getPitch(
  out float pitch
);

JavaScript Syntax

Channel.getPitch(
  pitch                            // writes value to pitch.val
);

Parameters

pitch
Address of a variable to receive the pitch value, 0.5 = half pitch, 2.0 = double pitch, etc.

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