CAESinkStarfish Class Reference

#include <AESinkStarfish.h>

Inheritance diagram for CAESinkStarfish:

Public Member Functions
const char *	GetName () override
	CAESinkStarfish ()
	~CAESinkStarfish () override
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	AddPause (unsigned int millis) override
	instruct the sink to add a pause
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 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 &list, bool force=false)

Constructor & Destructor Documentation

CAESinkStarfish()

CAESinkStarfish::CAESinkStarfish

(

)

~CAESinkStarfish()

CAESinkStarfish::~CAESinkStarfish ( )

overridedefault

Member Function Documentation

AddPackets()

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

AddPause()

void CAESinkStarfish::AddPause ( unsigned int millis )

overridevirtual

instruct the sink to add a pause

Parameters

millis

ms to pause

Reimplemented from IAESink.

Create()

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

static

Deinitialize()

void CAESinkStarfish::Deinitialize ( )

overridevirtual

Implements IAESink.

Drain()

void CAESinkStarfish::Drain ( )

overridevirtual

Reimplemented from IAESink.

EnumerateDevicesEx()

void CAESinkStarfish::EnumerateDevicesEx ( AEDeviceInfoList & list, bool force = false )

static

GetCacheTotal()

double CAESinkStarfish::GetCacheTotal ( )

overridevirtual

Implements IAESink.

GetDelay()

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

overridevirtual

Reimplemented from IAESink.

GetName()

const char * CAESinkStarfish::GetName ( )

inlineoverridevirtual

Implements IAESink.

Initialize()

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

overridevirtual

Implements IAESink.

Register()

void CAESinkStarfish::Register ( )

static

---

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

• AESinkStarfish.h
• AESinkStarfish.cpp