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 Variables
----------------

  .. _class_AudioStreamSample_format:

- :ref:`Format<enum_audiostreamsample_format>` **format** - Audio format. See FORMAT\_\* constants for values.

  .. _class_AudioStreamSample_loop_begin:

- :ref:`int<class_int>` **loop_begin** - Loop start in bytes.

  .. _class_AudioStreamSample_loop_end:

- :ref:`int<class_int>` **loop_end** - Loop end in bytes.

  .. _class_AudioStreamSample_loop_mode:

- :ref:`LoopMode<enum_audiostreamsample_loopmode>` **loop_mode** - Loop mode. See LOOP\_\* constants for values.

  .. _class_AudioStreamSample_mix_rate:

- :ref:`int<class_int>` **mix_rate** - The sample rate for mixing this audio.

  .. _class_AudioStreamSample_stereo:

- :ref:`bool<class_bool>` **stereo** - If ``true``, audio is stereo. Default value: ``false``.


Enums
-----

  .. _enum_AudioStreamSample_LoopMode:

enum **LoopMode**

- **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.

  .. _enum_AudioStreamSample_Format:

enum **Format**

- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit.
- **FORMAT_16_BITS** = **1** --- Audio codec 16 bit.
- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM.


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

Plays audio, can loop.