.. 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/docs/gdscript/doc/classes/AudioStreamRandomizer.xml. .. _class_AudioStreamRandomizer: AudioStreamRandomizer ===================== **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`PlaybackMode` | :ref:`playback_mode` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`random_pitch` | ``1.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`random_volume_offset_db` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`streams_count` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_stream` **(** :ref:`int` index, :ref:`AudioStream` stream, :ref:`float` weight=1.0 **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_stream` **(** :ref:`int` index **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_stream_probability_weight` **(** :ref:`int` index **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_stream` **(** :ref:`int` index_from, :ref:`int` index_to **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_stream` **(** :ref:`int` index **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_stream` **(** :ref:`int` index, :ref:`AudioStream` stream **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_stream_probability_weight` **(** :ref:`int` index, :ref:`float` weight **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioStreamRandomizer_PlaybackMode: .. rst-class:: classref-enumeration enum **PlaybackMode**: .. _class_AudioStreamRandomizer_constant_PLAYBACK_RANDOM_NO_REPEATS: .. rst-class:: classref-enumeration-constant :ref:`PlaybackMode` **PLAYBACK_RANDOM_NO_REPEATS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamRandomizer_constant_PLAYBACK_RANDOM: .. rst-class:: classref-enumeration-constant :ref:`PlaybackMode` **PLAYBACK_RANDOM** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamRandomizer_constant_PLAYBACK_SEQUENTIAL: .. rst-class:: classref-enumeration-constant :ref:`PlaybackMode` **PLAYBACK_SEQUENTIAL** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioStreamRandomizer_property_playback_mode: .. rst-class:: classref-property :ref:`PlaybackMode` **playback_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_playback_mode** **(** :ref:`PlaybackMode` value **)** - :ref:`PlaybackMode` **get_playback_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_property_random_pitch: .. rst-class:: classref-property :ref:`float` **random_pitch** = ``1.0`` .. rst-class:: classref-property-setget - void **set_random_pitch** **(** :ref:`float` value **)** - :ref:`float` **get_random_pitch** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_property_random_volume_offset_db: .. rst-class:: classref-property :ref:`float` **random_volume_offset_db** = ``0.0`` .. rst-class:: classref-property-setget - void **set_random_volume_offset_db** **(** :ref:`float` value **)** - :ref:`float` **get_random_volume_offset_db** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_property_streams_count: .. rst-class:: classref-property :ref:`int` **streams_count** = ``0`` .. rst-class:: classref-property-setget - void **set_streams_count** **(** :ref:`int` value **)** - :ref:`int` **get_streams_count** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamRandomizer_method_add_stream: .. rst-class:: classref-method void **add_stream** **(** :ref:`int` index, :ref:`AudioStream` stream, :ref:`float` weight=1.0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_get_stream: .. rst-class:: classref-method :ref:`AudioStream` **get_stream** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_get_stream_probability_weight: .. rst-class:: classref-method :ref:`float` **get_stream_probability_weight** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_move_stream: .. rst-class:: classref-method void **move_stream** **(** :ref:`int` index_from, :ref:`int` index_to **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_remove_stream: .. rst-class:: classref-method void **remove_stream** **(** :ref:`int` index **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_set_stream: .. rst-class:: classref-method void **set_stream** **(** :ref:`int` index, :ref:`AudioStream` stream **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamRandomizer_method_set_stream_probability_weight: .. rst-class:: classref-method void **set_stream_probability_weight** **(** :ref:`int` index, :ref:`float` weight **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |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.)`