Firelight Technologies FMOD Studio API

ChannelGroup::setPitch

Sets the pitch value.

C++ Syntax

FMOD_RESULT ChannelGroup::setPitch(
  float pitch
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_SetPitch(
  FMOD_CHANNELGROUP *channelgroup,
  float pitch
);

Parameters

pitch

Pitch value, 0.5 = half pitch, 2.0 = double pitch, etc default = 1.0.

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 scales existing frequency values by the pitch.

See Also

• ChannelControl::getPitch
• ChannelControl::getFrequency

Version 1.03.06 Built on Apr 17, 2014