godot/doc/classes/AudioEffectPitchShift.xml

38 lines
1.0 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0-alpha">
<brief_description>
2017-09-16 16:47:19 +00:00
Adds a Pitch shift audio effect to an Audio bus.
Raises or lowers the pitch of original sound.
</brief_description>
<description>
2017-09-16 16:47:19 +00:00
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_pitch_scale" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_pitch_scale">
<return type="void">
</return>
<argument index="0" name="rate" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
2017-09-16 16:47:19 +00:00
Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
</member>
</members>
<constants>
</constants>
</class>