Table of Contents

Class AudioEffectPitchShift

Adds a pitch-shifting audio effect to an audio bus.

Raises or lowers the pitch of original sound.

Inheritance
AudioEffectPitchShift

Remarks

Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.

See Also

Audio buses

Properties

fft_size

The size of the Fast Fourier transform buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes.

var fft_size : int = 3

Property Value

int

Remarks

  • void set_fft_size(int value)
  • int get_fft_size

oversampling

The oversampling factor to use. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can't keep up.

var oversampling : int = 4

Property Value

int

Remarks

  • void set_oversampling(int value)
  • int get_oversampling

pitch_scale

The pitch scale to use. 1.0 is the default pitch and plays sounds unaffected. pitch_scale can range from 0.0 (infinitely low pitch, inaudible) to 16 (16 times higher than the initial pitch).

var pitch_scale : float = 1.0

Property Value

float

Remarks

  • void set_pitch_scale(float value)
  • float get_pitch_scale