class_audiostreamplayback.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlayback.xml.
  6. .. _class_AudioStreamPlayback:
  7. AudioStreamPlayback
  8. ===================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AudioStreamPlaybackInteractive<class_AudioStreamPlaybackInteractive>`, :ref:`AudioStreamPlaybackPlaylist<class_AudioStreamPlaybackPlaylist>`, :ref:`AudioStreamPlaybackPolyphonic<class_AudioStreamPlaybackPolyphonic>`, :ref:`AudioStreamPlaybackResampled<class_AudioStreamPlaybackResampled>`, :ref:`AudioStreamPlaybackSynchronized<class_AudioStreamPlaybackSynchronized>`
  11. Meta class for playing back audio.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Can play, loop, pause a scroll through audio. See :ref:`AudioStream<class_AudioStream>` and :ref:`AudioStreamOggVorbis<class_AudioStreamOggVorbis>` for usage.
  16. .. rst-class:: classref-introduction-group
  17. Tutorials
  18. ---------
  19. - `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`__
  20. .. rst-class:: classref-reftable-group
  21. Methods
  22. -------
  23. .. table::
  24. :widths: auto
  25. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`int<class_int>` | :ref:`_get_loop_count<class_AudioStreamPlayback_private_method__get_loop_count>`\ (\ ) |virtual| |const| |
  27. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`Variant<class_Variant>` | :ref:`_get_parameter<class_AudioStreamPlayback_private_method__get_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const| |
  29. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`float<class_float>` | :ref:`_get_playback_position<class_AudioStreamPlayback_private_method__get_playback_position>`\ (\ ) |virtual| |const| |
  31. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`_is_playing<class_AudioStreamPlayback_private_method__is_playing>`\ (\ ) |virtual| |const| |
  33. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`int<class_int>` | :ref:`_mix<class_AudioStreamPlayback_private_method__mix>`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |virtual| |
  35. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | |void| | :ref:`_seek<class_AudioStreamPlayback_private_method__seek>`\ (\ position\: :ref:`float<class_float>`\ ) |virtual| |
  37. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | |void| | :ref:`_set_parameter<class_AudioStreamPlayback_private_method__set_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |virtual| |
  39. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | |void| | :ref:`_start<class_AudioStreamPlayback_private_method__start>`\ (\ from_pos\: :ref:`float<class_float>`\ ) |virtual| |
  41. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`_stop<class_AudioStreamPlayback_private_method__stop>`\ (\ ) |virtual| |
  43. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | |void| | :ref:`_tag_used_streams<class_AudioStreamPlayback_private_method__tag_used_streams>`\ (\ ) |virtual| |
  45. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. .. rst-class:: classref-section-separator
  47. ----
  48. .. rst-class:: classref-descriptions-group
  49. Method Descriptions
  50. -------------------
  51. .. _class_AudioStreamPlayback_private_method__get_loop_count:
  52. .. rst-class:: classref-method
  53. :ref:`int<class_int>` **_get_loop_count**\ (\ ) |virtual| |const|
  54. Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return ``0``.
  55. .. rst-class:: classref-item-separator
  56. ----
  57. .. _class_AudioStreamPlayback_private_method__get_parameter:
  58. .. rst-class:: classref-method
  59. :ref:`Variant<class_Variant>` **_get_parameter**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const|
  60. Return the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list<class_AudioStream_private_method__get_parameter_list>`).
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_AudioStreamPlayback_private_method__get_playback_position:
  64. .. rst-class:: classref-method
  65. :ref:`float<class_float>` **_get_playback_position**\ (\ ) |virtual| |const|
  66. Overridable method. Should return the current progress along the audio stream, in seconds.
  67. .. rst-class:: classref-item-separator
  68. ----
  69. .. _class_AudioStreamPlayback_private_method__is_playing:
  70. .. rst-class:: classref-method
  71. :ref:`bool<class_bool>` **_is_playing**\ (\ ) |virtual| |const|
  72. Overridable method. Should return ``true`` if this playback is active and playing its audio stream.
  73. .. rst-class:: classref-item-separator
  74. ----
  75. .. _class_AudioStreamPlayback_private_method__mix:
  76. .. rst-class:: classref-method
  77. :ref:`int<class_int>` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float<class_float>`, frames\: :ref:`int<class_int>`\ ) |virtual|
  78. Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active.
  79. \ **Note:** It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it.
  80. .. rst-class:: classref-item-separator
  81. ----
  82. .. _class_AudioStreamPlayback_private_method__seek:
  83. .. rst-class:: classref-method
  84. |void| **_seek**\ (\ position\: :ref:`float<class_float>`\ ) |virtual|
  85. Override this method to customize what happens when seeking this audio stream at the given ``position``, such as by calling :ref:`AudioStreamPlayer.seek<class_AudioStreamPlayer_method_seek>`.
  86. .. rst-class:: classref-item-separator
  87. ----
  88. .. _class_AudioStreamPlayback_private_method__set_parameter:
  89. .. rst-class:: classref-method
  90. |void| **_set_parameter**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |virtual|
  91. Set the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list<class_AudioStream_private_method__get_parameter_list>`).
  92. .. rst-class:: classref-item-separator
  93. ----
  94. .. _class_AudioStreamPlayback_private_method__start:
  95. .. rst-class:: classref-method
  96. |void| **_start**\ (\ from_pos\: :ref:`float<class_float>`\ ) |virtual|
  97. Override this method to customize what happens when the playback starts at the given position, such as by calling :ref:`AudioStreamPlayer.play<class_AudioStreamPlayer_method_play>`.
  98. .. rst-class:: classref-item-separator
  99. ----
  100. .. _class_AudioStreamPlayback_private_method__stop:
  101. .. rst-class:: classref-method
  102. |void| **_stop**\ (\ ) |virtual|
  103. Override this method to customize what happens when the playback is stopped, such as by calling :ref:`AudioStreamPlayer.stop<class_AudioStreamPlayer_method_stop>`.
  104. .. rst-class:: classref-item-separator
  105. ----
  106. .. _class_AudioStreamPlayback_private_method__tag_used_streams:
  107. .. rst-class:: classref-method
  108. |void| **_tag_used_streams**\ (\ ) |virtual|
  109. Overridable method. Called whenever the audio stream is mixed if the playback is active and :ref:`AudioServer.set_enable_tagging_used_audio_streams<class_AudioServer_method_set_enable_tagging_used_audio_streams>` has been set to ``true``. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview.
  110. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  111. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  112. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  113. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  114. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  115. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  116. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  117. .. |void| replace:: :abbr:`void (No return value.)`