Table of Contents

Class AudioEffectPitchShift

Namespace
Godot
Assembly
GodotSharp.dll

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

public class AudioEffectPitchShift : AudioEffect, IDisposable
Inheritance
AudioEffectPitchShift
Implements
Inherited Members

Constructors

AudioEffectPitchShift() 

public AudioEffectPitchShift()

Properties

FftSize

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.

public AudioEffectPitchShift.FftSizeEnum FftSize { get; set; }

Property Value

AudioEffectPitchShift.FftSizeEnum

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.

public int Oversampling { get; set; }

Property Value

int

PitchScale

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

public float PitchScale { get; set; }

Property Value

float

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page