This sound allows a sound to be time-stretched and pitch scaled. More...

Inheritance diagram for TimeStretchPitchScale:

[legend]

Public Member Functions
	TimeStretchPitchScale (std::shared_ptr< ISound > sound, double timeRatio, double pitchScale, StretcherQuality quality, bool preserveFormant)
	Creates a new time-stretch, pitch scaled sound.
double	getTimeRatio () const
	Returns the time ratio.
double	getPitchScale () const
	Returns the pitch scale.
bool	getPreserveFormant () const
	Returns whether formant preservation is enabled.
StretcherQuality	getStretcherQuality () const
	Returns the quality of the stretcher.
virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source.
Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.
Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound allows a sound to be time-stretched and pitch scaled.

Constructor & Destructor Documentation

TimeStretchPitchScale::TimeStretchPitchScale	(	std::shared_ptr< ISound >	sound,
		double	timeRatio,
		double	pitchScale,
		StretcherQuality	quality,
		bool	preserveFormant )

Creates a new time-stretch, pitch scaled sound.

Parameters

sound	The input sound.
timeRatio	The factor by which to stretch or compress time.
pitchScale	The factor by which to adjust the pitch.
quality	The processing quality level.
preserveFormant	Whether to preserve the vocal formants for the stretcher.

virtual std::shared_ptr< IReader > TimeStretchPitchScale::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns: A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

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