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

This class reads another reader and delays it. More...

#include <DelayReader.h>

Inheritance diagram for DelayReader:
Inheritance graph
[legend]

Public Member Functions

 DelayReader (std::shared_ptr< IReader > reader, double delay)
 Creates a new delay reader.
 
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 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 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 reads another reader and delays it.

Constructor & Destructor Documentation

◆ DelayReader()

DelayReader::DelayReader ( std::shared_ptr< IReader > reader,
double delay )

Creates a new delay reader.

Parameters
readerThe reader to read from.
delayThe delay in seconds.

Member Function Documentation

◆ getLength()

virtual int DelayReader::getLength ( ) const
virtual

Returns an approximated length of the source in samples.

Returns
The length as sample count. May be negative if unknown.

Reimplemented from EffectReader.

◆ getPosition()

virtual int DelayReader::getPosition ( ) const
virtual

Returns the position of the source as a sample count value.

Returns
The current position in the source. A negative value indicates that the position is unknown.
Warning
The value returned doesn't always have to be correct for readers, especially after seeking.

Reimplemented from EffectReader.

◆ read()

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

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

The buffer supplied has the needed size.

Parameters
[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.

◆ seek()

virtual void DelayReader::seek ( int position)
virtual

Seeks to a specific position in the source.

Parameters
positionThe position to seek for measured in samples. To get from a given time to the samples you simply have to multiply the time value in seconds with the sample rate of the reader.
Warning
This may work or not, depending on the actual reader.

Reimplemented from EffectReader.


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