Files
godot-docs-l10n/classes/ru/class_audioeffectinstance.rst

84 lines
5.8 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_AudioEffectInstance:
AudioEffectInstance
===================
**Наследует:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Наследуется от:** :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`
Манипулирует получаемым звуком для достижения заданного эффекта.
.. rst-class:: classref-introduction-group
Описание
----------------
Экземпляр аудиоэффекта управляет аудио, которое он получает для данного эффекта. Этот экземпляр автоматически создается :ref:`AudioEffect<class_AudioEffect>` при добавлении его в шину и обычно не должен создаваться напрямую. При необходимости его можно получить во время выполнения с помощью :ref:`AudioServer.get_bus_effect_instance()<class_AudioServer_method_get_bus_effect_instance>`.
.. rst-class:: classref-introduction-group
Обучающие материалы
--------------------------------------
- :doc:`Аудиошины <../tutorials/audio/audio_buses>`
.. rst-class:: classref-reftable-group
Методы
------------
.. table::
:widths: auto
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_process<class_AudioEffectInstance_private_method__process>`\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int<class_int>`\ ) |virtual| |required| |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_process_silence<class_AudioEffectInstance_private_method__process_silence>`\ (\ ) |virtual| |const| |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания метода
------------------------------
.. _class_AudioEffectInstance_private_method__process:
.. rst-class:: classref-method
|void| **_process**\ (\ src_buffer\: ``const void*``, dst_buffer\: ``AudioFrame*``, frame_count\: :ref:`int<class_int>`\ ) |virtual| |required| :ref:`🔗<class_AudioEffectInstance_private_method__process>`
Вызывается :ref:`AudioServer<class_AudioServer>` для обработки этого эффекта. Когда :ref:`_process_silence()<class_AudioEffectInstance_private_method__process_silence>` не переопределен или возвращает ``false``, этот метод вызывается только тогда, когда шина активна.
\ **Примечание:** Не имеет смысла переопределять этот метод в GDScript или C#. Только GDExtension может воспользоваться им.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectInstance_private_method__process_silence:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **_process_silence**\ (\ ) |virtual| |const| :ref:`🔗<class_AudioEffectInstance_private_method__process_silence>`
Переопределить этот метод, чтобы настроить поведение обработки этого экземпляра эффекта.
Следует вернуть ``true``, чтобы заставить :ref:`AudioServer<class_AudioServer>` всегда вызывать :ref:`_process()<class_AudioEffectInstance_private_method__process>`, даже если шина была отключена или не может быть услышана иным образом.
.. |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 (Нет возвращаемого значения.)`