ISourceBuffer< T > Class Template Reference

Basic source buffer interface. More...

#include <buffer.h>

Inheritance diagram for ISourceBuffer< T >:

Public Member Functions
virtual std::recursive_mutex &	getLock ()=0
	Function return locking object. More...
virtual size_t	getSize ()=0
	Function returns current buffer size in samples. More...
virtual size_t	readSamples (T *samples, size_t samplesCount, bool incrementPosition=true)=0
	Function reads the samples from buffer. More...
virtual void	incrementReadPosition (size_t pos)=0
	Function increments read position for N samples. More...

Detailed Description

template<typename T>
class ISourceBuffer< T >

Basic source buffer interface.

Member Function Documentation

getLock()

template<typename T>

virtual std::recursive_mutex& ISourceBuffer< T >::getLock ( )

pure virtual

Function return locking object.

Returns

Locking object

Implemented in FifoBufferBase< T >.

getSize()

template<typename T>

virtual size_t ISourceBuffer< T >::getSize ( )

pure virtual

Function returns current buffer size in samples.

Returns

Size in samples.

Implemented in ArrayBufferSourceDesc< T >, and FifoBufferBase< T >.

incrementReadPosition()

template<typename T>

virtual void ISourceBuffer< T >::incrementReadPosition ( size_t  pos )

pure virtual

Function increments read position for N samples.

Parameters

pos	an increment value

Returns

void

Implemented in FifoBufferBase< T >, and ArrayBufferSourceDesc< T >.

readSamples()

template<typename T>

virtual size_t ISourceBuffer< T >::readSamples ( T *  samples, size_t  samplesCount, bool  incrementPosition = true  )

pure virtual

Function reads the samples from buffer.

Parameters

samples	a pointer to the first sample
samplesCount	a number of samples to be read
incrementPosition	an option if change position

Returns

number of read samples

Implemented in IDirectArraySourceBuffer< T, Locking >, and IDirectArraySourceBuffer< T >.

---

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

• C:/CProjects/Libs/CommonLib/include/commonlib/memory/buffer.h