.. 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//doc_classes. .. _class_AudioStreamSample: AudioStreamSample ================= **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Plays audio. Member Variables ---------------- .. _class_AudioStreamSample_format: - :ref:`Format` **format** - Audio format. See FORMAT\_\* constants for values. .. _class_AudioStreamSample_loop_begin: - :ref:`int` **loop_begin** - Loop start in bytes. .. _class_AudioStreamSample_loop_end: - :ref:`int` **loop_end** - Loop end in bytes. .. _class_AudioStreamSample_loop_mode: - :ref:`LoopMode` **loop_mode** - Loop mode. See LOOP\_\* constants for values. .. _class_AudioStreamSample_mix_rate: - :ref:`int` **mix_rate** - The sample rate for mixing this audio. .. _class_AudioStreamSample_stereo: - :ref:`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.