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

This reader plays back sequenced entries. More...

#include <SequenceReader.h>

Inheritance diagram for SequenceReader:
Inheritance graph
[legend]

Public Member Functions

 SequenceReader (std::shared_ptr< SequenceData > sequence, bool quality=false)
 Creates a resampling reader.
 
 ~SequenceReader ()
 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.
 
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 IReader
virtual ~IReader ()
 Destroys the reader.
 
virtual bool isSeekable () const =0
 Tells whether the source provides seeking functionality or not.
 
virtual void seek (int position)=0
 Seeks to a specific position in the source.
 
virtual int getLength () const =0
 Returns an approximated length of the source in samples.
 
virtual int getPosition () const =0
 Returns the position of the source as a sample count value.
 
virtual Specs getSpecs () const =0
 Returns the specification of the reader.
 
virtual void read (int &length, bool &eos, sample_t *buffer)=0
 Request to read the next length samples out of the source.
 

Detailed Description

This reader plays back sequenced entries.

Constructor & Destructor Documentation

◆ SequenceReader()

SequenceReader::SequenceReader ( std::shared_ptr< SequenceData sequence,
bool  quality = false 
)

Creates a resampling reader.

Parameters
sequenceThe sequence data.
qualityWhether a high quality resample should be used for resampling.

Member Function Documentation

◆ getLength()

virtual int SequenceReader::getLength ( ) const
virtual

Returns an approximated length of the source in samples.

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

Implements IReader.

◆ getPosition()

virtual int SequenceReader::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.

Implements IReader.

◆ getSpecs()

virtual Specs SequenceReader::getSpecs ( ) const
virtual

Returns the specification of the reader.

Returns
The Specs structure.

Implements IReader.

◆ isSeekable()

virtual bool SequenceReader::isSeekable ( ) const
virtual

Tells whether the source provides seeking functionality or not.

Warning
This doesn't mean that the seeking always has to succeed.
Returns
Always returns true for readers of buffering types.

Implements IReader.

◆ read()

virtual void SequenceReader::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.

Implements IReader.

◆ seek()

virtual void SequenceReader::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.

Implements IReader.


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