godot-docs/classes/class_audiostreamsample.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioStreamSample.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioStreamSample:

AudioStreamSample
=================

**Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Plays audio.

Member Functions
----------------

+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>`  | :ref:`get_data<class_AudioStreamSample_get_data>`  **(** **)** const                                           |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_format<class_AudioStreamSample_get_format>`  **(** **)** const                                       |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_loop_begin<class_AudioStreamSample_get_loop_begin>`  **(** **)** const                               |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_loop_end<class_AudioStreamSample_get_loop_end>`  **(** **)** const                                   |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_loop_mode<class_AudioStreamSample_get_loop_mode>`  **(** **)** const                                 |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_mix_rate<class_AudioStreamSample_get_mix_rate>`  **(** **)** const                                   |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                    | :ref:`is_stereo<class_AudioStreamSample_is_stereo>`  **(** **)** const                                         |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_data<class_AudioStreamSample_set_data>`  **(** :ref:`PoolByteArray<class_poolbytearray>` data  **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_format<class_AudioStreamSample_set_format>`  **(** :ref:`int<class_int>` format  **)**               |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_loop_begin<class_AudioStreamSample_set_loop_begin>`  **(** :ref:`int<class_int>` loop_begin  **)**   |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_loop_end<class_AudioStreamSample_set_loop_end>`  **(** :ref:`int<class_int>` loop_end  **)**         |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_loop_mode<class_AudioStreamSample_set_loop_mode>`  **(** :ref:`int<class_int>` loop_mode  **)**      |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_mix_rate<class_AudioStreamSample_set_mix_rate>`  **(** :ref:`int<class_int>` mix_rate  **)**         |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_stereo<class_AudioStreamSample_set_stereo>`  **(** :ref:`bool<class_bool>` stereo  **)**             |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`PoolByteArray<class_poolbytearray>` **data** - Raw audio data.
- :ref:`int<class_int>` **format** - Audio format. See FORMAT\_\* constants for values.
- :ref:`int<class_int>` **loop_begin** - Loop start in bytes.
- :ref:`int<class_int>` **loop_end** - Loop end in bytes.
- :ref:`int<class_int>` **loop_mode** - Loop mode. See LOOP\_\* constants for values.
- :ref:`int<class_int>` **mix_rate** - The sample rate for mixing this audio.
- :ref:`bool<class_bool>` **stereo** - If ``true``, audio is stereo. Default value: ``false``.

Numeric Constants
-----------------

- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit.
- **FORMAT_16_BITS** = **1** --- Audio codec 16 bit.
- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM.
- **LOOP_DISABLED** = **0** --- Audio does not loop.
- **LOOP_FORWARD** = **1** --- Audio loops the data between loop_begin and loop_end playing forward only.
- **LOOP_PING_PONG** = **2** --- Audio loops the data between loop_begin and loop_end playing back and forth.

Description
-----------

Plays audio, can loop.

Member Function Description
---------------------------

.. _class_AudioStreamSample_get_data:

- :ref:`PoolByteArray<class_poolbytearray>`  **get_data**  **(** **)** const

.. _class_AudioStreamSample_get_format:

- :ref:`int<class_int>`  **get_format**  **(** **)** const

.. _class_AudioStreamSample_get_loop_begin:

- :ref:`int<class_int>`  **get_loop_begin**  **(** **)** const

.. _class_AudioStreamSample_get_loop_end:

- :ref:`int<class_int>`  **get_loop_end**  **(** **)** const

.. _class_AudioStreamSample_get_loop_mode:

- :ref:`int<class_int>`  **get_loop_mode**  **(** **)** const

.. _class_AudioStreamSample_get_mix_rate:

- :ref:`int<class_int>`  **get_mix_rate**  **(** **)** const

.. _class_AudioStreamSample_is_stereo:

- :ref:`bool<class_bool>`  **is_stereo**  **(** **)** const

.. _class_AudioStreamSample_set_data:

- void  **set_data**  **(** :ref:`PoolByteArray<class_poolbytearray>` data  **)**

.. _class_AudioStreamSample_set_format:

- void  **set_format**  **(** :ref:`int<class_int>` format  **)**

.. _class_AudioStreamSample_set_loop_begin:

- void  **set_loop_begin**  **(** :ref:`int<class_int>` loop_begin  **)**

.. _class_AudioStreamSample_set_loop_end:

- void  **set_loop_end**  **(** :ref:`int<class_int>` loop_end  **)**

.. _class_AudioStreamSample_set_loop_mode:

- void  **set_loop_mode**  **(** :ref:`int<class_int>` loop_mode  **)**

.. _class_AudioStreamSample_set_mix_rate:

- void  **set_mix_rate**  **(** :ref:`int<class_int>` mix_rate  **)**

.. _class_AudioStreamSample_set_stereo:

- void  **set_stereo**  **(** :ref:`bool<class_bool>` stereo  **)**