Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CAESinkALSA Class Reference

#include <AESinkALSA.h>

Inheritance diagram for CAESinkALSA:
IAESink

Public Member Functions

const char * GetName () override
 
 CAESinkALSA ()
 
 ~CAESinkALSA () override
 
bool Initialize (AEAudioFormat &format, std::string &device) override
 
void Deinitialize () override
 
virtual void Stop ()
 
void GetDelay (AEDelayStatus &status) override
 Return a timestamped status structure with delay and sink info.
 
double GetCacheTotal () 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 double GetLatency ()
 
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< IAESinkCreate (std::string &device, AEAudioFormat &desiredFormat)
 
static void EnumerateDevicesEx (AEDeviceInfoList &list, bool force=false)
 
static void Cleanup ()
 

Constructor & Destructor Documentation

◆ CAESinkALSA()

CAESinkALSA::CAESinkALSA ( )

◆ ~CAESinkALSA()

CAESinkALSA::~CAESinkALSA ( )
override

Member Function Documentation

◆ AddPackets()

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

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.

◆ Cleanup()

void CAESinkALSA::Cleanup ( )
static

◆ Create()

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

◆ Deinitialize()

void CAESinkALSA::Deinitialize ( )
overridevirtual

Implements IAESink.

◆ Drain()

void CAESinkALSA::Drain ( )
overridevirtual

Reimplemented from IAESink.

◆ EnumerateDevicesEx()

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

◆ GetCacheTotal()

double CAESinkALSA::GetCacheTotal ( )
overridevirtual

Implements IAESink.

◆ GetDelay()

void CAESinkALSA::GetDelay ( AEDelayStatus & status)
overridevirtual

Return a timestamped status structure with delay and sink info.

Parameters
statusstructure filled with sink status

Implements IAESink.

◆ GetName()

const char * CAESinkALSA::GetName ( )
inlineoverridevirtual

Implements IAESink.

◆ Initialize()

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

Implements IAESink.

◆ Register()

void CAESinkALSA::Register ( )
static

◆ Stop()

void CAESinkALSA::Stop ( )
virtual

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