class_audiostreamgenerator.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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 AudioStreamGenerator.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioStreamGenerator:
  6. AudioStreamGenerator
  7. ====================
  8. **Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Tutorials
  10. ---------
  11. - `https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator <https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator>`_
  12. Properties
  13. ----------
  14. +---------------------------+-------------------------------------------------------------------------+-------------+
  15. | :ref:`float<class_float>` | :ref:`buffer_length<class_AudioStreamGenerator_property_buffer_length>` | ``0.5`` |
  16. +---------------------------+-------------------------------------------------------------------------+-------------+
  17. | :ref:`float<class_float>` | :ref:`mix_rate<class_AudioStreamGenerator_property_mix_rate>` | ``44100.0`` |
  18. +---------------------------+-------------------------------------------------------------------------+-------------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_AudioStreamGenerator_property_buffer_length:
  22. - :ref:`float<class_float>` **buffer_length**
  23. +-----------+--------------------------+
  24. | *Default* | ``0.5`` |
  25. +-----------+--------------------------+
  26. | *Setter* | set_buffer_length(value) |
  27. +-----------+--------------------------+
  28. | *Getter* | get_buffer_length() |
  29. +-----------+--------------------------+
  30. ----
  31. .. _class_AudioStreamGenerator_property_mix_rate:
  32. - :ref:`float<class_float>` **mix_rate**
  33. +-----------+---------------------+
  34. | *Default* | ``44100.0`` |
  35. +-----------+---------------------+
  36. | *Setter* | set_mix_rate(value) |
  37. +-----------+---------------------+
  38. | *Getter* | get_mix_rate() |
  39. +-----------+---------------------+
  40. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  41. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  42. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`