ALSA::Software Class Reference

#include <Software.H>

Inheritance diagram for ALSA::Software:

Collaboration diagram for ALSA::Software:

Public Member Functions
	Software (void)
virtual	~Software (void)
int	getSWParams ()
int	setSWParams ()
int	setSWThreshold (snd_pcm_uframes_t thresh)
int	setAvailMin (snd_pcm_uframes_t cnt)
void *	getAddress (const snd_pcm_channel_area_t *areas, snd_pcm_uframes_t offset) const
template<typename SAMPLE_TYPE >
int	getChannelCount (const snd_pcm_channel_area_t *areas) const
int	dumpSWParams ()
Public Member Functions inherited from ALSA::Hardware
int	getHWParams ()
int	fillParams ()
int	resetParams ()
	Hardware ()
virtual	~Hardware ()
void	copyFrom (snd_pcm_hw_params_t *hParamsIn)
int	rateResample (unsigned int state)
int	setAccess (snd_pcm_access_t access)
int	getAccess (void)
int	setFormat (snd_pcm_format_t format)
int	getFormat (snd_pcm_format_t &format)
int	getFormatPhysicalWidth ()
int	setChannels (unsigned int cnt)
int	getChannels ()
int	getMaxChannels ()
int	setSampleRate (unsigned int rrate, int dir=0)
int	getSampleRate (int dir=0)
int	getPeriodSize (snd_pcm_uframes_t *p, int *dir=NULL)
int	getPeriodSize (int *dir=NULL)
int	setPeriodSize (snd_pcm_uframes_t *p, int *dir=0)
int	setBufSize (snd_pcm_uframes_t bufSize)
const char *	formatDescription (const snd_pcm_format_t format) const
const char *	getDeviceName ()
int	dumpHWParams ()
Public Member Functions inherited from ALSA::PCM
	PCM ()
virtual	~PCM ()
virtual snd_pcm_t *	getPCM ()
snd_pcm_t **	getPCMP ()
int	open (const char *device, snd_pcm_stream_t streamType, const int block)
int	close ()
int	drop ()
int	drain ()
int	reset ()
void	enableLog ()
int	logEnabled ()
int	dumpStatus ()
int	dumpPCM ()
int	dumpSetup ()
int	dumpHWSetup ()
int	dumpSWSetup ()
int	start ()
snd_pcm_state_t	getState ()
const char *	getStateName ()
bool	prepared ()
bool	opened ()
bool	isSetup ()
bool	running ()
bool	hasXrun ()
bool	draining ()
bool	paused ()
bool	suspended ()
bool	disconnected ()

Private Attributes
snd_pcm_sw_params_t *	sParams
	PCM software params. More...

Additional Inherited Members
Protected Member Functions inherited from ALSA::Hardware
int	setHWParams ()
Protected Attributes inherited from ALSA::PCM
snd_output_t *	log
	The log stream if enabled. More...
snd_pcm_t *	handle
	PCM handle. More...

Detailed Description

Definition at line 23 of file Software.H.

Constructor & Destructor Documentation

Software()

ALSA::Software::Software ( void  )

inline

Definition at line 27 of file Software.H.

~Software()

virtual ALSA::Software::~Software ( void  )

inlinevirtual

Definition at line 34 of file Software.H.

Member Function Documentation

dumpSWParams()

int ALSA::Software::dumpSWParams ( )

inline

Definition at line 92 of file Software.H.

Here is the call graph for this function:

getAddress()

void* ALSA::Software::getAddress ( const snd_pcm_channel_area_t *  areas, snd_pcm_uframes_t  offset  ) const

inline

Return the address to start reading/writing to give an ALSA areas type

Parameters

areas

The ALSA provided snd_pcm_channel_area_t type

Returns

The pointer to start reading or writing to/from

Definition at line 78 of file Software.H.

getChannelCount()

template<typename SAMPLE_TYPE >

int ALSA::Software::getChannelCount ( const snd_pcm_channel_area_t *  areas ) const

inline

Return the number of channels in an ALSA provided areas type

Parameters

areas

The ALSA provided snd_pcm_channel_area_t type

Template Parameters

SAMPLE_TYPE

The type of the samples to derive the channel count for

Returns

The number of channels

Definition at line 88 of file Software.H.

getSWParams()

int ALSA::Software::getSWParams ( )

inline

Get the software params

Returns

>= 0 on success

Definition at line 43 of file Software.H.

Here is the call graph for this function:

Here is the caller graph for this function:

setAvailMin()

int ALSA::Software::setAvailMin ( snd_pcm_uframes_t  cnt )

inline

Set avail min inside a software configuration container

Parameters

cnt	Minimum avail frames to consider PCM ready

Returns

>= 0 on success

Definition at line 69 of file Software.H.

Here is the call graph for this function:

Here is the caller graph for this function:

setSWParams()

int ALSA::Software::setSWParams ( )

inline

Set the software params

Returns

>= 0 on success

Definition at line 51 of file Software.H.

Here is the call graph for this function:

Here is the caller graph for this function:

setSWThreshold()

int ALSA::Software::setSWThreshold ( snd_pcm_uframes_t  thresh )

inline

Set the start threshold

Parameters

thresh

Start threshold in frames

Returns

>= 0 on success

Definition at line 60 of file Software.H.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

sParams

snd_pcm_sw_params_t* ALSA::Software::sParams

private

PCM software params.

Definition at line 24 of file Software.H.

---

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

• /tmp/gtkiostream/include/ALSA/Software.H