Gizmod::AlsaMixer Class Reference

Data structure that holds information about each Mixer. More...

#include <AlsaMixer.hpp>

Inheritance diagram for Gizmod::AlsaMixer:

Inheritance graph
[legend]
Collaboration diagram for Gizmod::AlsaMixer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

std::string getName () const
 Get the unique name of the mixer.
std::string getNameShort () const
 Get the short name of the mixer (not unique).
bool setSwitchCapture (bool Enable)
 Set the capture switch.
bool setSwitchPlayback (bool Enable)
 Set the playback switch.
bool setVolumeCapture (long Volume)
 Set the Capture volume.
bool setVolumeCapturePercent (float Percent)
 Set the Capture volume as a percent.
bool setVolumePlayback (long Volume)
 Set the playback volume.
bool setVolumePlaybackPercent (float Percent)
 Set the playback volume as a percent.
int signalMixerEvent ()
 Signal a manual mixer event.
 AlsaMixer ()
 AlsaMixer Default Constructor.
 AlsaMixer (AlsaSoundCardInterface *piSoundCard, snd_mixer_elem_t *MixerElement, std::string MixerName, std::string MixerNameUnique, unsigned int MixerID)
 AlsaMixer Default Constructor.
virtual ~AlsaMixer ()
 AlsaMixer Destructor.

Static Public Member Functions

static int MixerElemCallback (snd_mixer_elem_t *MixerElement, unsigned int EventMask)
 Static mixer element callback.

Friends

class boost::serialization::access

Detailed Description

Data structure that holds information about each Mixer.


Member Function Documentation

std::string AlsaMixer::getName (  )  const

Get the unique name of the mixer.

Returns:
Unique mixer name

std::string AlsaMixer::getNameShort (  )  const

Get the short name of the mixer (not unique).

Returns:
Mixer name

int AlsaMixer::MixerElemCallback ( snd_mixer_elem_t *  MixerElement,
unsigned int  EventMask 
) [static]

Static mixer element callback.

Parameters:
MixerElement Mixer element handle
EventMask event mask
Returns:
0 on success otherwise a negative error code
Just pass off the event to the appropriate AlsaSoundCard instantiation

bool AlsaMixer::setSwitchCapture ( bool  Enable  ) 

Set the capture switch.

Parameters:
Enable Set to true if the switch should be enabled
Returns:
True on success

bool AlsaMixer::setSwitchPlayback ( bool  Enable  ) 

Set the playback switch.

Parameters:
Enable Set to true if the switch should be enabled
Returns:
True on success

bool AlsaMixer::setVolumeCapture ( long  Volume  ) 

Set the Capture volume.

Parameters:
Volume Absolute volume level
Returns:
True on success

bool AlsaMixer::setVolumeCapturePercent ( float  Percent  ) 

Set the Capture volume as a percent.

Parameters:
Percent Volume level percentage
Returns:
True on success

bool AlsaMixer::setVolumePlayback ( long  Volume  ) 

Set the playback volume.

Parameters:
Volume Absolute volume level
Returns:
True on success

bool AlsaMixer::setVolumePlaybackPercent ( float  Percent  ) 

Set the playback volume as a percent.

Parameters:
Percent Volume level percentage
Returns:
True on success

int AlsaMixer::signalMixerEvent (  )  [virtual]

Signal a manual mixer event.

Returns:
0 on success otherwise a negative error code
Handle a manual mixer element event

Implements Gizmod::AlsaMixerInterface.


The documentation for this class was generated from the following files:
Generated on Wed Jun 27 12:43:37 2007 for gizmod by  doxygen 1.4.7