AnimateableTimeStretchPitchScale Class Reference

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

#include <AnimateableTimeStretchPitchScale.h>

Inheritance diagram for AnimateableTimeStretchPitchScale:

Public Member Functions
	AnimateableTimeStretchPitchScale (std::shared_ptr< ISound > sound, float fps, float timeStretch, float pitchScale, StretcherQuality quality, bool preserveFormant)
	Creates a new time-stretch, pitch-scaled sound that can be animated.
	AnimateableTimeStretchPitchScale (std::shared_ptr< ISound > sound, float fps, std::shared_ptr< AnimateableProperty > timeStretch, std::shared_ptr< AnimateableProperty > pitchScale, StretcherQuality quality, bool preserveFormant)
	Creates a new time-stretch, pitch-scaled sound that can be animated.
bool	getPreserveFormant () const
	Returns whether formant preservation is enabled.
StretcherQuality	getStretcherQuality () const
	Returns the quality of the stretcher.
std::shared_ptr< AnimateableProperty >	getAnimProperty (AnimateablePropertyType type)
	Retrieves one of the animated properties of the sound.
float	getFPS () const
	Retrieves the animation system's FPS.
void	setFPS (float fps)
	Sets the animation system's FPS.
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 with animation support.

Note

The reader has to be seekable.

Constructor & Destructor Documentation

AnimateableTimeStretchPitchScale() [1/2]

AnimateableTimeStretchPitchScale::AnimateableTimeStretchPitchScale	(	std::shared_ptr< ISound >	sound,
		float	fps,
		float	timeStretch,
		float	pitchScale,
		StretcherQuality	quality,
		bool	preserveFormant )

Creates a new time-stretch, pitch-scaled sound that can be animated.

Parameters

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

AnimateableTimeStretchPitchScale() [2/2]

AnimateableTimeStretchPitchScale::AnimateableTimeStretchPitchScale	(	std::shared_ptr< ISound >	sound,
		float	fps,
		std::shared_ptr< AnimateableProperty >	timeStretch,
		std::shared_ptr< AnimateableProperty >	pitchScale,
		StretcherQuality	quality,
		bool	preserveFormant )

Creates a new time-stretch, pitch-scaled sound that can be animated.

Parameters

sound	The input sound.
fps	The fps of the anumation system.
timeRatio	The animateable time-stretch property.
pitchScale	The animateable pitch-scale property.
quality	The processing quality level of the stretcher.
preserveFormant	Whether to preserve the vocal formants for the stretcher.

Member Function Documentation

createReader()

virtual std::shared_ptr< IReader > AnimateableTimeStretchPitchScale::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.

getAnimProperty()

std::shared_ptr< AnimateableProperty > AnimateableTimeStretchPitchScale::getAnimProperty

(

AnimateablePropertyType

type

)

Retrieves one of the animated properties of the sound.

Parameters

type	Which animated property to retrieve.

Returns

A shared pointer to the animated property

getFPS()

float AnimateableTimeStretchPitchScale::getFPS

(

)

const

Retrieves the animation system's FPS.

Returns

The animation system's FPS.

setFPS()

void AnimateableTimeStretchPitchScale::setFPS

(

float

fps

)

Sets the animation system's FPS.

Parameters

fps	The new FPS.

---

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

• fx/AnimateableTimeStretchPitchScale.h