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 🔗

• void set_db(value: FilterDB)

• FilterDB get_db()

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

---

float gain = 1.0 🔗

• void set_gain(value: float)

• float get_gain()

Коефіцієнт підсилення частот, на які впливає фільтр. Ця властивість доступна лише для 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.