mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
118 lines
5.2 KiB
ReStructuredText
118 lines
5.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectPitchShift.xml.
|
|
|
|
.. _class_AudioEffectPitchShift:
|
|
|
|
AudioEffectPitchShift
|
|
=====================
|
|
|
|
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Adds a pitch-shifting audio effect to an Audio bus.
|
|
|
|
Raises or lowers the pitch of original sound.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
|
| :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` | :ref:`fft_size<class_AudioEffectPitchShift_property_fft_size>` | ``3`` |
|
|
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
|
| :ref:`int<class_int>` | :ref:`oversampling<class_AudioEffectPitchShift_property_oversampling>` | ``4`` |
|
|
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` | ``1.0`` |
|
|
+------------------------------------------------------+------------------------------------------------------------------------+---------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_AudioEffectPitchShift_FFT_Size:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_256:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_512:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_1024:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_2048:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_4096:
|
|
|
|
.. _class_AudioEffectPitchShift_constant_FFT_SIZE_MAX:
|
|
|
|
enum **FFT_Size**:
|
|
|
|
- **FFT_SIZE_256** = **0** --- Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
|
|
|
|
- **FFT_SIZE_512** = **1** --- Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.
|
|
|
|
- **FFT_SIZE_1024** = **2** --- Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
|
|
|
|
- **FFT_SIZE_2048** = **3** --- Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
|
|
|
|
- **FFT_SIZE_4096** = **4** --- Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
|
|
|
|
- **FFT_SIZE_MAX** = **5** --- Represents the size of the :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` enum.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioEffectPitchShift_property_fft_size:
|
|
|
|
- :ref:`FFT_Size<enum_AudioEffectPitchShift_FFT_Size>` **fft_size**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``3`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_fft_size(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_fft_size() |
|
|
+-----------+---------------------+
|
|
|
|
The size of the `Fast Fourier transform <https://en.wikipedia.org/wiki/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.
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectPitchShift_property_oversampling:
|
|
|
|
- :ref:`int<class_int>` **oversampling**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``4`` |
|
|
+-----------+-------------------------+
|
|
| *Setter* | set_oversampling(value) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | get_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.
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectPitchShift_property_pitch_scale:
|
|
|
|
- :ref:`float<class_float>` **pitch_scale**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_pitch_scale(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_pitch_scale() |
|
|
+-----------+------------------------+
|
|
|
|
The pitch scale to use. ``1.0`` is the default pitch and plays sounds unaltered. :ref:`pitch_scale<class_AudioEffectPitchShift_property_pitch_scale>` can range from ``0.0`` (infinitely low pitch, inaudible) to ``16`` (16 times higher than the initial pitch).
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|