sfFDN::DelayTimeVarying Class Reference

A delay line with time-varying delay. More...

#include <delay_time_varying.h>

Inheritance diagram for sfFDN::DelayTimeVarying:

Collaboration diagram for sfFDN::DelayTimeVarying:

Public Member Functions
	DelayTimeVarying (const DelayOptions &config)
	Constructs a delay line with time-varying delay.
void	Clear () override
	Clears the delay line.
void	SetMaximumDelay (uint32_t delay)
	Sets the maximum delay for the delay line.
void	SetDelay (float delay)
	Sets the delay for the delay line.
float	GetDelay () const
	Gets the current delay of the delay line.
void	SetMod (const ModulationOptions &options)
	Sets the modulation options for the delay line.
float	Tick (float input) noexcept SFFDN_NONBLOCKING
	Processes a single sample.
uint32_t	InputChannelCount () const noexcept SFFDN_NONBLOCKING override
	Returns the number of input channels this processor expects.
uint32_t	OutputChannelCount () const noexcept SFFDN_NONBLOCKING override
	Returns the number of output channels this processor produces.
void	Process (const AudioBuffer &input, AudioBuffer &output) noexcept SFFDN_NONBLOCKING override
	Processes the audio buffer.
std::unique_ptr< AudioProcessor >	Clone () const override
	Creates a copy of the processor.
Public Member Functions inherited from sfFDN::AudioProcessor

Additional Inherited Members
Protected Member Functions inherited from sfFDN::AudioProcessor
	AudioProcessor (const AudioProcessor &)=default
AudioProcessor &	operator= (const AudioProcessor &)=default
	AudioProcessor (AudioProcessor &&) noexcept=default
AudioProcessor &	operator= (AudioProcessor &&) noexcept=default

Detailed Description

A delay line with time-varying delay.

Constructor & Destructor Documentation

DelayTimeVarying()

sfFDN::DelayTimeVarying::DelayTimeVarying

(

const DelayOptions &

config

)

Constructs a delay line with time-varying delay.

Parameters

config

The configuration options for the delay line.

Member Function Documentation

Clear()

void sfFDN::DelayTimeVarying::Clear ( )

overridevirtual

Clears the delay line.

Implements sfFDN::AudioProcessor.

Clone()

std::unique_ptr< AudioProcessor > sfFDN::DelayTimeVarying::Clone ( ) const

overridevirtual

Creates a copy of the processor.

Returns

A unique pointer to the cloned processor.

Implements sfFDN::AudioProcessor.

GetDelay()

float sfFDN::DelayTimeVarying::GetDelay

(

)

const

Gets the current delay of the delay line.

Returns

The delay in samples.

InputChannelCount()

uint32_t sfFDN::DelayTimeVarying::InputChannelCount ( ) const

overridevirtualnoexcept

Returns the number of input channels this processor expects.

Returns

The number of input channels.

Note

This is equal to the number of delay lines in the bank.

Implements sfFDN::AudioProcessor.

OutputChannelCount()

uint32_t sfFDN::DelayTimeVarying::OutputChannelCount ( ) const

overridevirtualnoexcept

Returns the number of output channels this processor produces.

Returns

The number of output channels.

Note

This is equal to the number of delay lines in the bank.

Implements sfFDN::AudioProcessor.

Process()

void sfFDN::DelayTimeVarying::Process ( const AudioBuffer & input, AudioBuffer & output )

overridevirtualnoexcept

Processes the audio buffer.

Parameters

input	The input audio buffer.
output	The output audio buffer.

Implements sfFDN::AudioProcessor.

SetDelay()

void sfFDN::DelayTimeVarying::SetDelay

(

float

delay

)

Sets the delay for the delay line.

Parameters

delay

The delay in samples.

SetMaximumDelay()

void sfFDN::DelayTimeVarying::SetMaximumDelay

(

uint32_t

delay

)

Sets the maximum delay for the delay line.

Parameters

delay

The maximum delay in samples.

SetMod()

void sfFDN::DelayTimeVarying::SetMod

(

const ModulationOptions &

options

)

Sets the modulation options for the delay line.

Parameters

options

The modulation options.

Tick()

float sfFDN::DelayTimeVarying::Tick ( float input )

noexcept

Processes a single sample.

Parameters

input

The input sample.

Returns

The output sample.

---

The documentation for this class was generated from the following file:

• include/sffdn/delay_time_varying.h