class_audiostreamrandompitch.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioStreamRandomPitch:
  6. AudioStreamRandomPitch
  7. ======================
  8. **Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Plays audio with random pitch shifting.
  13. Properties
  14. ----------
  15. +---------------------------------------+-------------------------------------------------------------------------+-----+
  16. | :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
  17. +---------------------------------------+-------------------------------------------------------------------------+-----+
  18. | :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | 1.1 |
  19. +---------------------------------------+-------------------------------------------------------------------------+-----+
  20. Description
  21. -----------
  22. Randomly varies pitch on each start.
  23. Property Descriptions
  24. ---------------------
  25. .. _class_AudioStreamRandomPitch_property_audio_stream:
  26. - :ref:`AudioStream<class_AudioStream>` **audio_stream**
  27. +----------+-------------------------+
  28. | *Setter* | set_audio_stream(value) |
  29. +----------+-------------------------+
  30. | *Getter* | get_audio_stream() |
  31. +----------+-------------------------+
  32. The current :ref:`AudioStream<class_AudioStream>`.
  33. .. _class_AudioStreamRandomPitch_property_random_pitch:
  34. - :ref:`float<class_float>` **random_pitch**
  35. +-----------+-------------------------+
  36. | *Default* | 1.1 |
  37. +-----------+-------------------------+
  38. | *Setter* | set_random_pitch(value) |
  39. +-----------+-------------------------+
  40. | *Getter* | get_random_pitch() |
  41. +-----------+-------------------------+
  42. The intensity of random pitch variation.