This sound limits another sound in start and end time. More...

#include <Limiter.h>

Inheritance diagram for Limiter:

[legend]

Public Member Functions
	Limiter (std::shared_ptr< ISound > sound, double start=0, double end=-1)
	Creates a new limiter sound.
double	getStart () const
	Returns the start time.
double	getEnd () const
	Returns the end time.
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 limits another sound in start and end time.

Constructor & Destructor Documentation

Creates a new limiter sound.

Parameters

sound	The input sound.
start	The desired start time.
end	The desired end time, a negative value signals that it should play to the end.

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