HMute< T > Class Template Reference

#include <hmute.h>

Inheritance diagram for HMute< T >:

Collaboration diagram for HMute< T >:

Public Member Functions
	HMute (HWriter< T > *writer, bool muted, size_t blocksize)
	HMute (HWriterConsumer< T > *consumer, bool muted, size_t blocksize)
	HMute (HReader< T > *reader, bool muted, size_t blocksize)
	~HMute ()
virtual void	Filter (T *src, T *dest, size_t blocksize)
void	SetMuted (bool muted)
bool	GetMuted ()
bool	Start ()
bool	Stop ()
Public Member Functions inherited from HFilter< T >
	~HFilter ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
bool	Command (HCommand *command)
void	Enable ()
void	Disable ()
bool	GetEnabled ()
Public Member Functions inherited from HObject
	HObject ()
Public Member Functions inherited from HWriter< T >
virtual	~HWriter ()=default
HWriter< T > *	Writer ()
Public Member Functions inherited from HReader< T >
virtual	~HReader ()=default
HReader< T > *	Reader ()
Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > *	Consumer ()

Additional Inherited Members
Static Public Member Functions inherited from HFilter< T >
static std::vector< float >	ReadCoeffsFromFile (std::string filename)
static std::vector< float >	ReadCoeffsFromFile (char *filename)
Protected Member Functions inherited from HFilter< T >
	HFilter (HWriter< T > *writer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HWriterConsumer< T > *consumer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HReader< T > *reader, size_t blocksize, HProbe< T > *probe=NULL)
void	SetWriter (HWriter< T > *writer)
Protected Attributes inherited from HFilter< T >
int	_blocksize

Detailed Description

template<class T>
class HMute< T >

A filter that can be muted. When muted, reads will return zero samples and writes will write zero samples.

When the component is muted, Stop() will be called on the up- or downstream writer or reader. And when unmuted, Start() will be called.

A call to Start() or Stop() will only be propagated if the muted state is 'not muted' (false).

Constructor & Destructor Documentation

HMute() [1/3]

template<class T >

HMute< T >::HMute	(	HWriter< T > *	writer,
		bool	muted,
		size_t	blocksize
	)

Construct a new HMute object that writes to a writer

HMute() [2/3]

template<class T >

HMute< T >::HMute	(	HWriterConsumer< T > *	consumer,
		bool	muted,
		size_t	blocksize
	)

Construct a new HMute object that registers with an upstream writer

HMute() [3/3]

template<class T >

HMute< T >::HMute	(	HReader< T > *	reader,
		bool	muted,
		size_t	blocksize
	)

Construct a new HMute object that reads from a reader

~HMute()

template<class T >

HMute< T >::~HMute

Default destructor

Member Function Documentation

Filter()

template<class T >

void HMute< T >::Filter ( T *  src, T *  dest, size_t  blocksize  )

virtual

Run a block of samples through the mute filter

Implements HFilter< T >.

GetMuted()

template<class T >

bool HMute< T >::GetMuted ( )

inline

Get state

SetMuted()

template<class T >

void HMute< T >::SetMuted

(

bool

muted

)

Set state

Start()

template<class T >

bool HMute< T >::Start

virtual

Initialize before first write

Reimplemented from HFilter< T >.

Stop()

template<class T >

bool HMute< T >::Stop

virtual

Cleanup after last write

Reimplemented from HFilter< T >.

---

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

• /home/henrik/Git/Hardt/hardt/libhardt/include/hmute.h
• /home/henrik/Git/Hardt/hardt/libhardt/filters/hmute.cpp