mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
686 lines
39 KiB
ReStructuredText
686 lines
39 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. meta::
|
||
:keywords: sound, sfx
|
||
|
||
.. _class_AudioStreamPlayer3D:
|
||
|
||
AudioStreamPlayer3D
|
||
===================
|
||
|
||
**Успадковує:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
||
Відтворює позиційний звук у тривимірному просторі.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Опис
|
||
--------
|
||
|
||
Відтворює аудіо з позиційними звуковими ефектами на основі відносної позиції аудіослухача. Позиційні ефекти включають ослаблення на відстані, спрямованість і ефект Доплера. Для більшої реалістичності до віддалених звуків застосовано фільтр низьких частот. Це можна вимкнути, встановивши :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` на ``20500``.
|
||
|
||
За замовчуванням звук лунає з камери. Це можна змінити, додавши до сцени вузол :ref:`AudioListener3D<class_AudioListener3D>` і ввімкнувши його, викликавши для нього :ref:`AudioListener3D.make_current()<class_AudioListener3D_method_make_current>`.
|
||
|
||
Перегляньте також :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`, щоб відтворити звук непозиційно.
|
||
|
||
\ **Примітка:** Приховування вузла **AudioStreamPlayer3D** не вимикає його аудіовихід. Щоб тимчасово вимкнути аудіовихід **AudioStreamPlayer3D**, установіть :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` на дуже низьке значення, як-от ``-100`` (яке не чутно для людського слуху).
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Посібники
|
||
------------------
|
||
|
||
- :doc:`Звукові потоки <../tutorials/audio/audio_streams>`
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Властивості
|
||
----------------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer3D_property_area_mask>` | ``1`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` | ``5000.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`attenuation_filter_db<class_AudioStreamPlayer3D_property_attenuation_filter_db>` | ``-24.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` | :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>` | ``0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer3D_property_autoplay>` | ``false`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`StringName<class_StringName>` | :ref:`bus<class_AudioStreamPlayer3D_property_bus>` | ``&"Master"`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` | :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` | ``0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` | ``45.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`bool<class_bool>` | :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` | ``false`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>` | ``-12.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`max_db<class_AudioStreamPlayer3D_property_max_db>` | ``3.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` | ``0.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`int<class_int>` | :ref:`max_polyphony<class_AudioStreamPlayer3D_property_max_polyphony>` | ``1`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`panning_strength<class_AudioStreamPlayer3D_property_panning_strength>` | ``1.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer3D_property_pitch_scale>` | ``1.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`PlaybackType<enum_AudioServer_PlaybackType>` | :ref:`playback_type<class_AudioStreamPlayer3D_property_playback_type>` | ``0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer3D_property_playing>` | ``false`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer3D_property_stream>` | |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` | ``false`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` | ``10.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` | ``0.0`` |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
| :ref:`float<class_float>` | :ref:`volume_linear<class_AudioStreamPlayer3D_property_volume_linear>` | |
|
||
+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Методи
|
||
------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_method_get_playback_position>`\ (\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`get_stream_playback<class_AudioStreamPlayer3D_method_get_stream_playback>`\ (\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_stream_playback<class_AudioStreamPlayer3D_method_has_stream_playback>`\ (\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play<class_AudioStreamPlayer3D_method_play>`\ (\ from_position\: :ref:`float<class_float>` = 0.0\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`seek<class_AudioStreamPlayer3D_method_seek>`\ (\ to_position\: :ref:`float<class_float>`\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`stop<class_AudioStreamPlayer3D_method_stop>`\ (\ ) |
|
||
+-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Сигнали
|
||
--------------
|
||
|
||
.. _class_AudioStreamPlayer3D_signal_finished:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**finished**\ (\ ) :ref:`🔗<class_AudioStreamPlayer3D_signal_finished>`
|
||
|
||
Видається, коли звук припиняється.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Переліки
|
||
----------------
|
||
|
||
.. _enum_AudioStreamPlayer3D_AttenuationModel:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AttenuationModel**: :ref:`🔗<enum_AudioStreamPlayer3D_AttenuationModel>`
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_DISTANCE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **ATTENUATION_INVERSE_DISTANCE** = ``0``
|
||
|
||
Зниження гучності відповідно до лінійної відстані.
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_SQUARE_DISTANCE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **ATTENUATION_INVERSE_SQUARE_DISTANCE** = ``1``
|
||
|
||
Зниження гучності відповідно до квадрата відстані.
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **ATTENUATION_LOGARITHMIC** = ``2``
|
||
|
||
Послаблення гучності відповідно до логарифмічної відстані.
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **ATTENUATION_DISABLED** = ``3``
|
||
|
||
Немає ослаблення гучності відповідно до відстані. На відміну від :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`, звук буде чути позиційно. :ref:`ATTENUATION_DISABLED<class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED>` можна об’єднати зі значенням :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>`, більшим за ``0.0``, щоб досягти лінійного затухання, прикріпленого до сфери певного розміру.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_AudioStreamPlayer3D_DopplerTracking:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **DopplerTracking**: :ref:`🔗<enum_AudioStreamPlayer3D_DopplerTracking>`
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **DOPPLER_TRACKING_DISABLED** = ``0``
|
||
|
||
Вимикає доплерівське відстеження.
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_IDLE_STEP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **DOPPLER_TRACKING_IDLE_STEP** = ``1``
|
||
|
||
Виконує доплерівське відстеження під час кадрів процесу (див. :ref:`Node.NOTIFICATION_INTERNAL_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PROCESS>`).
|
||
|
||
.. _class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_PHYSICS_STEP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **DOPPLER_TRACKING_PHYSICS_STEP** = ``2``
|
||
|
||
Виконує доплерівське відстеження під час кадрів фізики (див. :ref:`Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS>`).
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описи властивостей
|
||
------------------------------------
|
||
|
||
.. _class_AudioStreamPlayer3D_property_area_mask:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **area_mask** = ``1`` :ref:`🔗<class_AudioStreamPlayer3D_property_area_mask>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_area_mask**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_area_mask**\ (\ )
|
||
|
||
Визначає, які шари :ref:`Area3D<class_Area3D>` впливають на звук ефектів реверберації та аудіошини. Області можна використовувати для перенаправлення :ref:`AudioStream<class_AudioStream>`, щоб вони відтворювалися на певній аудіошині. Прикладом того, як це можна використовувати, є створення «водної» області, щоб звуки, що відтворюються у воді, перенаправлялися через аудіошину, щоб вони звучали так, ніби вони відтворюються під водою.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **attenuation_filter_cutoff_hz** = ``5000.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_attenuation_filter_cutoff_hz**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_attenuation_filter_cutoff_hz**\ (\ )
|
||
|
||
Частота зрізу фільтра низьких частот ослаблення, Гц. Звук вище цієї частоти послаблюється більше, ніж звук нижче цієї частоти. Щоб вимкнути цей ефект, встановіть значення ``20500``, оскільки ця частота перевищує межу людського слуху.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_attenuation_filter_db:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **attenuation_filter_db** = ``-24.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_filter_db>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_attenuation_filter_db**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_attenuation_filter_db**\ (\ )
|
||
|
||
Величина впливу фільтра на гучність, у децибелах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_attenuation_model:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **attenuation_model** = ``0`` :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_model>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_attenuation_model**\ (\ value\: :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>`\ )
|
||
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` **get_attenuation_model**\ (\ )
|
||
|
||
Вирішує, чи повинен звук зменшуватися з відстанню лінійно, квадратично, логарифмічно, чи на нього відстань не впливає, фактично вимикаючи затухання.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_autoplay:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **autoplay** = ``false`` :ref:`🔗<class_AudioStreamPlayer3D_property_autoplay>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_autoplay**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_autoplay_enabled**\ (\ )
|
||
|
||
Якщо ``true``, звук відтворюється, коли вузол AudioStreamPlayer3D додається до дерева сцен.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_bus:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`StringName<class_StringName>` **bus** = ``&"Master"`` :ref:`🔗<class_AudioStreamPlayer3D_property_bus>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_bus**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||
- :ref:`StringName<class_StringName>` **get_bus**\ (\ )
|
||
|
||
Автобус, на якому відтворюється цей звук.
|
||
|
||
\ **Примітка:** Встановлюючи цю властивість, майте на увазі, що перевірка не виконується, щоб побачити, чи дане ім’я відповідає існуючій шині. Це пояснюється тим, що макети аудіошини можуть завантажуватися після встановлення цієї властивості. Якщо це задане ім’я не може бути визначено під час виконання, воно повернеться до ``"Master"``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_doppler_tracking:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **doppler_tracking** = ``0`` :ref:`🔗<class_AudioStreamPlayer3D_property_doppler_tracking>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_doppler_tracking**\ (\ value\: :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>`\ )
|
||
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` **get_doppler_tracking**\ (\ )
|
||
|
||
Визначає, на якому кроці слід розраховувати ефект Доплера.
|
||
|
||
\ **Примітка:** Якщо :ref:`doppler_tracking<class_AudioStreamPlayer3D_property_doppler_tracking>` не є :ref:`DOPPLER_TRACKING_DISABLED<class_AudioStreamPlayer3D_constant_DOPPLER_TRACKING_DISABLED>`, але для поточного :ref:`Camera3D<class_Camera3D>`/:ref:`AudioListener3D<class_AudioListener3D>` вимкнено доплерівське відстеження, ефект Доплера буде чути, але рух поточного слухача не враховуватиметься. Якщо потрібен точний ефект Доплера, доплерівське відстеження слід увімкнути як для **AudioStreamPlayer3D**, так і для поточного :ref:`Camera3D<class_Camera3D>`/:ref:`AudioListener3D<class_AudioListener3D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_emission_angle_degrees:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **emission_angle_degrees** = ``45.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_degrees>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_emission_angle**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_emission_angle**\ (\ )
|
||
|
||
Кут, під яким аудіо доходить до слухача без ослаблення.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_emission_angle_enabled:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **emission_angle_enabled** = ``false`` :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_enabled>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_emission_angle_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_emission_angle_enabled**\ (\ )
|
||
|
||
Якщо ``true``, аудіо повинні бути загартовані за напрямком звуку.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **emission_angle_filter_attenuation_db** = ``-12.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_emission_angle_filter_attenuation_db**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_emission_angle_filter_attenuation_db**\ (\ )
|
||
|
||
Коефіцієнт ослаблення, який використовується, якщо слухач знаходиться за межами :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` і встановлено :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>`, у децибелах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_max_db:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **max_db** = ``3.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_max_db>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_max_db**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_max_db**\ (\ )
|
||
|
||
Встановлює абсолютний максимум рівня звуку в децибелах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_max_distance:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **max_distance** = ``0.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_max_distance>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_max_distance**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_max_distance**\ (\ )
|
||
|
||
Відстань, за якою звук більше не чути взагалі. Має ефект, лише якщо встановлено значення більше за ``0.0``. :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` працює в тандемі з :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>`. Однак, на відміну від :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>`, поведінка якого залежить від :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>`, :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` завжди працює лінійно. Це можна використовувати, щоб **AudioStreamPlayer3D** не вимагав мікшування звуку, коли слухач знаходиться далеко, що економить ресурси ЦП.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_max_polyphony:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **max_polyphony** = ``1`` :ref:`🔗<class_AudioStreamPlayer3D_property_max_polyphony>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_max_polyphony**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_max_polyphony**\ (\ )
|
||
|
||
Максимальна кількість звуків, які цей вузол може відтворювати одночасно. Відтворення додаткових звуків після досягнення цього значення призведе до відрізання найстаріших звуків.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_panning_strength:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **panning_strength** = ``1.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_panning_strength>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_panning_strength**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_panning_strength**\ (\ )
|
||
|
||
Масштабує силу панорамування для цього вузла шляхом множення базового значення :ref:`ProjectSettings.audio/general/3d_panning_strength<class_ProjectSettings_property_audio/general/3d_panning_strength>` на цей коефіцієнт. Якщо продукт має значення ``0.0``, то стереопанорамування вимкнено, а гучність однакова для всіх каналів. Якщо продукт має версію ``1.0``, то один із каналів буде вимкнено, коли звук буде розташований точно ліворуч (або праворуч) від слухача.
|
||
|
||
Двоколонна стереосистема реалізує `Стандарт WebAudio для панорамування StereoPannerNode <https://webaudio.github.io/web-audio-api/#stereopanner-algorithm>`__, де гучність дорівнює косинусу половини азимутального кута до вуха.
|
||
|
||
Для інших схем розташування динаміків, таких як 5.1 та 7.1, реалізовано алгоритм SPCAP (Speaker-Placement Correction Amplitude - корекція амплітуди розташування динаміків).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_pitch_scale:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **pitch_scale** = ``1.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_pitch_scale>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_pitch_scale**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_pitch_scale**\ (\ )
|
||
|
||
Висота звуку та темп аудіо як множник частоти дискретизації семплу аудіо.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_playback_type:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` **playback_type** = ``0`` :ref:`🔗<class_AudioStreamPlayer3D_property_playback_type>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_playback_type**\ (\ value\: :ref:`PlaybackType<enum_AudioServer_PlaybackType>`\ )
|
||
- :ref:`PlaybackType<enum_AudioServer_PlaybackType>` **get_playback_type**\ (\ )
|
||
|
||
**Експериментальний:** Ця властивість може бути змінена або усунута у наступних версіях.
|
||
|
||
Тип відтворення потокового програвача. Якщо встановлено інше значення, ніж значення за замовчуванням, цей тип відтворення буде примусово.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_playing:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **playing** = ``false`` :ref:`🔗<class_AudioStreamPlayer3D_property_playing>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_playing**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_playing**\ (\ )
|
||
|
||
Якщо ``true``, аудіо відтворюється або стоїть у черзі для відтворення (див. :ref:`play()<class_AudioStreamPlayer3D_method_play>`).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_stream:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`AudioStream<class_AudioStream>` **stream** :ref:`🔗<class_AudioStreamPlayer3D_property_stream>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_stream**\ (\ value\: :ref:`AudioStream<class_AudioStream>`\ )
|
||
- :ref:`AudioStream<class_AudioStream>` **get_stream**\ (\ )
|
||
|
||
Ресурс :ref:`AudioStream<class_AudioStream>` для відтворення.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_stream_paused:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **stream_paused** = ``false`` :ref:`🔗<class_AudioStreamPlayer3D_property_stream_paused>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_stream_paused**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_stream_paused**\ (\ )
|
||
|
||
Якщо ``true``, відтворення буде призупинено. Ви можете відновити його, встановивши для :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` значення ``false``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_unit_size:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **unit_size** = ``10.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_unit_size>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_unit_size**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_unit_size**\ (\ )
|
||
|
||
Коефіцієнт ефекту ослаблення. Вищі значення роблять звук чутним на більшій відстані.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_volume_db:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **volume_db** = ``0.0`` :ref:`🔗<class_AudioStreamPlayer3D_property_volume_db>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_volume_db**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_volume_db**\ (\ )
|
||
|
||
Базовий рівень звуку до загасання, в децибелах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_property_volume_linear:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **volume_linear** :ref:`🔗<class_AudioStreamPlayer3D_property_volume_linear>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_volume_linear**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_volume_linear**\ (\ )
|
||
|
||
Базовий рівень звуку до загасання, як лінійне значення.
|
||
|
||
\ **Примітка:** цей учасник змінює :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` для зручності. Повернене значення еквівалентно результату :ref:`@GlobalScope.db_to_linear()<class_@GlobalScope_method_db_to_linear>` на :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>`. Налаштування цього члена еквівалентно встановленню :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` для результату :ref:`@GlobalScope.linear_to_db()<class_@GlobalScope_method_linear_to_db>` для значення.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описи методів
|
||
--------------------------
|
||
|
||
.. _class_AudioStreamPlayer3D_method_get_playback_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_playback_position**\ (\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_get_playback_position>`
|
||
|
||
Повертає позицію в :ref:`AudioStream<class_AudioStream>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_method_get_stream_playback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **get_stream_playback**\ (\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_get_stream_playback>`
|
||
|
||
Повертає об’єкт :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, пов’язаний із цим **AudioStreamPlayer3D**.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_method_has_stream_playback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **has_stream_playback**\ (\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_has_stream_playback>`
|
||
|
||
Повертає, чи може :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` повертати об’єкт :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_method_play:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play**\ (\ from_position\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_play>`
|
||
|
||
Ставить аудіо в чергу для відтворення на наступному кадрі фізики, починаючи з заданої позиції ``from_position``, за секунди.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_method_seek:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **seek**\ (\ to_position\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_seek>`
|
||
|
||
Встановлює позицію, з якої буде відтворюватися звук, у секундах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AudioStreamPlayer3D_method_stop:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **stop**\ (\ ) :ref:`🔗<class_AudioStreamPlayer3D_method_stop>`
|
||
|
||
Зупиняє аудіо.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Зазвичай, цей метод перевизначається користувачем, щоб він мав вплив.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Цей метод не має побічних ефектів. Не змінює ніяку змінну екземпляра об'єкта.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Цей метод приймає будь-яке число аргументів після описаних тут.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Цей метод використовується для побудови типів.)`
|
||
.. |static| replace:: :abbr:`static (Цей метод не потребує екземпляра для виклику, його можна викликати безпосередньо за допомогою назви класу.)`
|
||
.. |operator| replace:: :abbr:`operator (Цей метод описує дійсний оператор для взаємодії з цим типом як з лівим операндом.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Це значення є цілим числом, складеним у вигляді бітової маски з наступних прапорів.)`
|
||
.. |void| replace:: :abbr:`void (Значення не повертається.)`
|