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

AudioStreamPlayer3D
===================

**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

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



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

+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_area_mask<class_AudioStreamPlayer3D_get_area_mask>`  **(** **)** const                                                                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz>`  **(** **)** const                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_attenuation_filter_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>`  **(** **)** const                                                       |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_attenuation_model<class_AudioStreamPlayer3D_get_attenuation_model>`  **(** **)** const                                                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`            | :ref:`get_bus<class_AudioStreamPlayer3D_get_bus>`  **(** **)** const                                                                                           |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_doppler_tracking<class_AudioStreamPlayer3D_get_doppler_tracking>`  **(** **)** const                                                                 |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_emission_angle<class_AudioStreamPlayer3D_get_emission_angle>`  **(** **)** const                                                                     |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db>`  **(** **)** const                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_max_db<class_AudioStreamPlayer3D_get_max_db>`  **(** **)** const                                                                                     |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_max_distance<class_AudioStreamPlayer3D_get_max_distance>`  **(** **)** const                                                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_out_of_range_mode<class_AudioStreamPlayer3D_get_out_of_range_mode>`  **(** **)** const                                                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_pos<class_AudioStreamPlayer3D_get_pos>`  **(** **)**                                                                                                 |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStream<class_audiostream>`  | :ref:`get_stream<class_AudioStreamPlayer3D_get_stream>`  **(** **)** const                                                                                     |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_unit_db<class_AudioStreamPlayer3D_get_unit_db>`  **(** **)** const                                                                                   |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_unit_size<class_AudioStreamPlayer3D_get_unit_size>`  **(** **)** const                                                                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`is_autoplay_enabled<class_AudioStreamPlayer3D_is_autoplay_enabled>`  **(** **)**                                                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`is_emission_angle_enabled<class_AudioStreamPlayer3D_is_emission_angle_enabled>`  **(** **)** const                                                       |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`is_playing<class_AudioStreamPlayer3D_is_playing>`  **(** **)** const                                                                                     |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`play<class_AudioStreamPlayer3D_play>`  **(** :ref:`float<class_float>` from_pos=0.0  **)**                                                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`seek<class_AudioStreamPlayer3D_seek>`  **(** :ref:`float<class_float>` to_pos  **)**                                                                     |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_area_mask<class_AudioStreamPlayer3D_set_area_mask>`  **(** :ref:`int<class_int>` mask  **)**                                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz>`  **(** :ref:`float<class_float>` degrees  **)**            |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_attenuation_filter_db<class_AudioStreamPlayer3D_set_attenuation_filter_db>`  **(** :ref:`float<class_float>` db  **)**                               |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_attenuation_model<class_AudioStreamPlayer3D_set_attenuation_model>`  **(** :ref:`int<class_int>` model  **)**                                        |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_autoplay<class_AudioStreamPlayer3D_set_autoplay>`  **(** :ref:`bool<class_bool>` enable  **)**                                                       |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_bus<class_AudioStreamPlayer3D_set_bus>`  **(** :ref:`String<class_string>` bus  **)**                                                                |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_doppler_tracking<class_AudioStreamPlayer3D_set_doppler_tracking>`  **(** :ref:`int<class_int>` mode  **)**                                           |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_emission_angle<class_AudioStreamPlayer3D_set_emission_angle>`  **(** :ref:`float<class_float>` degrees  **)**                                        |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_emission_angle_enabled<class_AudioStreamPlayer3D_set_emission_angle_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                          |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db>`  **(** :ref:`float<class_float>` db  **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_max_db<class_AudioStreamPlayer3D_set_max_db>`  **(** :ref:`float<class_float>` max_db  **)**                                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_max_distance<class_AudioStreamPlayer3D_set_max_distance>`  **(** :ref:`float<class_float>` metres  **)**                                             |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_out_of_range_mode<class_AudioStreamPlayer3D_set_out_of_range_mode>`  **(** :ref:`int<class_int>` mode  **)**                                         |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_stream<class_AudioStreamPlayer3D_set_stream>`  **(** :ref:`AudioStream<class_audiostream>` stream  **)**                                             |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_unit_db<class_AudioStreamPlayer3D_set_unit_db>`  **(** :ref:`float<class_float>` unit_db  **)**                                                      |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_unit_size<class_AudioStreamPlayer3D_set_unit_size>`  **(** :ref:`float<class_float>` unit_size  **)**                                                |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`stop<class_AudioStreamPlayer3D_stop>`  **(** **)**                                                                                                       |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **finished**  **(** **)**

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

- :ref:`int<class_int>` **area_mask**
- :ref:`float<class_float>` **attenuation_filter_cutoff_hz**
- :ref:`float<class_float>` **attenuation_filter_db**
- :ref:`int<class_int>` **attenuation_model**
- :ref:`bool<class_bool>` **autoplay**
- :ref:`String<class_string>` **bus**
- :ref:`int<class_int>` **doppler_tracking**
- :ref:`float<class_float>` **emission_angle_degrees**
- :ref:`bool<class_bool>` **emission_angle_enabled**
- :ref:`float<class_float>` **emission_angle_filter_attenuation_db**
- :ref:`float<class_float>` **max_db**
- :ref:`float<class_float>` **max_distance**
- :ref:`int<class_int>` **out_of_range_mode**
- :ref:`bool<class_bool>` **playing**
- :ref:`AudioStream<class_audiostream>` **stream**
- :ref:`float<class_float>` **unit_db**
- :ref:`float<class_float>` **unit_size**

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

- **ATTENUATION_INVERSE_DISTANCE** = **0**
- **ATTENUATION_INVERSE_SQUARE_DISTANCE** = **1**
- **ATTENUATION_LOGARITHMIC** = **2**
- **OUT_OF_RANGE_MIX** = **0**
- **OUT_OF_RANGE_PAUSE** = **1**
- **DOPPLER_TRACKING_DISABLED** = **0**
- **DOPPLER_TRACKING_IDLE_STEP** = **1**
- **DOPPLER_TRACKING_FIXED_STEP** = **2**

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

.. _class_AudioStreamPlayer3D_get_area_mask:

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

.. _class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz:

- :ref:`float<class_float>`  **get_attenuation_filter_cutoff_hz**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_attenuation_filter_db:

- :ref:`float<class_float>`  **get_attenuation_filter_db**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_attenuation_model:

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

.. _class_AudioStreamPlayer3D_get_bus:

- :ref:`String<class_string>`  **get_bus**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_doppler_tracking:

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

.. _class_AudioStreamPlayer3D_get_emission_angle:

- :ref:`float<class_float>`  **get_emission_angle**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db:

- :ref:`float<class_float>`  **get_emission_angle_filter_attenuation_db**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_max_db:

- :ref:`float<class_float>`  **get_max_db**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_max_distance:

- :ref:`float<class_float>`  **get_max_distance**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_out_of_range_mode:

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

.. _class_AudioStreamPlayer3D_get_pos:

- :ref:`float<class_float>`  **get_pos**  **(** **)**

.. _class_AudioStreamPlayer3D_get_stream:

- :ref:`AudioStream<class_audiostream>`  **get_stream**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_unit_db:

- :ref:`float<class_float>`  **get_unit_db**  **(** **)** const

.. _class_AudioStreamPlayer3D_get_unit_size:

- :ref:`float<class_float>`  **get_unit_size**  **(** **)** const

.. _class_AudioStreamPlayer3D_is_autoplay_enabled:

- :ref:`bool<class_bool>`  **is_autoplay_enabled**  **(** **)**

.. _class_AudioStreamPlayer3D_is_emission_angle_enabled:

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

.. _class_AudioStreamPlayer3D_is_playing:

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

.. _class_AudioStreamPlayer3D_play:

- void  **play**  **(** :ref:`float<class_float>` from_pos=0.0  **)**

.. _class_AudioStreamPlayer3D_seek:

- void  **seek**  **(** :ref:`float<class_float>` to_pos  **)**

.. _class_AudioStreamPlayer3D_set_area_mask:

- void  **set_area_mask**  **(** :ref:`int<class_int>` mask  **)**

.. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz:

- void  **set_attenuation_filter_cutoff_hz**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_AudioStreamPlayer3D_set_attenuation_filter_db:

- void  **set_attenuation_filter_db**  **(** :ref:`float<class_float>` db  **)**

.. _class_AudioStreamPlayer3D_set_attenuation_model:

- void  **set_attenuation_model**  **(** :ref:`int<class_int>` model  **)**

.. _class_AudioStreamPlayer3D_set_autoplay:

- void  **set_autoplay**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_AudioStreamPlayer3D_set_bus:

- void  **set_bus**  **(** :ref:`String<class_string>` bus  **)**

.. _class_AudioStreamPlayer3D_set_doppler_tracking:

- void  **set_doppler_tracking**  **(** :ref:`int<class_int>` mode  **)**

.. _class_AudioStreamPlayer3D_set_emission_angle:

- void  **set_emission_angle**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_AudioStreamPlayer3D_set_emission_angle_enabled:

- void  **set_emission_angle_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db:

- void  **set_emission_angle_filter_attenuation_db**  **(** :ref:`float<class_float>` db  **)**

.. _class_AudioStreamPlayer3D_set_max_db:

- void  **set_max_db**  **(** :ref:`float<class_float>` max_db  **)**

.. _class_AudioStreamPlayer3D_set_max_distance:

- void  **set_max_distance**  **(** :ref:`float<class_float>` metres  **)**

.. _class_AudioStreamPlayer3D_set_out_of_range_mode:

- void  **set_out_of_range_mode**  **(** :ref:`int<class_int>` mode  **)**

.. _class_AudioStreamPlayer3D_set_stream:

- void  **set_stream**  **(** :ref:`AudioStream<class_audiostream>` stream  **)**

.. _class_AudioStreamPlayer3D_set_unit_db:

- void  **set_unit_db**  **(** :ref:`float<class_float>` unit_db  **)**

.. _class_AudioStreamPlayer3D_set_unit_size:

- void  **set_unit_size**  **(** :ref:`float<class_float>` unit_size  **)**

.. _class_AudioStreamPlayer3D_stop:

- void  **stop**  **(** **)**