:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/modules/interactive_music/doc_classes/AudioStreamSynchronized.xml. .. _class_AudioStreamSynchronized: AudioStreamSynchronized ======================= **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Stream that can be fitted with sub-streams, which will be played in-sync. .. rst-class:: classref-introduction-group Description ----------- This is a stream that can be fitted with sub-streams, which will be played in-sync. The streams begin at exactly the same time when play is pressed, and will end when the last of them ends. If one of the sub-streams loops, then playback will continue. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+--------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`stream_count` | ``0`` | +-----------------------+--------------------------------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_sync_stream`\ (\ stream_index\: :ref:`int`\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_sync_stream_volume`\ (\ stream_index\: :ref:`int`\ ) |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_sync_stream`\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_sync_stream_volume`\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_AudioStreamSynchronized_constant_MAX_STREAMS: .. rst-class:: classref-constant **MAX_STREAMS** = ``32`` :ref:`🔗` Maximum amount of streams that can be synchronized. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioStreamSynchronized_property_stream_count: .. rst-class:: classref-property :ref:`int` **stream_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_stream_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_stream_count**\ (\ ) Set the total amount of streams that will be played back synchronized. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamSynchronized_method_get_sync_stream: .. rst-class:: classref-method :ref:`AudioStream` **get_sync_stream**\ (\ stream_index\: :ref:`int`\ ) |const| :ref:`🔗` Get one of the synchronized streams, by index. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamSynchronized_method_get_sync_stream_volume: .. rst-class:: classref-method :ref:`float` **get_sync_stream_volume**\ (\ stream_index\: :ref:`int`\ ) |const| :ref:`🔗` Get the volume of one of the synchronized streams, by index. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamSynchronized_method_set_sync_stream: .. rst-class:: classref-method |void| **set_sync_stream**\ (\ stream_index\: :ref:`int`, audio_stream\: :ref:`AudioStream`\ ) :ref:`🔗` Set one of the synchronized streams, by index. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamSynchronized_method_set_sync_stream_volume: .. rst-class:: classref-method |void| **set_sync_stream_volume**\ (\ stream_index\: :ref:`int`, volume_db\: :ref:`float`\ ) :ref:`🔗` Set the volume of one of the synchronized streams, by index. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`