class_audiostreamgeneratorplayback.rst 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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 AudioStreamGeneratorPlayback.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioStreamGeneratorPlayback:
  6. AudioStreamGeneratorPlayback
  7. ============================
  8. **Inherits:** :ref:`AudioStreamPlaybackResampled<class_AudioStreamPlaybackResampled>` **<** :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **<** :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. Methods
  13. -------
  14. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`can_push_buffer<class_AudioStreamGeneratorPlayback_method_can_push_buffer>` **(** :ref:`int<class_int>` amount **)** |const| |
  16. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`clear_buffer<class_AudioStreamGeneratorPlayback_method_clear_buffer>` **(** **)** |
  18. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`get_frames_available<class_AudioStreamGeneratorPlayback_method_get_frames_available>` **(** **)** |const| |
  20. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_skips<class_AudioStreamGeneratorPlayback_method_get_skips>` **(** **)** |const| |
  22. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`push_buffer<class_AudioStreamGeneratorPlayback_method_push_buffer>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)** |
  24. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`push_frame<class_AudioStreamGeneratorPlayback_method_push_frame>` **(** :ref:`Vector2<class_Vector2>` frame **)** |
  26. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  27. Method Descriptions
  28. -------------------
  29. .. _class_AudioStreamGeneratorPlayback_method_can_push_buffer:
  30. - :ref:`bool<class_bool>` **can_push_buffer** **(** :ref:`int<class_int>` amount **)** |const|
  31. ----
  32. .. _class_AudioStreamGeneratorPlayback_method_clear_buffer:
  33. - void **clear_buffer** **(** **)**
  34. ----
  35. .. _class_AudioStreamGeneratorPlayback_method_get_frames_available:
  36. - :ref:`int<class_int>` **get_frames_available** **(** **)** |const|
  37. ----
  38. .. _class_AudioStreamGeneratorPlayback_method_get_skips:
  39. - :ref:`int<class_int>` **get_skips** **(** **)** |const|
  40. ----
  41. .. _class_AudioStreamGeneratorPlayback_method_push_buffer:
  42. - :ref:`bool<class_bool>` **push_buffer** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` frames **)**
  43. ----
  44. .. _class_AudioStreamGeneratorPlayback_method_push_frame:
  45. - :ref:`bool<class_bool>` **push_frame** **(** :ref:`Vector2<class_Vector2>` frame **)**
  46. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  47. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  48. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`