switchboard::MusicDuckingV2Node Class Reference

Ducks music signal based on voice signal. Music signal has to be connected to the first input bus, ducking voice signals have to be connected to the second input bus. Output is the ducked music signal. More...

#include <MusicDuckingV2Node.hpp>

Inheritance diagram for switchboard::MusicDuckingV2Node:

Public Member Functions
SB_WASM float	getDuckingAmount () const
	Gets the current ducking amount. Returned value is between 0 and 1.
SB_WASM void	setDuckingAmount (float duckingAmount)
	Sets the current ducking amount. The provided value has to be between 0 and 1, where 0 means no ducking and 1 means maximum ducking. At the value of 1, the output signal attenuated by 100dB and is inaudible.
SB_WASM float	getActivationThreshold () const
	Gets the current ducking amount. Returned value is between 0 and 1.
SB_WASM void	setActivationThreshold (float threshold)
	Sets the current activation threshold. The provided value has to be between 0 and 1.
SB_WASM void	setAttackSeconds (float attackSeconds)
	Sets the attack time of the ducking.
SB_WASM float	getAttackSeconds () const
	Gets the current attack time of the ducking.
SB_WASM void	setReleaseSeconds (float releaseSeconds)
	Sets the release time of the ducking.
SB_WASM float	getReleaseSeconds () const
	Gets the current release time of the ducking.
SB_WASM void	setHoldSeconds (float holdSeconds)
	Sets the hold time of the ducking.
SB_WASM float	getHoldSeconds () const
	Gets the current hold time of the ducking.
SB_WASM bool	getForcedDuckingEnabled () const
	Gets whether forced ducking is enabled.
SB_WASM void	setForcedDuckingEnabled (const bool newValue)
	Enables or disables forced ducking.
SB_WASM bool	getMixDuckingSignal () const
	Tells if the node is in mixDuckingSignal mode. If set to yes, audio trigger input will be mixed to the output.
SB_WASM void	setMixDuckingSignal (const bool mix)
	Sets the node to mix ducking signal mode..
bool	setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses) override
bool	setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
bool	process (AudioBusList &inBuses, AudioBusList &outBuses) override

Detailed Description

Ducks music signal based on voice signal. Music signal has to be connected to the first input bus, ducking voice signals have to be connected to the second input bus. Output is the ducked music signal.

MusicDuckingV2Node class.

Member Function Documentation

getActivationThreshold()

float switchboard::MusicDuckingV2Node::getActivationThreshold

(

)

const

Gets the current ducking amount. Returned value is between 0 and 1.

Returns

The current ducking amount.

getAttackSeconds()

float switchboard::MusicDuckingV2Node::getAttackSeconds

(

)

const

Gets the current attack time of the ducking.

Returns

The attack time in seconds.

getDuckingAmount()

float switchboard::MusicDuckingV2Node::getDuckingAmount

(

)

const

Gets the current ducking amount. Returned value is between 0 and 1.

Returns

The current ducking amount.

getForcedDuckingEnabled()

bool switchboard::MusicDuckingV2Node::getForcedDuckingEnabled

(

)

const

Gets whether forced ducking is enabled.

When forced ducking is enabled, the input ducking signal is ignored and ducking is always applied.

Returns

True when forced ducking is enabled.

getHoldSeconds()

float switchboard::MusicDuckingV2Node::getHoldSeconds

(

)

const

Gets the current hold time of the ducking.

Returns

The hold time in seconds.

getMixDuckingSignal()

bool switchboard::MusicDuckingV2Node::getMixDuckingSignal

(

)

const

Tells if the node is in mixDuckingSignal mode. If set to yes, audio trigger input will be mixed to the output.

Returns

True if the node is in passthrough mode.

getReleaseSeconds()

float switchboard::MusicDuckingV2Node::getReleaseSeconds

(

)

const

Gets the current release time of the ducking.

Returns

The release time in seconds.

setActivationThreshold()

void switchboard::MusicDuckingV2Node::setActivationThreshold

(

float

threshold

)

Sets the current activation threshold. The provided value has to be between 0 and 1.

Parameters

threshold

The new activation threshold.

setAttackSeconds()

void switchboard::MusicDuckingV2Node::setAttackSeconds

(

float

attackSeconds

)

Sets the attack time of the ducking.

When set to 0, the ducking is applied immediately without any ramping.

Parameters

attackSeconds

The new attack time value in seconds.

setDuckingAmount()

void switchboard::MusicDuckingV2Node::setDuckingAmount

(

float

duckingAmount

)

Sets the current ducking amount. The provided value has to be between 0 and 1, where 0 means no ducking and 1 means maximum ducking. At the value of 1, the output signal attenuated by 100dB and is inaudible.

Parameters

duckingAmount

The new amount.

setForcedDuckingEnabled()

void switchboard::MusicDuckingV2Node::setForcedDuckingEnabled

(

const bool

newValue

)

Enables or disables forced ducking.

Parameters

newValue

True when it is enabled, false when it is not.

setHoldSeconds()

void switchboard::MusicDuckingV2Node::setHoldSeconds

(

float

holdSeconds

)

Sets the hold time of the ducking.

Parameters

holdSeconds

The new hold time value in seconds.

setMixDuckingSignal()

void switchboard::MusicDuckingV2Node::setMixDuckingSignal

(

const bool

mix

)

Sets the node to mix ducking signal mode..

Parameters

mix	The new value.

setReleaseSeconds()

void switchboard::MusicDuckingV2Node::setReleaseSeconds

(

float

releaseSeconds

)

Sets the release time of the ducking.

When set to 0, the ducking is disabled immediately without any ramping.

Parameters

releaseSeconds

The new release time value in seconds.