switchboard::MusicDuckingNode Class Reference

Ducks a stereo music signal based on mono voice signal(s). Music signal has to be connected to the first input bus, ducking voice signals have to be connected to the second, third, ... input buses. Output is the ducked music signal.`. More...

#include <MusicDuckingNode.hpp>

Inheritance diagram for switchboard::MusicDuckingNode:

Public Member Functions
SB_WASM	MusicDuckingNode ()
	MusicDuckingNode constructor.
SB_WASM	~MusicDuckingNode ()
	MusicDuckingNode destructor.
SB_WASM float	getDuckingAmount (const uint duckingSignalIndex) const
	Gets the current ducking amount. Returned value is between 0 and 1.
SB_WASM void	setDuckingAmount (const float newDuckingAmount, const uint duckingSignalIndex)
	Sets the current ducking amount. The provided value has to be between 0 and 1.
SB_WASM float	getDuckReleaseAmount () const
	Gets the ducking release amount. When the ducking threshold is not exceeded, the ducking amount value will be increased by this value. Default value: 0.5 dB.
SB_WASM void	setDuckReleaseAmount (const float newDuckReleaseAmount)
	Sets the ducking release amount. When the ducking threshold is not exceeded, the ducking amount value will be increased by this value. Default value: 0.5 dB.
SB_WASM float	getNumSecondsToHoldDucking () const
	Gets the number of seconds to hold ducking value. When ducking stops being triggered, ducking will still be held for this many seconds. Default value: 2.0 secs.
SB_WASM void	setNumSecondsToHoldDucking (const float numSecondsToHoldDucking)
	Sets the number of seconds to hold ducking value.
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..
DuckingCompressor *	getCompressor () const
	Gets the pointer to the compressor that does the ducking.
void	setCompressor (DuckingCompressor *compressor)
	Sets the compressor that is used by the ducking node.
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 a stereo music signal based on mono voice signal(s). Music signal has to be connected to the first input bus, ducking voice signals have to be connected to the second, third, ... input buses. Output is the ducked music signal.`.

MusicDuckingNode class.

Member Function Documentation

getCompressor()

DuckingCompressor * switchboard::MusicDuckingNode::getCompressor

(

)

const

Gets the pointer to the compressor that does the ducking.

Returns

A pointer to the compressor instance.

getDuckingAmount()

float switchboard::MusicDuckingNode::getDuckingAmount

(

const uint

duckingSignalIndex

)

const

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

Parameters

duckingSignalIndex

Index of the ducking signal.

Returns

The current ducking amount.

getDuckReleaseAmount()

float switchboard::MusicDuckingNode::getDuckReleaseAmount

(

)

const

Gets the ducking release amount. When the ducking threshold is not exceeded, the ducking amount value will be increased by this value. Default value: 0.5 dB.

Returns

the ducking release amount.

getMixDuckingSignal()

bool switchboard::MusicDuckingNode::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.

getNumSecondsToHoldDucking()

float switchboard::MusicDuckingNode::getNumSecondsToHoldDucking

(

)

const

Gets the number of seconds to hold ducking value. When ducking stops being triggered, ducking will still be held for this many seconds. Default value: 2.0 secs.

Returns

The number of seconds to hold ducking.

setCompressor()

void switchboard::MusicDuckingNode::setCompressor

(

DuckingCompressor *

compressor

)

Sets the compressor that is used by the ducking node.

Parameters

compressor

Pointer to a DuckingCompressor instance.

setDuckingAmount()

void switchboard::MusicDuckingNode::setDuckingAmount	(	const float	newDuckingAmount,
		const uint	duckingSignalIndex )

Sets the current ducking amount. The provided value has to be between 0 and 1.

Parameters

newDuckingAmount	The new amount.
duckingSignalIndex	Index of the trigger input.

setDuckReleaseAmount()

void switchboard::MusicDuckingNode::setDuckReleaseAmount

(

const float

newDuckReleaseAmount

)

Sets the ducking release amount. When the ducking threshold is not exceeded, the ducking amount value will be increased by this value. Default value: 0.5 dB.

Parameters

newDuckReleaseAmount

The new value.

setMixDuckingSignal()

void switchboard::MusicDuckingNode::setMixDuckingSignal

(

const bool

mix

)

Sets the node to mix ducking signal mode..

Parameters

mix	The new value.

setNumSecondsToHoldDucking()

void switchboard::MusicDuckingNode::setNumSecondsToHoldDucking

(

const float

numSecondsToHoldDucking

)

Sets the number of seconds to hold ducking value.

Parameters

numSecondsToHoldDucking

The new value.