This is a struct containing all the parameters needed to describe a frequency shift effect. More...

Public Types
enum	ShiftDirection { ESD_Down, ESD_Up, ESD_Off }
	An enum describing the direction the frequency of the input signal will be shifted.

Public Member Functions
	FrequencyShiftParameters (Real frequency=0.0f, ShiftDirection left=ESD_Down, ShiftDirection right=ESD_Down)
	Struct constructor. More...

Public Attributes
Real	Frequency
	This is the carrier frequency. More...

ShiftDirection	Left
	These select which internal signals are added together to produce the output. More...

ShiftDirection	Right
	These select which internal signals are added together to produce the output. More...

Detailed Description

This is a struct containing all the parameters needed to describe a frequency shift effect.

The frequency shifter is a single-sideband modulator, which translates all the component frequencies of the input signal by an equal amount.

Definition at line 545 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::FrequencyShiftParameters::FrequencyShiftParameters	(	Real	frequency = `0.0f`,
		ShiftDirection	left = `ESD_Down`,
		ShiftDirection	right = `ESD_Down`
	)

inline

Struct constructor.

Parameters

frequency@copybrief	FrequencyShiftParameters::Frequency
left@copybrief	FrequencyShiftParameters::Left
right@copybrief	FrequencyShiftParameters::Right

Definition at line 572 of file effectparameters.h.

Real Mezzanine::Audio::FrequencyShiftParameters::Frequency

This is the carrier frequency.

Remarks: For carrier frequencies below the audible range, the singlesideband modulator may produce phaser effects, spatial effects or a slight pitch-shift. As the carrier frequency increases, the timbre of the sound is affected; a piano or guitar note becomes like a bell's chime, and a human voice sounds extraterrestrial!

Range: 0.0 to 24000.0

Definition at line 560 of file effectparameters.h.

ShiftDirection Mezzanine::Audio::FrequencyShiftParameters::Left

These select which internal signals are added together to produce the output.

Remarks: Different combinations of values will produce slightly different tonal and spatial effects.

Definition at line 563 of file effectparameters.h.

ShiftDirection Mezzanine::Audio::FrequencyShiftParameters::Right

These select which internal signals are added together to produce the output.

Remarks: Different combinations of values will produce slightly different tonal and spatial effects.

Definition at line 566 of file effectparameters.h.

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