mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
Update class reference
This commit is contained in:
126
classes/class_audiostreamplayer.rst
Normal file
126
classes/class_audiostreamplayer.rst
Normal file
@@ -0,0 +1,126 @@
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||
|
||||
.. _class_AudioStreamPlayer:
|
||||
|
||||
AudioStreamPlayer
|
||||
=================
|
||||
|
||||
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer_get_bus>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioStreamPlayer_get_mix_target>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer_get_pos>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_stream<class_AudioStreamPlayer_get_stream>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer_get_volume_db>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_autoplay<class_AudioStreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus<class_AudioStreamPlayer_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix_target<class_AudioStreamPlayer_set_mix_target>` **(** :ref:`int<class_int>` mix_target **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_stream<class_AudioStreamPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`bool<class_bool>` **autoplay**
|
||||
- :ref:`String<class_string>` **bus**
|
||||
- :ref:`int<class_int>` **mix_target**
|
||||
- :ref:`bool<class_bool>` **playing**
|
||||
- :ref:`AudioStream<class_audiostream>` **stream**
|
||||
- :ref:`float<class_float>` **volume_db**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_AudioStreamPlayer_get_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_mix_target:
|
||||
|
||||
- :ref:`int<class_int>` **get_mix_target** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_pos:
|
||||
|
||||
- :ref:`float<class_float>` **get_pos** **(** **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_get_stream:
|
||||
|
||||
- :ref:`Object<class_object>` **get_stream** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_is_autoplay_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_pos **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_autoplay:
|
||||
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_bus:
|
||||
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_mix_target:
|
||||
|
||||
- void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_stream:
|
||||
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_volume_db:
|
||||
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user