godot-docs/classes/class_soundplayer2d.rst

.. 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_SoundPlayer2D:

SoundPlayer2D
=============

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Inherited By:** :ref:`SamplePlayer2D<class_sampleplayer2d>`

**Category:** Core

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

Base class for playing spatial 2D sound.

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

+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_param<class_SoundPlayer2D_get_param>`  **(** :ref:`int<class_int>` param  **)** const                            |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_param<class_SoundPlayer2D_set_param>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+

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

- **PARAM_VOLUME_DB** = **0**
- **PARAM_PITCH_SCALE** = **1**
- **PARAM_ATTENUATION_MIN_DISTANCE** = **2**
- **PARAM_ATTENUATION_MAX_DISTANCE** = **3**
- **PARAM_ATTENUATION_DISTANCE_EXP** = **4**
- **PARAM_MAX** = **5**

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

Base class for playing spatial 2D sound.

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

.. _class_SoundPlayer2D_get_param:

- :ref:`float<class_float>`  **get_param**  **(** :ref:`int<class_int>` param  **)** const

.. _class_SoundPlayer2D_set_param:

- void  **set_param**  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)**