Documentation
¶
Overview ¶
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
Index ¶
- type Advanced
- type Any
- type Extension
- type FFTSize
- type ID
- type Instance
- func (self Instance) AsAudioEffect() AudioEffect.Instance
- func (self Instance) AsAudioEffectPitchShift() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) FftSize() FFTSize
- func (self Instance) ID() ID
- func (self Instance) Oversampling() int
- func (self Instance) PitchScale() Float.X
- func (self Instance) SetFftSize(value FFTSize)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetOversampling(value int)
- func (self Instance) SetPitchScale(value Float.X)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsAudioEffect ¶
func (self *Extension[T]) AsAudioEffect() AudioEffect.Instance
func (*Extension[T]) AsAudioEffectPitchShift ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type FFTSize ¶
type FFTSize int //gd:AudioEffectPitchShift.FFTSize
const ( // Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time. FftSize256 FFTSize = 0 // Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time. FftSize512 FFTSize = 1 // Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time. FftSize1024 FFTSize = 2 // Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time. FftSize2048 FFTSize = 3 // Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time. FftSize4096 FFTSize = 4 // Represents the size of the [FFTSize] enum. FftSizeMax FFTSize = 5 )
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.AudioEffectPitchShift
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsAudioEffect ¶
func (self Instance) AsAudioEffect() AudioEffect.Instance
func (Instance) AsAudioEffectPitchShift ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) 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.
func (Instance) 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.
func (Instance) 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).
func (Instance) SetFftSize ¶
SetFftSize sets the property returned by [GetFftSize].
func (Instance) SetOversampling ¶
SetOversampling sets the property returned by [GetOversampling].
func (Instance) SetPitchScale ¶
SetPitchScale sets the property returned by [GetPitchScale].
Source Files