Firelight Technologies FMOD Studio API

ChannelGroup::getPitch

Retrieves the pitch value.

C++ Syntax

FMOD_RESULT ChannelGroup::getPitch(
  float *pitch
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetPitch(
  FMOD_CHANNELGROUP *channelgroup,
  float *pitch
);

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.03.06 Built on Apr 17, 2014