CAESinkXAudio Class Reference

#include <AESinkXAudio.h>

Inheritance diagram for CAESinkXAudio:

Public Member Functions
virtual const char *	GetName ()
	CAESinkXAudio ()
virtual	~CAESinkXAudio ()
bool	Initialize (AEAudioFormat &format, std::string &device) override
void	Deinitialize () override
void	GetDelay (AEDelayStatus &status) override
	Return a timestamped status structure with delay and sink info.
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	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)

Static Public Member Functions
static void	Register ()
static std::unique_ptr< IAESink >	Create (std::string &device, AEAudioFormat &desiredFormat)
static void	EnumerateDevicesEx (AEDeviceInfoList &deviceInfoList, bool force=false)

Constructor & Destructor Documentation

CAESinkXAudio()

CAESinkXAudio::CAESinkXAudio

(

)

~CAESinkXAudio()

CAESinkXAudio::~CAESinkXAudio ( )

virtual

Member Function Documentation

AddPackets()

unsigned int CAESinkXAudio::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.

Create()

std::unique_ptr< IAESink > CAESinkXAudio::Create ( std::string & device, AEAudioFormat & desiredFormat )

static

Deinitialize()

void CAESinkXAudio::Deinitialize ( )

overridevirtual

Implements IAESink.

Drain()

void CAESinkXAudio::Drain ( )

overridevirtual

Todo

use FormatMessage for a human readable error message

Reimplemented from IAESink.

EnumerateDevicesEx()

void CAESinkXAudio::EnumerateDevicesEx ( AEDeviceInfoList & deviceInfoList, bool force = false )

static

GetCacheTotal()

double CAESinkXAudio::GetCacheTotal ( )

overridevirtual

Implements IAESink.

GetDelay()

void CAESinkXAudio::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 CAESinkXAudio::GetLatency ( )

overridevirtual

Reimplemented from IAESink.

GetName()

virtual const char * CAESinkXAudio::GetName ( )

inlinevirtual

Implements IAESink.

Initialize()

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

overridevirtual

Implements IAESink.

Register()

void CAESinkXAudio::Register ( )

static

---

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

• AESinkXAudio.h
• AESinkXAudio.cpp