AUD_BufferReader Class Reference

#include <AUD_BufferReader.h>

Inheritance diagram for AUD_BufferReader:

List of all members.

Public Member Functions
	AUD_BufferReader (AUD_Reference< AUD_Buffer > buffer, AUD_Specs specs)
virtual bool	isSeekable () const
virtual void	seek (int position)
virtual int	getLength () const
virtual int	getPosition () const
virtual AUD_Specs	getSpecs () const
virtual void	read (int &length, bool &eos, sample_t *buffer)

---

Detailed Description

This class represents a simple reader from a buffer that exists in memory.

Warning:

Notice that the buffer used for creating the reader must exist as long as the reader exists.

Definition at line 42 of file AUD_BufferReader.h.

---

Constructor & Destructor Documentation

AUD_BufferReader::AUD_BufferReader	(	AUD_Reference< AUD_Buffer >	buffer,
		AUD_Specs	specs
	)

Creates a new buffer reader.

Parameters:

buffer	The buffer to read from.
specs	The specification of the sample data in the buffer.

Definition at line 36 of file AUD_BufferReader.cpp.

---

Member Function Documentation

int AUD_BufferReader::getLength

(

)

const [virtual]

Returns an approximated length of the source in samples.

Returns:

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

Implements AUD_IReader.

Definition at line 52 of file AUD_BufferReader.cpp.

References AUD_SAMPLE_SIZE.

int AUD_BufferReader::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 AUD_IReader.

Definition at line 57 of file AUD_BufferReader.cpp.

AUD_Specs AUD_BufferReader::getSpecs

(

)

const [virtual]

Returns the specification of the reader.

Returns:

The AUD_Specs structure.

Implements AUD_IReader.

Definition at line 62 of file AUD_BufferReader.cpp.

bool AUD_BufferReader::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 AUD_IReader.

Definition at line 42 of file AUD_BufferReader.cpp.

void AUD_BufferReader::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]	length	The 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]	eos	End of stream, whether the end is reached or not.
[in]	buffer	The pointer to the buffer to read into.

Implements AUD_IReader.

Definition at line 67 of file AUD_BufferReader.cpp.

References AUD_SAMPLE_SIZE, AUD_Specs::channels, and length().

void AUD_BufferReader::seek

(

int

position

)

[virtual]

Seeks to a specific position in the source.

Parameters:

position

The 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 AUD_IReader.

Definition at line 47 of file AUD_BufferReader.cpp.

---

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

• AUD_BufferReader.h
• AUD_BufferReader.cpp