CAESinkNULL Class Reference

Sink that discards everything it is given. More...

#include <AESinkNULL.h>

Inheritance diagram for CAESinkNULL:

Public Member Functions
const char *	GetName () override
	CAESinkNULL (std::chrono::duration< double > cacheTotal, std::chrono::duration< double > latency)
bool	Initialize (AEAudioFormat &format, std::string &device) override
void	Deinitialize () override
double	GetCacheTotal () override
double	GetLatency () override
unsigned int	AddPackets (uint8_t **data, unsigned int frames, unsigned int offset) override
	Adds packets to be sent out, this routine MUST block or sleep.
void	GetDelay (AEDelayStatus &status) override
	Return a timestamped status structure with delay and sink info.
void	Drain () override
Public Member Functions inherited from IAESink
	IAESink ()=default
virtual	~IAESink ()=default
virtual void	AddPause (unsigned int millis)
	instruct the sink to add a pause
virtual bool	HasVolume ()
virtual void	SetVolume (float volume)

Detailed Description

Sink that discards everything it is given.

Takes over the configuration of the real device while that is handed over to an external media pipeline. Not registered with CAESinkFactory, it never shows up as a device.

Constructor & Destructor Documentation

CAESinkNULL()

CAESinkNULL::CAESinkNULL	(	std::chrono::duration< double >	cacheTotal,
		std::chrono::duration< double >	latency )

Member Function Documentation

AddPackets()

unsigned int CAESinkNULL::AddPackets ( uint8_t ** data, unsigned int frames, unsigned int offset )

overridevirtual

Adds packets to be sent out, this routine MUST block or sleep.

Parameters

data	array of pointers to planes holding audio data
frames	number of audio frames in data
offset	offset in frames where audio data starts

Returns

number of frames consumed by the sink

Implements IAESink.

Deinitialize()

void CAESinkNULL::Deinitialize ( )

inlineoverridevirtual

Implements IAESink.

Drain()

void CAESinkNULL::Drain ( )

overridevirtual

Reimplemented from IAESink.

GetCacheTotal()

double CAESinkNULL::GetCacheTotal ( )

inlineoverridevirtual

Implements IAESink.

GetDelay()

void CAESinkNULL::GetDelay ( AEDelayStatus & status )

overridevirtual

Return a timestamped status structure with delay and sink info.

Parameters

status

structure filled with sink status

Implements IAESink.

GetLatency()

double CAESinkNULL::GetLatency ( )

inlineoverridevirtual

Reimplemented from IAESink.

GetName()

const char * CAESinkNULL::GetName ( )

inlineoverridevirtual

Implements IAESink.

Initialize()

bool CAESinkNULL::Initialize ( AEAudioFormat & format, std::string & device )

overridevirtual

Implements IAESink.

---

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

• AESinkNULL.h
• AESinkNULL.cpp