.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/AudioStreamPlayer3D.xml. .. _class_AudioStreamPlayer3D: AudioStreamPlayer3D =================== **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`int` | :ref:`area_mask` | ``1`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | ``5000.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`attenuation_filter_db` | ``-24.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`AttenuationModel` | :ref:`attenuation_model` | ``0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`autoplay` | ``false`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`StringName` | :ref:`bus` | ``&"Master"`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`emission_angle_degrees` | ``45.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`emission_angle_enabled` | ``false`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | ``-12.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`max_db` | ``3.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`max_distance` | ``0.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`int` | :ref:`max_polyphony` | ``1`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`panning_strength` | ``1.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`pitch_scale` | ``1.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`PlaybackType` | :ref:`playback_type` | ``0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`playing` | ``false`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`AudioStream` | :ref:`stream` | | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`bool` | :ref:`stream_paused` | ``false`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`unit_size` | ``10.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ | :ref:`float` | :ref:`volume_db` | ``0.0`` | +--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_position` **(** **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_stream_playback` **(** **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`seek` **(** :ref:`float` to_position **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_AudioStreamPlayer3D_signal_finished: .. rst-class:: classref-signal **finished** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioStreamPlayer3D_AttenuationModel: .. rst-class:: classref-enumeration enum **AttenuationModel**: .. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`AttenuationModel` **ATTENUATION_INVERSE_DISTANCE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_SQUARE_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`AttenuationModel` **ATTENUATION_INVERSE_SQUARE_DISTANCE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC: .. rst-class:: classref-enumeration-constant :ref:`AttenuationModel` **ATTENUATION_LOGARITHMIC** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`AttenuationModel` **ATTENUATION_DISABLED** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AudioStreamPlayer3D_DopplerTracking: .. rst-class:: classref-enumeration enum **DopplerTracking**: .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_IDLE_STEP: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_IDLE_STEP** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_PHYSICS_STEP: .. rst-class:: classref-enumeration-constant :ref:`DopplerTracking` **DOPPLER_TRACKING_PHYSICS_STEP** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioStreamPlayer3D_property_area_mask: .. rst-class:: classref-property :ref:`int` **area_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_area_mask** **(** :ref:`int` value **)** - :ref:`int` **get_area_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz: .. rst-class:: classref-property :ref:`float` **attenuation_filter_cutoff_hz** = ``5000.0`` .. rst-class:: classref-property-setget - void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` value **)** - :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_attenuation_filter_db: .. rst-class:: classref-property :ref:`float` **attenuation_filter_db** = ``-24.0`` .. rst-class:: classref-property-setget - void **set_attenuation_filter_db** **(** :ref:`float` value **)** - :ref:`float` **get_attenuation_filter_db** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_attenuation_model: .. rst-class:: classref-property :ref:`AttenuationModel` **attenuation_model** = ``0`` .. rst-class:: classref-property-setget - void **set_attenuation_model** **(** :ref:`AttenuationModel` value **)** - :ref:`AttenuationModel` **get_attenuation_model** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_autoplay: .. rst-class:: classref-property :ref:`bool` **autoplay** = ``false`` .. rst-class:: classref-property-setget - void **set_autoplay** **(** :ref:`bool` value **)** - :ref:`bool` **is_autoplay_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_bus: .. rst-class:: classref-property :ref:`StringName` **bus** = ``&"Master"`` .. rst-class:: classref-property-setget - void **set_bus** **(** :ref:`StringName` value **)** - :ref:`StringName` **get_bus** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_doppler_tracking: .. rst-class:: classref-property :ref:`DopplerTracking` **doppler_tracking** = ``0`` .. rst-class:: classref-property-setget - void **set_doppler_tracking** **(** :ref:`DopplerTracking` value **)** - :ref:`DopplerTracking` **get_doppler_tracking** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_emission_angle_degrees: .. rst-class:: classref-property :ref:`float` **emission_angle_degrees** = ``45.0`` .. rst-class:: classref-property-setget - void **set_emission_angle** **(** :ref:`float` value **)** - :ref:`float` **get_emission_angle** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_emission_angle_enabled: .. rst-class:: classref-property :ref:`bool` **emission_angle_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_emission_angle_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_emission_angle_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db: .. rst-class:: classref-property :ref:`float` **emission_angle_filter_attenuation_db** = ``-12.0`` .. rst-class:: classref-property-setget - void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` value **)** - :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_max_db: .. rst-class:: classref-property :ref:`float` **max_db** = ``3.0`` .. rst-class:: classref-property-setget - void **set_max_db** **(** :ref:`float` value **)** - :ref:`float` **get_max_db** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_max_distance: .. rst-class:: classref-property :ref:`float` **max_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_max_distance** **(** :ref:`float` value **)** - :ref:`float` **get_max_distance** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_max_polyphony: .. rst-class:: classref-property :ref:`int` **max_polyphony** = ``1`` .. rst-class:: classref-property-setget - void **set_max_polyphony** **(** :ref:`int` value **)** - :ref:`int` **get_max_polyphony** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_panning_strength: .. rst-class:: classref-property :ref:`float` **panning_strength** = ``1.0`` .. rst-class:: classref-property-setget - void **set_panning_strength** **(** :ref:`float` value **)** - :ref:`float` **get_panning_strength** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_pitch_scale: .. rst-class:: classref-property :ref:`float` **pitch_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_pitch_scale** **(** :ref:`float` value **)** - :ref:`float` **get_pitch_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_playback_type: .. rst-class:: classref-property :ref:`PlaybackType` **playback_type** = ``0`` .. rst-class:: classref-property-setget - void **set_playback_type** **(** :ref:`PlaybackType` value **)** - :ref:`PlaybackType` **get_playback_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_playing: .. rst-class:: classref-property :ref:`bool` **playing** = ``false`` .. rst-class:: classref-property-setget - :ref:`bool` **is_playing** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_stream: .. rst-class:: classref-property :ref:`AudioStream` **stream** .. rst-class:: classref-property-setget - void **set_stream** **(** :ref:`AudioStream` value **)** - :ref:`AudioStream` **get_stream** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_stream_paused: .. rst-class:: classref-property :ref:`bool` **stream_paused** = ``false`` .. rst-class:: classref-property-setget - void **set_stream_paused** **(** :ref:`bool` value **)** - :ref:`bool` **get_stream_paused** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_unit_size: .. rst-class:: classref-property :ref:`float` **unit_size** = ``10.0`` .. rst-class:: classref-property-setget - void **set_unit_size** **(** :ref:`float` value **)** - :ref:`float` **get_unit_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_property_volume_db: .. rst-class:: classref-property :ref:`float` **volume_db** = ``0.0`` .. rst-class:: classref-property-setget - void **set_volume_db** **(** :ref:`float` value **)** - :ref:`float` **get_volume_db** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamPlayer3D_method_get_playback_position: .. rst-class:: classref-method :ref:`float` **get_playback_position** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_method_get_stream_playback: .. rst-class:: classref-method :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_method_has_stream_playback: .. rst-class:: classref-method :ref:`bool` **has_stream_playback** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_method_play: .. rst-class:: classref-method void **play** **(** :ref:`float` from_position=0.0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_method_seek: .. rst-class:: classref-method void **seek** **(** :ref:`float` to_position **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayer3D_method_stop: .. rst-class:: classref-method void **stop** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`