.. 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/modules/interactive_music/doc_classes/AudioStreamInteractive.xml. .. _class_AudioStreamInteractive: AudioStreamInteractive ====================== **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:`int` | :ref:`clip_count` | ``0`` | +-----------------------+-------------------------------------------------------------------------+-------+ | :ref:`int` | :ref:`initial_clip` | ``0`` | +-----------------------+-------------------------------------------------------------------------+-------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_transition` **(** :ref:`int` from_clip, :ref:`int` to_clip, :ref:`TransitionFromTime` from_time, :ref:`TransitionToTime` to_time, :ref:`FadeMode` fade_mode, :ref:`float` fade_beats, :ref:`bool` use_filler_clip=false, :ref:`int` filler_clip=-1, :ref:`bool` hold_previous=false **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_transition` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AutoAdvanceMode` | :ref:`get_clip_auto_advance` **(** :ref:`int` clip_index **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_clip_auto_advance_next_clip` **(** :ref:`int` clip_index **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_clip_name` **(** :ref:`int` clip_index **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_clip_stream` **(** :ref:`int` clip_index **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_transition_fade_beats` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FadeMode` | :ref:`get_transition_fade_mode` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_transition_filler_clip` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TransitionFromTime` | :ref:`get_transition_from_time` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_transition_list` **(** **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TransitionToTime` | :ref:`get_transition_to_time` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_transition` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_transition_holding_previous` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_transition_using_filler_clip` **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clip_auto_advance` **(** :ref:`int` clip_index, :ref:`AutoAdvanceMode` mode **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clip_auto_advance_next_clip` **(** :ref:`int` clip_index, :ref:`int` auto_advance_next_clip **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clip_name` **(** :ref:`int` clip_index, :ref:`StringName` name **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clip_stream` **(** :ref:`int` clip_index, :ref:`AudioStream` stream **)** | +---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioStreamInteractive_TransitionFromTime: .. rst-class:: classref-enumeration enum **TransitionFromTime**: .. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_IMMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`TransitionFromTime` **TRANSITION_FROM_TIME_IMMEDIATE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_NEXT_BEAT: .. rst-class:: classref-enumeration-constant :ref:`TransitionFromTime` **TRANSITION_FROM_TIME_NEXT_BEAT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_NEXT_BAR: .. rst-class:: classref-enumeration-constant :ref:`TransitionFromTime` **TRANSITION_FROM_TIME_NEXT_BAR** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_TRANSITION_FROM_TIME_END: .. rst-class:: classref-enumeration-constant :ref:`TransitionFromTime` **TRANSITION_FROM_TIME_END** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AudioStreamInteractive_TransitionToTime: .. rst-class:: classref-enumeration enum **TransitionToTime**: .. _class_AudioStreamInteractive_constant_TRANSITION_TO_TIME_SAME_POSITION: .. rst-class:: classref-enumeration-constant :ref:`TransitionToTime` **TRANSITION_TO_TIME_SAME_POSITION** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_TRANSITION_TO_TIME_START: .. rst-class:: classref-enumeration-constant :ref:`TransitionToTime` **TRANSITION_TO_TIME_START** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AudioStreamInteractive_FadeMode: .. rst-class:: classref-enumeration enum **FadeMode**: .. _class_AudioStreamInteractive_constant_FADE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`FadeMode` **FADE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_FADE_IN: .. rst-class:: classref-enumeration-constant :ref:`FadeMode` **FADE_IN** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_FADE_OUT: .. rst-class:: classref-enumeration-constant :ref:`FadeMode` **FADE_OUT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_FADE_CROSS: .. rst-class:: classref-enumeration-constant :ref:`FadeMode` **FADE_CROSS** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_FADE_AUTOMATIC: .. rst-class:: classref-enumeration-constant :ref:`FadeMode` **FADE_AUTOMATIC** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AudioStreamInteractive_AutoAdvanceMode: .. rst-class:: classref-enumeration enum **AutoAdvanceMode**: .. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`AutoAdvanceMode` **AUTO_ADVANCE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_ENABLED: .. rst-class:: classref-enumeration-constant :ref:`AutoAdvanceMode` **AUTO_ADVANCE_ENABLED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamInteractive_constant_AUTO_ADVANCE_RETURN_TO_HOLD: .. rst-class:: classref-enumeration-constant :ref:`AutoAdvanceMode` **AUTO_ADVANCE_RETURN_TO_HOLD** = ``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 Constants --------- .. _class_AudioStreamInteractive_constant_CLIP_ANY: .. rst-class:: classref-constant **CLIP_ANY** = ``-1`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioStreamInteractive_property_clip_count: .. rst-class:: classref-property :ref:`int` **clip_count** = ``0`` .. rst-class:: classref-property-setget - void **set_clip_count** **(** :ref:`int` value **)** - :ref:`int` **get_clip_count** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_property_initial_clip: .. rst-class:: classref-property :ref:`int` **initial_clip** = ``0`` .. rst-class:: classref-property-setget - void **set_initial_clip** **(** :ref:`int` value **)** - :ref:`int` **get_initial_clip** **(** **)** .. 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_AudioStreamInteractive_method_add_transition: .. rst-class:: classref-method void **add_transition** **(** :ref:`int` from_clip, :ref:`int` to_clip, :ref:`TransitionFromTime` from_time, :ref:`TransitionToTime` to_time, :ref:`FadeMode` fade_mode, :ref:`float` fade_beats, :ref:`bool` use_filler_clip=false, :ref:`int` filler_clip=-1, :ref:`bool` hold_previous=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_erase_transition: .. rst-class:: classref-method void **erase_transition** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_clip_auto_advance: .. rst-class:: classref-method :ref:`AutoAdvanceMode` **get_clip_auto_advance** **(** :ref:`int` clip_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_AudioStreamInteractive_method_get_clip_auto_advance_next_clip: .. rst-class:: classref-method :ref:`int` **get_clip_auto_advance_next_clip** **(** :ref:`int` clip_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_AudioStreamInteractive_method_get_clip_name: .. rst-class:: classref-method :ref:`StringName` **get_clip_name** **(** :ref:`int` clip_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_AudioStreamInteractive_method_get_clip_stream: .. rst-class:: classref-method :ref:`AudioStream` **get_clip_stream** **(** :ref:`int` clip_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_AudioStreamInteractive_method_get_transition_fade_beats: .. rst-class:: classref-method :ref:`float` **get_transition_fade_beats** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_transition_fade_mode: .. rst-class:: classref-method :ref:`FadeMode` **get_transition_fade_mode** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_transition_filler_clip: .. rst-class:: classref-method :ref:`int` **get_transition_filler_clip** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_transition_from_time: .. rst-class:: classref-method :ref:`TransitionFromTime` **get_transition_from_time** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_transition_list: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_transition_list** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_get_transition_to_time: .. rst-class:: classref-method :ref:`TransitionToTime` **get_transition_to_time** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_has_transition: .. rst-class:: classref-method :ref:`bool` **has_transition** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_is_transition_holding_previous: .. rst-class:: classref-method :ref:`bool` **is_transition_holding_previous** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_is_transition_using_filler_clip: .. rst-class:: classref-method :ref:`bool` **is_transition_using_filler_clip** **(** :ref:`int` from_clip, :ref:`int` to_clip **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_set_clip_auto_advance: .. rst-class:: classref-method void **set_clip_auto_advance** **(** :ref:`int` clip_index, :ref:`AutoAdvanceMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_set_clip_auto_advance_next_clip: .. rst-class:: classref-method void **set_clip_auto_advance_next_clip** **(** :ref:`int` clip_index, :ref:`int` auto_advance_next_clip **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_set_clip_name: .. rst-class:: classref-method void **set_clip_name** **(** :ref:`int` clip_index, :ref:`StringName` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamInteractive_method_set_clip_stream: .. rst-class:: classref-method void **set_clip_stream** **(** :ref:`int` clip_index, :ref:`AudioStream` stream **)** .. 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.)`