Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_audiostreamplaybackpolyphonic.rst

class_audiostreamplaybackpolyphonic.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamPlaybackPolyphonic.xml.
    7. 

  7. 

  8. .. _class_AudioStreamPlaybackPolyphonic:
    9. 

  9. 

  10. AudioStreamPlaybackPolyphonic
    11. 

  11. =============================
    12. 

  12. 

  13. **Inherits:** :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Playback instance for :ref:`AudioStreamPolyphonic<class_AudioStreamPolyphonic>`.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. Playback instance for :ref:`AudioStreamPolyphonic<class_AudioStreamPolyphonic>`. After setting the ``stream`` property of :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`, :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>`, or :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>`, the playback instance can be obtained by calling :ref:`AudioStreamPlayer.get_stream_playback<class_AudioStreamPlayer_method_get_stream_playback>`, :ref:`AudioStreamPlayer2D.get_stream_playback<class_AudioStreamPlayer2D_method_get_stream_playback>` or :ref:`AudioStreamPlayer3D.get_stream_playback<class_AudioStreamPlayer3D_method_get_stream_playback>` methods.
    23. 

  23. 

  24. .. rst-class:: classref-reftable-group
    25. 

  25. 

  26. Methods
    27. 

  27. -------
    28. 

  28. 

  29. .. table::
    30. 

  30.    :widths: auto
    31. 

  31. 

  32.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33.    | :ref:`bool<class_bool>` | :ref:`is_stream_playing<class_AudioStreamPlaybackPolyphonic_method_is_stream_playing>`\ (\ stream\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                   |
    34. 

  34.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35.    | :ref:`int<class_int>`   | :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>`\ (\ stream\: :ref:`AudioStream<class_AudioStream>`, from_offset\: :ref:`float<class_float>` = 0, volume_db\: :ref:`float<class_float>` = 0, pitch_scale\: :ref:`float<class_float>` = 1.0, playback_type\: :ref:`PlaybackType<enum_AudioServer_PlaybackType>` = 0, bus\: :ref:`StringName<class_StringName>` = &"Master"\ ) |
    36. 

  36.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | |void|                  | :ref:`set_stream_pitch_scale<class_AudioStreamPlaybackPolyphonic_method_set_stream_pitch_scale>`\ (\ stream\: :ref:`int<class_int>`, pitch_scale\: :ref:`float<class_float>`\ )                                                                                                                                                                                                                        |
    38. 

  38.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | |void|                  | :ref:`set_stream_volume<class_AudioStreamPlaybackPolyphonic_method_set_stream_volume>`\ (\ stream\: :ref:`int<class_int>`, volume_db\: :ref:`float<class_float>`\ )                                                                                                                                                                                                                                    |
    40. 

  40.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | |void|                  | :ref:`stop_stream<class_AudioStreamPlaybackPolyphonic_method_stop_stream>`\ (\ stream\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                       |
    42. 

  42.    +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. 

  44. .. rst-class:: classref-section-separator
    45. 

  45. 

  46. ----
    47. 

  47. 

  48. .. rst-class:: classref-descriptions-group
    49. 

  49. 

  50. Constants
    51. 

  51. ---------
    52. 

  52. 

  53. .. _class_AudioStreamPlaybackPolyphonic_constant_INVALID_ID:
    54. 

  54. 

  55. .. rst-class:: classref-constant
    56. 

  56. 

  57. **INVALID_ID** = ``-1`` :ref:`🔗<class_AudioStreamPlaybackPolyphonic_constant_INVALID_ID>`
    58. 

  58. 

  59. Returned by :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>` in case it could not allocate a stream for playback.
    60. 

  60. 

  61. .. rst-class:: classref-section-separator
    62. 

  62. 

  63. ----
    64. 

  64. 

  65. .. rst-class:: classref-descriptions-group
    66. 

  66. 

  67. Method Descriptions
    68. 

  68. -------------------
    69. 

  69. 

  70. .. _class_AudioStreamPlaybackPolyphonic_method_is_stream_playing:
    71. 

  71. 

  72. .. rst-class:: classref-method
    73. 

  73. 

  74. :ref:`bool<class_bool>` **is_stream_playing**\ (\ stream\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_is_stream_playing>`
    75. 

  75. 

  76. Returns ``true`` if the stream associated with the given integer ID is still playing. Check :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>` for information on when this ID becomes invalid.
    77. 

  77. 

  78. .. rst-class:: classref-item-separator
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_AudioStreamPlaybackPolyphonic_method_play_stream:
    83. 

  83. 

  84. .. rst-class:: classref-method
    85. 

  85. 

  86. :ref:`int<class_int>` **play_stream**\ (\ stream\: :ref:`AudioStream<class_AudioStream>`, from_offset\: :ref:`float<class_float>` = 0, volume_db\: :ref:`float<class_float>` = 0, pitch_scale\: :ref:`float<class_float>` = 1.0, playback_type\: :ref:`PlaybackType<enum_AudioServer_PlaybackType>` = 0, bus\: :ref:`StringName<class_StringName>` = &"Master"\ ) :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_play_stream>`
    87. 

  87. 

  88. Play an :ref:`AudioStream<class_AudioStream>` at a given offset, volume, pitch scale, playback type, and bus. Playback starts immediately.
    89. 

  89. 

  90. The return value is a unique integer ID that is associated to this playback stream and which can be used to control it.
    91. 

  91. 

  92. This ID becomes invalid when the stream ends (if it does not loop), when the **AudioStreamPlaybackPolyphonic** is stopped, or when :ref:`stop_stream<class_AudioStreamPlaybackPolyphonic_method_stop_stream>` is called.
    93. 

  93. 

  94. This function returns :ref:`INVALID_ID<class_AudioStreamPlaybackPolyphonic_constant_INVALID_ID>` if the amount of streams currently playing equals :ref:`AudioStreamPolyphonic.polyphony<class_AudioStreamPolyphonic_property_polyphony>`. If you need a higher amount of maximum polyphony, raise this value.
    95. 

  95. 

  96. .. rst-class:: classref-item-separator
    97. 

  97. 

  98. ----
    99. 

  99. 

  100. .. _class_AudioStreamPlaybackPolyphonic_method_set_stream_pitch_scale:
    101. 

  101. 

  102. .. rst-class:: classref-method
    103. 

  103. 

  104. |void| **set_stream_pitch_scale**\ (\ stream\: :ref:`int<class_int>`, pitch_scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_set_stream_pitch_scale>`
    105. 

  105. 

  106. Change the stream pitch scale. The ``stream`` argument is an integer ID returned by :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>`.
    107. 

  107. 

  108. .. rst-class:: classref-item-separator
    109. 

  109. 

  110. ----
    111. 

  111. 

  112. .. _class_AudioStreamPlaybackPolyphonic_method_set_stream_volume:
    113. 

  113. 

  114. .. rst-class:: classref-method
    115. 

  115. 

  116. |void| **set_stream_volume**\ (\ stream\: :ref:`int<class_int>`, volume_db\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_set_stream_volume>`
    117. 

  117. 

  118. Change the stream volume (in db). The ``stream`` argument is an integer ID returned by :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>`.
    119. 

  119. 

  120. .. rst-class:: classref-item-separator
    121. 

  121. 

  122. ----
    123. 

  123. 

  124. .. _class_AudioStreamPlaybackPolyphonic_method_stop_stream:
    125. 

  125. 

  126. .. rst-class:: classref-method
    127. 

  127. 

  128. |void| **stop_stream**\ (\ stream\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioStreamPlaybackPolyphonic_method_stop_stream>`
    129. 

  129. 

  130. Stop a stream. The ``stream`` argument is an integer ID returned by :ref:`play_stream<class_AudioStreamPlaybackPolyphonic_method_play_stream>`, which becomes invalid after calling this function.
    131. 

  131. 

  132. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    133. 

  133. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    134. 

  134. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    135. 

  135. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    136. 

  136. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    137. 

  137. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    138. 

  138. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    139. 

  139. .. |void| replace:: :abbr:`void (No return value.)`
    140. 

  140.