Audaspace 1.5.0
A high level audio library.
No Matches
Public Member Functions | List of all members
FaderReader Class Reference

This class fades another reader. More...

#include <FaderReader.h>

Inheritance diagram for FaderReader:
Inheritance graph

Public Member Functions

 FaderReader (std::shared_ptr< IReader > reader, FadeType type, double start, double length)
 Creates a new fader reader.
virtual void read (int &length, bool &eos, sample_t *buffer)
 Request to read the next length samples out of the source.
- Public Member Functions inherited from EffectReader
 EffectReader (std::shared_ptr< IReader > reader)
 Creates a new effect reader.
virtual ~EffectReader ()
 Destroys the reader.
virtual bool isSeekable () const
 Tells whether the source provides seeking functionality or not.
virtual void seek (int position)
 Seeks to a specific position in the source.
virtual int getLength () const
 Returns an approximated length of the source in samples.
virtual int getPosition () const
 Returns the position of the source as a sample count value.
virtual Specs getSpecs () const
 Returns the specification of the reader.
- Public Member Functions inherited from IReader
virtual ~IReader ()
 Destroys the reader.

Additional Inherited Members

- Protected Attributes inherited from EffectReader
std::shared_ptr< IReaderm_reader
 The reader to read from.

Detailed Description

This class fades another reader.

If the fading type is FADE_IN, everything before the fading start will be silenced, for FADE_OUT that's true for everything after fading ends.

Constructor & Destructor Documentation

◆ FaderReader()

FaderReader::FaderReader ( std::shared_ptr< IReader > reader,
FadeType type,
double start,
double length )

Creates a new fader reader.

readerThe reader that this effect is applied on.
typeThe fading type.
startThe time where fading should start in seconds.
lengthHow long fading should last in seconds.

Member Function Documentation

◆ read()

virtual void FaderReader::read ( int & length,
bool & eos,
sample_t * buffer )

Request to read the next length samples out of the source.

The buffer supplied has the needed size.

[in,out]lengthThe count of samples that should be read. Shall contain the real count of samples after reading, in case there were only fewer samples available. A smaller value also indicates the end of the reader.
[out]eosEnd of stream, whether the end is reached or not.
[in]bufferThe pointer to the buffer to read into.

Reimplemented from EffectReader.

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