The aim of Ducker is to attenuate the level of one audio signal in the presence of another signal. The ducker algorithm is primarily used for reducing the level of the background music track during announcement. This audio object works in tandem with a level detector block or a different control input. A very simple reference implementation of a peak level detector is included EconomyLevel.
Ducker Properties
Below table describes about the Ducker audio object properties and functionality.
| Properties | Descriptions |
| # of channels | The number of input channels are configurable.
The number of output channels are equal to the number of input channels. |
| Display Name | Display name of the Ducker audio object in signal flow design. It can be changed based on the intended usage of the object. |
Mode
There are no mode available for Ducker audio object.
Additional Parameters
| Parameter | Descriptions | |
| Side Chain Level Scale |
Side Chain Level Scale is in linear or dB scale, which can be selected during design time. 0 – Linear scale 1 – dB scale |
 |
| Ducker Operation Mode |
The Ducker audio object operates in two modes and the mode can be selected using an additional configuration “Ducker Operation Mode”. Ducker AO operation mode
Standard mode is the default.
|
 |
Tuning Parameters
| Parameter | Data Type | Unit | Default Value | Range | Description |
| Threshold | Float | dB | -30 dB | -128 to 0 | minimal value of the incoming level parameter to trigger ducking |
| Attenuation | Float | dB | 20 dB | 0 to 128 | How much the signal will be attenuated when ducking is active |
| Attack time | Float | s | 1 s | 0.01 to 3 | The time it’ll take for the signal to transition from the full level (0dB) to the ducking level. |
| Release time | Float | s | 1 s | 0.01 to 10 | The time it’ll take for the signal to transition from the ducking level back to the full level (0dB) after the ducking condition expires |
| Hold time | Float | s | 1 s | 0.01 to 3 | The minimum amount of time from the start of the ducking or from the detection of incoming level above threshold (whichever is greater) for the ducking to start releasing |
| Bypass | ULong | 0 | 0 and 1 | Whether the processing should be bypassed.
|
Control Parameters
| Parameters | Descriptions | Range |
|
Control input in linear scale Or Control input in dB scale |
Control input (Side Chain Level) data in linear scale. The range is from 0.0 to 1.0 in normalized. Control input (Side Chain Level) data in dB scale. The range is from -128.0 to 0.0 |
0.0 to 1.0 -128.0 to 0.0 |
| Threshold |
The minimal value of incoming control signal to trigger ducking. It is available only in enhanced mode. |
-128 to 0 dB |
| Attenuation |
The amount of the signal that will be attenuated when ducking is active. It is available only in enhanced mode. |
0 to 128 dB |
| Bypass |
Whether the processing should be bypassed. 0 – Bypass disabled (Default) 1 – Bypass enabled It is available only in enhanced mode. |
0 and 1 |
State Parameters
Ducker exposes the following state parameters to indicate the status of the audio object, and these are streamable.
| Parameter | Data Type | Default Value | Unit | Range | Description |
| Side Chain Level | Float | 0 dB | dB | -128 to 0 dB | The control input amplitude value in dB. |
| Ducking status | Float | 0 | 0 to 1 | The ducking process is applied or not. | |
| Gain attenuation | Float | 0 dB | dB | 0 to 128 dB | The amplitude difference between input and output audio in dB. |
Native Panel
The Ducker audio object don’t have any native panel.