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

AudioEffectCompressor

继承： AudioEffect < Resource < RefCounted < Object

为音频总线（audio bus）添加一个向下压缩器（downward compressor）音频效果。

允许通过音量阈值和时间控制参数来调节动态范围。

描述

“压缩器”会在声音超过一定音量阈值时降低声音的音量。

压缩器在混音中可以有多种用途：

• 压缩主总线上的整体音量（虽然 AudioEffectHardLimiter 可能更好些）。

• 确保语音音频片段的平衡。

• 利用另一条总线作为触发源进行侧链处理。该操作通过借用另一条音频总线的音量数据来进行阈值检测，从而降低其所附加总线的音量。这种技术在电子游戏混音中十分常见，常用于在语音出现时自动降低背景音乐和音效的音量。这种效果也被称为“闪避”。

• 通过设置较长的起音时间，从而突显瞬态信号；即允许声音在被压缩之前，短暂地超过音量阈值。这一技巧可用于增强音效的冲击力。

教程

• 音频总线

• 音效

属性

float	attack_us	20.0
float	gain	0.0
float	mix	1.0
float	ratio	4.0
float	release_ms	250.0
StringName	sidechain	&""
float	threshold	0.0

---

属性说明

float attack_us = 20.0 🔗

• void set_attack_us(value: float)

• float get_attack_us()

当音频音量超过阈值电平时，压缩器的响应时间，单位为微秒。取值范围为 20 至 2000。

---

float gain = 0.0 🔗

• void set_gain(value: float)

• float get_gain()

音频信号的增益，单位为分贝。取值范围为 -20 至 20。

---

float mix = 1.0 🔗

• void set_mix(value: float)

• float get_mix()

原始音频与压缩音频之间的平衡。取值范围为 0（完全干声）至 1（完全湿声）。

---

float ratio = 4.0 🔗

• void set_ratio(value: float)

• float get_ratio()

当音频超过音量阈值电平时，所应用的压缩量。该比率越高，对超过音量阈值电平的音频信号所应用的压缩强度就越大。取值范围为 1 到 48。

---

float release_ms = 250.0 🔗

• void set_release_ms(value: float)

• float get_release_ms()

压缩器在音量降至音量阈值电平以下后，停止降低音量的延迟时间，单位为毫秒。取值范围为 20 到 2000。

---

StringName sidechain = &"" 🔗

• void set_sidechain(value: StringName)

• StringName get_sidechain()

用于音量阈值检测的音频总线。

---

float threshold = 0.0 🔗

• void set_threshold(value: float)

• float get_threshold()

超过该音量电平，压缩将应用于音频，单位为分贝。取值范围为 -60 至 0。