IAESink Class Reference

#include <AESink.h>

Inheritance diagram for IAESink:

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

Constructor & Destructor Documentation

IAESink()

IAESink::IAESink ( )

default

~IAESink()

virtual IAESink::~IAESink ( )

virtualdefault

Member Function Documentation

AddPackets()

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

pure virtual

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

Implemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

AddPause()

virtual void IAESink::AddPause ( unsigned int millis )

inlinevirtual

instruct the sink to add a pause

Parameters

millis

ms to pause

Reimplemented in CAESinkAUDIOTRACK, and CAESinkStarfish.

Deinitialize()

virtual void IAESink::Deinitialize ( )

pure virtual

Implemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

Drain()

virtual void IAESink::Drain ( )

inlinevirtual

Reimplemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

GetCacheTotal()

virtual double IAESink::GetCacheTotal ( )

pure virtual

Implemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

GetDelay()

virtual void IAESink::GetDelay ( AEDelayStatus & status )

pure virtual

Return a timestamped status structure with delay and sink info.

Parameters

status

structure filled with sink status

Implemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

GetLatency()

virtual double IAESink::GetLatency ( )

inlinevirtual

Reimplemented in CAESinkAUDIOTRACK, CAESinkStarfish, and CAESinkXAudio.

GetName()

virtual const char * IAESink::GetName ( )

pure virtual

Implemented in CAESinkDirectSound, CAESinkXAudio, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, and AE::SINK::CAESinkPipewire.

HasVolume()

virtual bool IAESink::HasVolume ( )

inlinevirtual

Reimplemented in CAESinkDARWINIOS, CAESinkDARWINTVOS, and CAESinkPULSE.

Initialize()

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

pure virtual

Implemented in CAESinkDirectSound, CAESinkALSA, CAESinkAUDIOTRACK, CAESinkDARWINIOS, CAESinkDARWINOSX, CAESinkDARWINTVOS, CAESinkOSS, CAESinkPULSE, CAESinkSNDIO, CAESinkStarfish, CAESinkWASAPI, CAESinkXAudio, and AE::SINK::CAESinkPipewire.

SetVolume()

virtual void IAESink::SetVolume ( float volume )

inlinevirtual

Reimplemented in CAESinkPULSE.

---

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

• AESink.h