class_audiostreamplaybackinteractive.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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/modules/interactive_music/doc_classes/AudioStreamPlaybackInteractive.xml.
  6. .. _class_AudioStreamPlaybackInteractive:
  7. AudioStreamPlaybackInteractive
  8. ==============================
  9. **Inherits:** :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Playback component of :ref:`AudioStreamInteractive<class_AudioStreamInteractive>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Playback component of :ref:`AudioStreamInteractive<class_AudioStreamInteractive>`. Contains functions to change the currently played clip.
  15. .. rst-class:: classref-reftable-group
  16. Methods
  17. -------
  18. .. table::
  19. :widths: auto
  20. +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | |void| | :ref:`switch_to_clip<class_AudioStreamPlaybackInteractive_method_switch_to_clip>`\ (\ clip_index\: :ref:`int<class_int>`\ ) |
  22. +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | |void| | :ref:`switch_to_clip_by_name<class_AudioStreamPlaybackInteractive_method_switch_to_clip_by_name>`\ (\ clip_name\: :ref:`StringName<class_StringName>`\ ) |
  24. +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. .. rst-class:: classref-section-separator
  26. ----
  27. .. rst-class:: classref-descriptions-group
  28. Method Descriptions
  29. -------------------
  30. .. _class_AudioStreamPlaybackInteractive_method_switch_to_clip:
  31. .. rst-class:: classref-method
  32. |void| **switch_to_clip**\ (\ clip_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_AudioStreamPlaybackInteractive_method_switch_to_clip>`
  33. Switch to a clip (by index).
  34. .. rst-class:: classref-item-separator
  35. ----
  36. .. _class_AudioStreamPlaybackInteractive_method_switch_to_clip_by_name:
  37. .. rst-class:: classref-method
  38. |void| **switch_to_clip_by_name**\ (\ clip_name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AudioStreamPlaybackInteractive_method_switch_to_clip_by_name>`
  39. Switch to a clip (by name).
  40. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  41. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  42. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  43. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  44. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  45. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  46. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  47. .. |void| replace:: :abbr:`void (No return value.)`