Firelight Technologies FMOD Studio API

Channel::setPitch

Sets the pitch value.

C++ Syntax

FMOD_RESULT Channel::setPitch(
  float pitch
);

C Syntax

FMOD_RESULT FMOD_Channel_SetPitch(
  FMOD_CHANNEL *channel,
  float pitch
);

C# Syntax

RESULT Channel.setPitch(
  float pitch
);

JavaScript Syntax

Channel.setPitch(
  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
• Channel::setFrequency
• Channel::getFrequency

Version 1.10.03 Built on Feb 1, 2018