AudioEffectPitchShift.xml 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioEffectPitchShift" inherits="AudioEffect" version="3.4">
  3. <brief_description>
  4. Adds a pitch-shifting audio effect to an Audio bus.
  5. Raises or lowers the pitch of original sound.
  6. </brief_description>
  7. <description>
  8. Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFT_Size" default="3">
  16. </member>
  17. <member name="oversampling" type="int" setter="set_oversampling" getter="get_oversampling" default="4">
  18. </member>
  19. <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
  20. Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
  21. </member>
  22. </members>
  23. <constants>
  24. <constant name="FFT_SIZE_256" value="0" enum="FFT_Size">
  25. </constant>
  26. <constant name="FFT_SIZE_512" value="1" enum="FFT_Size">
  27. </constant>
  28. <constant name="FFT_SIZE_1024" value="2" enum="FFT_Size">
  29. </constant>
  30. <constant name="FFT_SIZE_2048" value="3" enum="FFT_Size">
  31. </constant>
  32. <constant name="FFT_SIZE_4096" value="4" enum="FFT_Size">
  33. </constant>
  34. <constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size">
  35. Represents the size of the [enum FFT_Size] enum.
  36. </constant>
  37. </constants>
  38. </class>