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。