Mezzanine::Audio::PitchShifterParameters Struct Reference

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

#include <effectparameters.h>

Public Member Functions
	PitchShifterParameters (Integer coarseTune=12, Integer fineTune=0)
	Struct constructor. More...

Public Attributes
Integer	CoarseTune
	This sets the number of semitones by which the pitch is shifted. More...
Integer	FineTune
	This sets the number of cents between Semitones a pitch is shifted. More...

Detailed Description

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

The pitch shifter applies time-invariant pitch shifting to the input signal, over a one octave range and controllable at a semi-tone and cent resolution.

Definition at line 672 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::PitchShifterParameters::PitchShifterParameters ( Integer  coarseTune = 12, Integer  fineTune = 0  )

inline

Struct constructor.

Parameters

coarseTune@copybrief	PitchShifterParameters::CoarseTune
fineTune@copybrief	PitchShifterParameters::FineTune

Definition at line 684 of file effectparameters.h.

Member Data Documentation

Integer Mezzanine::Audio::PitchShifterParameters::CoarseTune

This sets the number of semitones by which the pitch is shifted.

Remarks

There are 12 semitones per octave. Negative values create a downwards shift in pitch, positive values pitch the sound upwards.

Range: -12 to 12

Definition at line 676 of file effectparameters.h.

Integer Mezzanine::Audio::PitchShifterParameters::FineTune

This sets the number of cents between Semitones a pitch is shifted.

Remarks

A Cent is 1/100th of a Semitone. Negative values create a downwards shift in pitch, positive values pitch the sound upwards.

Range: -50 to 50

Definition at line 679 of file effectparameters.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/Audio/effectparameters.h