AudioEffectCompressor

继承： AudioEffect < Resource < RefCounted < Object

Adds a compressor audio effect to an audio bus.

Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.

描述

Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB).

Compressor has many uses in the mix:

  • In the Master bus to compress the whole output (although an AudioEffectLimiter is probably better).

  • In voice channels to ensure they sound as balanced as possible.

  • Sidechained. This can reduce the sound level sidechained with another audio bus for threshold detection. This technique is common in video game mixing to the level of music and SFX while voices are being heard.

  • Accentuates transients by using a wider attack, making effects sound more punchy.

属性
floatattack_us
floatgain
floatmix
floatratio
floatrelease_ms
StringNamesidechain
floatthreshold

属性说明

float attack_us = 20.0

  • void set_attack_us ( value: float )
  • float get_attack_us ( )

Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.

float gain = 0.0

  • void set_gain ( value: float )
  • float get_gain ( )

Gain applied to the output signal.

float mix = 1.0

Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).

float ratio = 4.0

  • void set_ratio ( value: float )
  • float get_ratio ( )

Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48.

float release_ms = 250.0

  • void set_release_ms ( value: float )
  • float get_release_ms ( )

Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.

StringName sidechain = &""

Reduce the sound level using another audio bus for threshold detection.

float threshold = 0.0

  • void set_threshold ( value: float )
  • float get_threshold ( )

The level above which compression is applied to the audio. Value can range from -60 to 0.

1

本方法通常需要用户覆盖才能生效。

2

本方法无副作用，不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例，可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。