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.

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 🔗

Коэффициент громкости исходного аудио. Значение может варьироваться от 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 🔗

Соотношение громкости всех голосов. Значение может варьироваться от 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) 🔗

Задает глубину низкочастотного осциллятора заданного void_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) 🔗

Задает частоту низкочастотного осциллятора заданного void_idx в Гц. Значение может варьироваться от 0,1 до 20.