switchboard::NoiseGateNode Class Reference

Applies a noise gate transform to an input signal. More...

#include <NoiseGateNode.hpp>

Inheritance diagram for switchboard::NoiseGateNode:

Public Member Functions
SB_WASM	NoiseGateNode ()
	Creates a NoiseGateNode instance.
SB_WASM	~NoiseGateNode ()
	NoiseGateNode destructor.
SB_WASM float	getOpenThresholdDB ()
	Gets open threshold setting in decibels.
SB_WASM void	setOpenThresholdDB (float openThreshold)
	Sets the noise gate opening threshold in decibels.
SB_WASM float	getCloseThresholdDB ()
	Gets the close threshold setting in decibels.
SB_WASM void	setCloseThresholdDB (float closeThreshold)
	Sets the noise gate closing threshold setting in decibels.
SB_WASM float	getAttackTimeSeconds ()
	Gets the attack time setting in seconds.
SB_WASM void	setAttackTimeSeconds (float attackTimeSeconds)
	Sets the volume envelope filter attack time in seconds. Minimum value: 0.0f Maximum value: 0.5f.
SB_WASM float	getHoldTimeSeconds ()
	Gets hold time setting value in seconds.
SB_WASM void	setHoldTimeSeconds (float holdTimeSeconds)
	Sets the volume envelope filter hold time in seconds. Minimum value: 0.0f Maximum value: 1.0f.
SB_WASM float	getReleaseTimeSeconds ()
	Gets the release time setting value in seconds.
SB_WASM void	setReleaseTimeSeconds (float releaseTimeSeconds)
	Sets the volume envelope filter release time in seconds. Minimum value: 0.0f Maximum value: 1.0f.
SB_WASM bool	isEnabled ()
	Gets the enabled setting value of the noise gate.
SB_WASM void	setEnabled (bool enabled)
	Enables or disables the noise gate.
SB_WASM bool	setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat) override
SB_WASM bool	process (AudioBus &inBus, AudioBus &outBus) override

Detailed Description

Applies a noise gate transform to an input signal.

NoiseGateNode class.

Member Function Documentation

getAttackTimeSeconds()

float switchboard::NoiseGateNode::getAttackTimeSeconds

(

)

Gets the attack time setting in seconds.

Returns

The attack time.

getCloseThresholdDB()

float switchboard::NoiseGateNode::getCloseThresholdDB

(

)

Gets the close threshold setting in decibels.

Returns

The threshold value.

getHoldTimeSeconds()

float switchboard::NoiseGateNode::getHoldTimeSeconds

(

)

Gets hold time setting value in seconds.

Returns

The hold time setting.

getOpenThresholdDB()

float switchboard::NoiseGateNode::getOpenThresholdDB

(

)

Gets open threshold setting in decibels.

Returns

The threshold value.

getReleaseTimeSeconds()

float switchboard::NoiseGateNode::getReleaseTimeSeconds

(

)

Gets the release time setting value in seconds.

Returns

The release time setting value.

isEnabled()

bool switchboard::NoiseGateNode::isEnabled

(

)

Gets the enabled setting value of the noise gate.

Returns

True if the noise gate is enabled, false otherwise.

setAttackTimeSeconds()

void switchboard::NoiseGateNode::setAttackTimeSeconds

(

float

attackTimeSeconds

)

Sets the volume envelope filter attack time in seconds. Minimum value: 0.0f Maximum value: 0.5f.

Parameters

attackTimeSeconds

The new attack time in seconds.

setCloseThresholdDB()

void switchboard::NoiseGateNode::setCloseThresholdDB

(

float

closeThreshold

)

Sets the noise gate closing threshold setting in decibels.

When the signal drops below this threshold value the noise gate closes. Minimum value: -96.0f Maximum value: 24.0f

Parameters

closeThreshold

The new close threshold value.

setEnabled()

void switchboard::NoiseGateNode::setEnabled

(

bool

enabled

)

Enables or disables the noise gate.

Parameters

enabled

Flag indicating whether the noise gate should be enabled or disabled.

setHoldTimeSeconds()

void switchboard::NoiseGateNode::setHoldTimeSeconds

(

float

holdTimeSeconds

)

Sets the volume envelope filter hold time in seconds. Minimum value: 0.0f Maximum value: 1.0f.

Parameters

holdTimeSeconds

The new hold time in seconds.

setOpenThresholdDB()

void switchboard::NoiseGateNode::setOpenThresholdDB

(

float

openThreshold

)

Sets the noise gate opening threshold in decibels.

When the signal raises above this threshold value the noise gate opens. Minimum: -96.0f Maximum: 24.0f

Parameters

openThreshold

The new open threshold value.

setReleaseTimeSeconds()

void switchboard::NoiseGateNode::setReleaseTimeSeconds

(

float

releaseTimeSeconds

)

Sets the volume envelope filter release time in seconds. Minimum value: 0.0f Maximum value: 1.0f.

Parameters

releaseTimeSeconds

The new release time in seconds.