virtualx-engine/doc/classes/AudioEffectPitchShift.xml

39 lines
1.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 12:33:56 +02:00
<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.2">
<brief_description>
Adds a pitch-shifting audio effect to an Audio bus.
2017-09-16 18:47:19 +02:00
Raises or lowers the pitch of original sound.
</brief_description>
<description>
2017-09-16 18:47:19 +02:00
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
2019-06-24 10:39:59 +02:00
<member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFT_Size">
</member>
<member name="oversampling" type="int" setter="set_oversampling" getter="get_oversampling">
</member>
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
2017-09-16 18:47:19 +02:00
Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
</member>
</members>
<constants>
2019-06-24 10:39:59 +02:00
<constant name="FFT_SIZE_256" value="0" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_512" value="1" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_1024" value="2" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_2048" value="3" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_4096" value="4" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size">
Represents the size of the [enum FFT_Size] enum.
2019-06-24 10:39:59 +02:00
</constant>
</constants>
</class>