Inheritance #

AudioEffectPitchShift #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

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

Raises or lowers the pitch of original sound.

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

Members #

var fft_size = FFT_SIZE_2048#

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 oversampling: int = 4#

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 pitch_scale: float = 1.0#

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).

Methods #

Annotations #

Constants #

const FFT_SIZE_256 = 0 enum FFTSize#

Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.

const FFT_SIZE_512 = 1 enum FFTSize#

Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.

const FFT_SIZE_1024 = 2 enum FFTSize#

Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.

const FFT_SIZE_2048 = 3 enum FFTSize#

Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.

const FFT_SIZE_4096 = 4 enum FFTSize#

Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.

const FFT_SIZE_MAX = 5 enum FFTSize#

Represents the size of the FFTSize enum.

Constructors #

Enums #

FFTSize#

Operators #

Signals #

Theme Items #

Tutorials #