Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioEffectFilter

Наследует: AudioEffect < Resource < RefCounted < Object

Наследуется от: AudioEffectBandLimitFilter, AudioEffectBandPassFilter, AudioEffectHighPassFilter, AudioEffectHighShelfFilter, AudioEffectLowPassFilter, AudioEffectLowShelfFilter, AudioEffectNotchFilter

Базовый класс для фильтров. Используйте эффекты, наследующие этот класс, вместо прямого использования его.

Описание

Фильтр управляет усилением частот, используя cutoff_hz в качестве порогового значения частоты. Фильтры могут помочь обеспечить пространство для каждого звука и создать интересные эффекты.

Существуют различные типы фильтров, наследующих этот класс:

Полочные фильтры: AudioEffectLowShelfFilter и AudioEffectHighShelfFilter

Полосовые и режекторные фильтры: AudioEffectBandPassFilter, AudioEffectBandLimitFilter и AudioEffectNotchFilter

Фильтры нижних/верхних частот: AudioEffectLowPassFilter и AudioEffectHighPassFilter

Обучающие материалы

Свойства

float

cutoff_hz

2000.0

FilterDB

db

0

float

gain

1.0

float

resonance

0.5

Перечисления

enum FilterDB: 🔗

FilterDB FILTER_6DB = 0

Срез на уровне 6 дБ на октаву. Одна октава — это удвоенная частота выше cutoff_hz или половина частоты ниже cutoff_hz.

FilterDB FILTER_12DB = 1

Срез на уровне 12 дБ на октаву. Одна октава — это удвоенная частота выше cutoff_hz или половина частоты ниже cutoff_hz.

FilterDB FILTER_18DB = 2

Срез на уровне 18 дБ на октаву. Одна октава — это удвоенная частота выше cutoff_hz или половина частоты ниже cutoff_hz.

FilterDB FILTER_24DB = 3

Срез на уровне 24 дБ на октаву. Одна октава — это удвоенная частота выше cutoff_hz или половина частоты ниже cutoff_hz.

Описания свойств

float cutoff_hz = 2000.0 🔗

  • void set_cutoff(value: float)

  • float get_cutoff()

Частотный порог фильтра, в Гц. Значение может варьироваться от 1 до 20500.

FilterDB db = 0 🔗

Крутизна кривой среза в дБ на октаву (удвоенная частота выше cutoff_hz или половина частоты ниже cutoff_hz), также известная как «порядок» фильтра. Более высокие порядки имеют более агрессивный срез.

float gain = 1.0 🔗

Усиление частот, на которые воздействует фильтр. Это свойство доступно только для AudioEffectLowShelfFilter и AudioEffectHighShelfFilter. Значение может варьироваться от 0 до 4.

float resonance = 0.5 🔗

  • void set_resonance(value: float)

  • float get_resonance()

Усиление на частоте, близкой к cutoff_hz, или непосредственно рядом с ней. Значение может варьироваться от 0 до 1.

Точное поведение зависит от выбранного типа фильтра:

  • Для полочных фильтров: усиливает или маскирует порядок, увеличивая частоты непосредственно рядом с частотой cutoff_hz и уменьшая частоты на противоположной стороне.

  • Для полосовых и режекторных фильтров: расширяет или сужает фильтр на частоте, близкой к cutoff_hz.

  • Для фильтров нижних/верхних частот: увеличивает или уменьшает частоты на частоте, близкой к cutoff_hz.