Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CAESinkPULSE Class Reference

#include <AESinkPULSE.h>

Inheritance diagram for CAESinkPULSE:
IAESink

Public Member Functions

const char * GetName () override
 
 CAESinkPULSE ()
 
 ~CAESinkPULSE () override
 
bool Initialize (AEAudioFormat &format, std::string &device) override
 
void Deinitialize () override
 
virtual double GetDelay ()
 
void GetDelay (AEDelayStatus &status) override
 Return a timestamped status structure with delay and sink info. More...
 
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. More...
 
void Drain () override
 
bool HasVolume () override
 
void SetVolume (float volume) override
 
bool IsInitialized ()
 
void UpdateInternalVolume (const pa_cvolume *nVol)
 
pa_stream * GetInternalStream ()
 
- 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...
 

Static Public Member Functions

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

Public Attributes

CCriticalSection m_sec
 

Constructor & Destructor Documentation

§ CAESinkPULSE()

CAESinkPULSE::CAESinkPULSE ( )

§ ~CAESinkPULSE()

CAESinkPULSE::~CAESinkPULSE ( )
override

Member Function Documentation

§ AddPackets()

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

§ Create()

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

§ Deinitialize()

void CAESinkPULSE::Deinitialize ( )
overridevirtual

Implements IAESink.

§ Drain()

void CAESinkPULSE::Drain ( )
overridevirtual

Reimplemented from IAESink.

§ EnumerateDevicesEx()

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

§ GetCacheTotal()

double CAESinkPULSE::GetCacheTotal ( )
overridevirtual

Implements IAESink.

§ GetDelay() [1/2]

virtual double CAESinkPULSE::GetDelay ( )
inlinevirtual

§ GetDelay() [2/2]

void CAESinkPULSE::GetDelay ( AEDelayStatus &  status)
overridevirtual

Return a timestamped status structure with delay and sink info.

Parameters
statusstructure filled with sink status

Implements IAESink.

§ GetInternalStream()

pa_stream * CAESinkPULSE::GetInternalStream ( )

§ GetName()

const char* CAESinkPULSE::GetName ( )
inlineoverridevirtual

Implements IAESink.

§ HasVolume()

bool CAESinkPULSE::HasVolume ( )
inlineoverridevirtual

Reimplemented from IAESink.

§ Initialize()

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

Implements IAESink.

§ IsInitialized()

bool CAESinkPULSE::IsInitialized ( )

§ Register()

bool CAESinkPULSE::Register ( )
static

§ SetVolume()

void CAESinkPULSE::SetVolume ( float  volume)
overridevirtual

Reimplemented from IAESink.

§ UpdateInternalVolume()

void CAESinkPULSE::UpdateInternalVolume ( const pa_cvolume *  nVol)

Member Data Documentation

§ m_sec

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