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...

AudioEffectChorus

Успадковує: AudioEffect < Resource < RefCounted < Object

Додає аудіоефект «хорус» до аудіошини.

Створює враження наявності декількох джерел звуку.

Опис

Ефект «хорус» створює кілька копій вихідного аудіосигналу (так званих «голосів») із варіаціями висоти тону та накладає їх на оригінальний сигнал, створюючи враження, ніби звук лунає з кількох джерел. Це забезпечує спектральний та просторовий рух.

Кожен голос відтворюється з невеликою затримкою після вихідного аудіосигналу, що регулюється параметром delay. Внутрішній низькочастотний генератор (LFO) контролює їх висоту, а depth контролює максимальне значення LFO.

У реальному світі такий ефект зустрічається у фортепіано, хорах та інструментальних ансамблях.

Цей ефект також можна використовувати для розширення монофонічного аудіо та надання цифровим звукам більш природної або аналогової якості.

Посібники

Властивості

float	dry	`1.0`
float	voice/1/cutoff_hz	`8000.0`
float	voice/1/delay_ms	`15.0`
float	voice/1/depth_ms	`2.0`
float	voice/1/level_db	`0.0`
float	voice/1/pan	`-0.5`
float	voice/1/rate_hz	`0.8`
float	voice/2/cutoff_hz	`8000.0`
float	voice/2/delay_ms	`20.0`
float	voice/2/depth_ms	`3.0`
float	voice/2/level_db	`0.0`
float	voice/2/pan	`0.5`
float	voice/2/rate_hz	`1.2`
float	voice/3/cutoff_hz
float	voice/3/delay_ms
float	voice/3/depth_ms
float	voice/3/level_db
float	voice/3/pan
float	voice/3/rate_hz
float	voice/4/cutoff_hz
float	voice/4/delay_ms
float	voice/4/depth_ms
float	voice/4/level_db
float	voice/4/pan
float	voice/4/rate_hz
int	voice_count	`2`
float	wet	`0.5`

Методи

float	get_voice_cutoff_hz(voice_idx: int) const
float	get_voice_delay_ms(voice_idx: int) const
float	get_voice_depth_ms(voice_idx: int) const
float	get_voice_level_db(voice_idx: int) const
float	get_voice_pan(voice_idx: int) const
float	get_voice_rate_hz(voice_idx: int) const
void	set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float)
void	set_voice_delay_ms(voice_idx: int, delay_ms: float)
void	set_voice_depth_ms(voice_idx: int, depth_ms: float)
void	set_voice_level_db(voice_idx: int, level_db: float)
void	set_voice_pan(voice_idx: int, pan: float)
void	set_voice_rate_hz(voice_idx: int, rate_hz: float)

Описи властивостей

float dry = 1.0 🔗

void set_dry(value: float)
float get_dry()

Коефіцієнт гучності вихідного аудіо. Значення може коливатися в діапазоні від 0 до 1.

float voice/1/cutoff_hz = 8000.0 🔗

void set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float)
float get_voice_cutoff_hz(voice_idx: int) const

Частотний поріг фільтра нижніх частот голосу в Гц.

float voice/1/delay_ms = 15.0 🔗

void set_voice_delay_ms(voice_idx: int, delay_ms: float)
float get_voice_delay_ms(voice_idx: int) const

Затримка звуку в мілісекундах порівняно з оригінальним аудіо.

float voice/1/depth_ms = 2.0 🔗

void set_voice_depth_ms(voice_idx: int, depth_ms: float)
float get_voice_depth_ms(voice_idx: int) const

Глибина низькочастотного генератора голосу в мілісекундах.

float voice/1/level_db = 0.0 🔗

void set_voice_level_db(voice_idx: int, level_db: float)
float get_voice_level_db(voice_idx: int) const

Коефіцієнт підсилення голосу в дБ.

float voice/1/pan = -0.5 🔗

void set_voice_pan(voice_idx: int, pan: float)
float get_voice_pan(voice_idx: int) const

Розташування голосу в просторі.

float voice/1/rate_hz = 0.8 🔗

void set_voice_rate_hz(voice_idx: int, rate_hz: float)
float get_voice_rate_hz(voice_idx: int) const

Частота низькочастотного генератора голосу в Гц.

float voice/2/cutoff_hz = 8000.0 🔗

void set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float)
float get_voice_cutoff_hz(voice_idx: int) const

Частотний поріг фільтра нижніх частот голосу в Гц.

float voice/2/delay_ms = 20.0 🔗

void set_voice_delay_ms(voice_idx: int, delay_ms: float)
float get_voice_delay_ms(voice_idx: int) const

Затримка звуку в мілісекундах порівняно з оригінальним аудіо.

float voice/2/depth_ms = 3.0 🔗

void set_voice_depth_ms(voice_idx: int, depth_ms: float)
float get_voice_depth_ms(voice_idx: int) const

Глибина низькочастотного генератора голосу в мілісекундах.

float voice/2/level_db = 0.0 🔗

void set_voice_level_db(voice_idx: int, level_db: float)
float get_voice_level_db(voice_idx: int) const

Коефіцієнт підсилення голосу в дБ.

float voice/2/pan = 0.5 🔗

void set_voice_pan(voice_idx: int, pan: float)
float get_voice_pan(voice_idx: int) const

Розташування голосу в просторі.

float voice/2/rate_hz = 1.2 🔗

void set_voice_rate_hz(voice_idx: int, rate_hz: float)
float get_voice_rate_hz(voice_idx: int) const

Частота низькочастотного генератора голосу в Гц.

float voice/3/cutoff_hz 🔗

void set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float)
float get_voice_cutoff_hz(voice_idx: int) const

Частотний поріг фільтра нижніх частот голосу в Гц.

float voice/3/delay_ms 🔗

void set_voice_delay_ms(voice_idx: int, delay_ms: float)
float get_voice_delay_ms(voice_idx: int) const

Затримка звуку в мілісекундах порівняно з оригінальним аудіо.

float voice/3/depth_ms 🔗

void set_voice_depth_ms(voice_idx: int, depth_ms: float)
float get_voice_depth_ms(voice_idx: int) const

Глибина низькочастотного генератора голосу в мілісекундах.

float voice/3/level_db 🔗

void set_voice_level_db(voice_idx: int, level_db: float)
float get_voice_level_db(voice_idx: int) const

Коефіцієнт підсилення голосу в дБ.

float voice/3/pan 🔗

void set_voice_pan(voice_idx: int, pan: float)
float get_voice_pan(voice_idx: int) const

Розташування голосу в просторі.

float voice/3/rate_hz 🔗

void set_voice_rate_hz(voice_idx: int, rate_hz: float)
float get_voice_rate_hz(voice_idx: int) const

Частота низькочастотного генератора голосу в Гц.

float voice/4/cutoff_hz 🔗

void set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float)
float get_voice_cutoff_hz(voice_idx: int) const

Частотний поріг фільтра нижніх частот голосу в Гц.

float voice/4/delay_ms 🔗

void set_voice_delay_ms(voice_idx: int, delay_ms: float)
float get_voice_delay_ms(voice_idx: int) const

Затримка звуку в мілісекундах порівняно з оригінальним аудіо.

float voice/4/depth_ms 🔗

void set_voice_depth_ms(voice_idx: int, depth_ms: float)
float get_voice_depth_ms(voice_idx: int) const

Глибина низькочастотного генератора голосу в мілісекундах.

float voice/4/level_db 🔗

void set_voice_level_db(voice_idx: int, level_db: float)
float get_voice_level_db(voice_idx: int) const

Коефіцієнт підсилення голосу в дБ.

float voice/4/pan 🔗

void set_voice_pan(voice_idx: int, pan: float)
float get_voice_pan(voice_idx: int) const

Розташування голосу в просторі.

float voice/4/rate_hz 🔗

void set_voice_rate_hz(voice_idx: int, rate_hz: float)
float get_voice_rate_hz(voice_idx: int) const

Частота низькочастотного генератора голосу в Гц.

int voice_count = 2 🔗

void set_voice_count(value: int)
int get_voice_count()

Кількість голосів в ефекті. Значення може становити від 1 до 4.

float wet = 0.5 🔗

void set_wet(value: float)
float get_wet()

Відношення гучності всіх голосів. Значення може коливатися в діапазоні від 0 до 1.

Описи методів

float get_voice_cutoff_hz(voice_idx: int) const 🔗

Повертає частотний поріг фільтра нижніх частот для заданого voice_idx у Гц. Частоти, що перевищують це значення, видаляються з голосу.

float get_voice_delay_ms(voice_idx: int) const 🔗

Повертає затримку заданого voice_idx у мілісекундах порівняно з оригінальним аудіо.

float get_voice_depth_ms(voice_idx: int) const 🔗

Повертає глибину низькочастотного генератора заданого voice_idx у мілісекундах.

float get_voice_level_db(voice_idx: int) const 🔗

Повертає коефіцієнт підсилення заданого voice_idx у дБ.

float get_voice_pan(voice_idx: int) const 🔗

Повертає положення камери для заданого voice_idx. Від’ємні значення відповідають лівому каналу, а додатні — правому.

float get_voice_rate_hz(voice_idx: int) const 🔗

Повертає частоту низькочастотного генератора заданого voice_idx у Гц.

void set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float) 🔗

Встановлює частотний поріг фільтра нижніх частот для заданого voice_idx у Гц. Частоти, що перевищують cutoff_hz, видаляються з voice_idx. Значення може бути в діапазоні від 1 до 20500.

void set_voice_delay_ms(voice_idx: int, delay_ms: float) 🔗

Встановлює затримку для заданого voice_idx у мілісекундах відносно вихідного аудіо. Значення може бути в діапазоні від 0 до 50.

void set_voice_depth_ms(voice_idx: int, depth_ms: float) 🔗

Встановлює глибину низькочастотного генератора для заданого voice_idx у мілісекундах. Значення може бути в діапазоні від 0 до 20.

void set_voice_level_db(voice_idx: int, level_db: float) 🔗

Встановлює коефіцієнт підсилення для заданого voice_idx у дБ. Значення може бути в діапазоні від -60 до 24.

void set_voice_pan(voice_idx: int, pan: float) 🔗

Встановлює положення звуку по осі панорамування для заданого voice_idx. Негативні значення зміщують звук вліво, позитивні — вправо. Значення може бути в діапазоні від -1 до 1.

void set_voice_rate_hz(voice_idx: int, rate_hz: float) 🔗

Встановлює частоту низькочастотного генератора для заданого voice_idx у Гц. Значення може бути в діапазоні від 0,1 до 20.