Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CAESinkPi Class Reference

#include <AESinkPi.h>

Inheritance diagram for CAESinkPi:
IAESink

Public Member Functions

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

Static Public Member Functions

static void Register ()
 
static IAESinkCreate (std::string &device, AEAudioFormat &desiredFormat)
 
static void EnumerateDevicesEx (AEDeviceInfoList &list, bool force=false)
 

Constructor & Destructor Documentation

◆ CAESinkPi()

CAESinkPi::CAESinkPi ( )

◆ ~CAESinkPi()

CAESinkPi::~CAESinkPi ( )
virtual

Member Function Documentation

◆ AddPackets()

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

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

Parameters
dataarray of pointers to planes holding audio data
framesnumber of audio frames in data
offsetoffset in frames where audio data starts
Returns
number of frames consumed by the sink

Implements IAESink.

◆ Create()

IAESink * CAESinkPi::Create ( std::string &  device,
AEAudioFormat desiredFormat 
)
static

◆ Deinitialize()

void CAESinkPi::Deinitialize ( )
virtual

Implements IAESink.

◆ Drain()

void CAESinkPi::Drain ( )
virtual

Reimplemented from IAESink.

◆ EnumerateDevicesEx()

void CAESinkPi::EnumerateDevicesEx ( AEDeviceInfoList list,
bool  force = false 
)
static

◆ GetCacheTotal()

double CAESinkPi::GetCacheTotal ( )
virtual

Implements IAESink.

◆ GetDelay()

void CAESinkPi::GetDelay ( AEDelayStatus status)
virtual

Return a timestamped status structure with delay and sink info.

Parameters
statusstructure filled with sink status

Implements IAESink.

◆ GetName()

virtual const char * CAESinkPi::GetName ( )
inlinevirtual

Implements IAESink.

◆ Initialize()

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

Implements IAESink.

◆ IsCompatible()

bool CAESinkPi::IsCompatible ( const AEAudioFormat format,
const std::string &  device 
)
virtual

◆ Register()

void CAESinkPi::Register ( )
static

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