mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
205 lines
6.8 KiB
ReStructuredText
205 lines
6.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. 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
|
|
-----------------
|
|
|
|
Stores audio data loaded from ``.wav`` files.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamSample_property_data>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`Format<enum_AudioStreamSample_Format>` | :ref:`format<class_AudioStreamSample_property_format>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`loop_begin<class_AudioStreamSample_property_loop_begin>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`loop_end<class_AudioStreamSample_property_loop_end>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` | :ref:`loop_mode<class_AudioStreamSample_property_loop_mode>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`mix_rate<class_AudioStreamSample_property_mix_rate>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`stereo<class_AudioStreamSample_property_stereo>` |
|
|
+--------------------------------------------------+----------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_to_wav<class_AudioStreamSample_method_save_to_wav>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_AudioStreamSample_Format:
|
|
|
|
.. _class_AudioStreamSample_constant_FORMAT_8_BITS:
|
|
|
|
.. _class_AudioStreamSample_constant_FORMAT_16_BITS:
|
|
|
|
.. _class_AudioStreamSample_constant_FORMAT_IMA_ADPCM:
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _enum_AudioStreamSample_LoopMode:
|
|
|
|
.. _class_AudioStreamSample_constant_LOOP_DISABLED:
|
|
|
|
.. _class_AudioStreamSample_constant_LOOP_FORWARD:
|
|
|
|
.. _class_AudioStreamSample_constant_LOOP_PING_PONG:
|
|
|
|
.. _class_AudioStreamSample_constant_LOOP_BACKWARD:
|
|
|
|
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.
|
|
|
|
- **LOOP_BACKWARD** = **3** --- Audio loops the data between loop_begin and loop_end playing backward only.
|
|
|
|
Description
|
|
-----------
|
|
|
|
AudioStreamSample stores sound samples loaded from ``.wav`` files. To play the stored sound use an :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` (for background music) or :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>`/:ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>` (for positional audio). The sound can be looped.
|
|
|
|
This class can also be used to store dynamically generated PCM audio data.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AudioStreamSample_property_data:
|
|
|
|
- :ref:`PoolByteArray<class_PoolByteArray>` **data**
|
|
|
|
+----------+-----------------+
|
|
| *Setter* | set_data(value) |
|
|
+----------+-----------------+
|
|
| *Getter* | get_data() |
|
|
+----------+-----------------+
|
|
|
|
Contains the audio data in bytes.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_format:
|
|
|
|
- :ref:`Format<enum_AudioStreamSample_Format>` **format**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_format(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_format() |
|
|
+----------+-------------------+
|
|
|
|
Audio format. See FORMAT\_\* constants for values.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_loop_begin:
|
|
|
|
- :ref:`int<class_int>` **loop_begin**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_loop_begin(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_loop_begin() |
|
|
+----------+-----------------------+
|
|
|
|
Loop start in bytes.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_loop_end:
|
|
|
|
- :ref:`int<class_int>` **loop_end**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_loop_end(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_loop_end() |
|
|
+----------+---------------------+
|
|
|
|
Loop end in bytes.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_loop_mode:
|
|
|
|
- :ref:`LoopMode<enum_AudioStreamSample_LoopMode>` **loop_mode**
|
|
|
|
+----------+----------------------+
|
|
| *Setter* | set_loop_mode(value) |
|
|
+----------+----------------------+
|
|
| *Getter* | get_loop_mode() |
|
|
+----------+----------------------+
|
|
|
|
Loop mode. See LOOP\_\* constants for values.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_mix_rate:
|
|
|
|
- :ref:`int<class_int>` **mix_rate**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_mix_rate(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_mix_rate() |
|
|
+----------+---------------------+
|
|
|
|
The sample rate for mixing this audio.
|
|
|
|
----
|
|
|
|
.. _class_AudioStreamSample_property_stereo:
|
|
|
|
- :ref:`bool<class_bool>` **stereo**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_stereo(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | is_stereo() |
|
|
+----------+-------------------+
|
|
|
|
If ``true``, audio is stereo. Default value: ``false``.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_AudioStreamSample_method_save_to_wav:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **save_to_wav** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Saves the AudioStreamSample as a WAV file to ``path``. Samples with IMA ADPCM format can't be saved.
|
|
|
|
Note that a ``.wav`` extension is automatically appended to ``path`` if it is missing.
|
|
|