CLAM::AudioDeviceList Class Reference

This abstract class allows you to retrieve a list of all available devices (strings) for a certain architecture. More...

#include <AudioDeviceList.hxx>

List of all members.

Public Member Functions

 AudioDeviceList (const std::string &arch)
 Constructor of the AudioDeviceList class, with a string as parameter that contains the name of the concrete architecture by this list.
virtual ~AudioDeviceList ()
 Destructor of the class.
const std::string & ArchName ()
 Getter to obtain the name of the architecture related to this AudioDeviceList.
const std::vector< std::string > & AvailableDevices (void)
 This method is useful to obtain a complete list of the devices available.
virtual std::string DefaultDevice (void)=0
 Pure virtual function that the concrete AudioDeviceList class implements to get the name of the default device.
virtual AudioDeviceCreate (const std::string &name, const std::string &device)=0
 Pure virtual function that the concrete AudioDeviceList class implements to create a concrete AudioDevice.

Protected Member Functions

void AddMe (void)

Protected Attributes

std::vector< std::string > mAvailableDevices

Detailed Description

This abstract class allows you to retrieve a list of all available devices (strings) for a certain architecture.

An singleton instance of each concrete AudioDevice class for a specific architecture must be created, that fills the list mAvailableDevices on construction. The AudioManager verifies the existence of lists for the possible architectures

To retrieve a list of all AudioDeviceList's available, call AudioManager::FindList

See also:
AudioDevice, AudioManager

Definition at line 41 of file AudioDeviceList.hxx.


Constructor & Destructor Documentation

AudioDeviceList::AudioDeviceList ( const std::string &  arch  ) 

Constructor of the AudioDeviceList class, with a string as parameter that contains the name of the concrete architecture by this list.

Parameters:
arch The name of architecture (i.e. ALSA)

Definition at line 28 of file AudioDeviceList.cxx.

AudioDeviceList::~AudioDeviceList (  )  [virtual]

Destructor of the class.

Definition at line 33 of file AudioDeviceList.cxx.


Member Function Documentation

void AudioDeviceList::AddMe ( void   )  [protected]

Definition at line 37 of file AudioDeviceList.cxx.

const std::string& CLAM::AudioDeviceList::ArchName (  )  [inline]

Getter to obtain the name of the architecture related to this AudioDeviceList.

Definition at line 61 of file AudioDeviceList.hxx.

const std::vector<std::string>& CLAM::AudioDeviceList::AvailableDevices ( void   )  [inline]

This method is useful to obtain a complete list of the devices available.

This list is created with information of operating system, sound architecture, etc.

Returns:
A list of strings containing the names of the Devices

Definition at line 66 of file AudioDeviceList.hxx.

References mAvailableDevices.

Referenced by CLAM::AudioManager::FindOrCreateDevice().

virtual AudioDevice* CLAM::AudioDeviceList::Create ( const std::string &  name,
const std::string &  device 
) [pure virtual]

Pure virtual function that the concrete AudioDeviceList class implements to create a concrete AudioDevice.

Implemented in CLAM::RtAAudioDeviceList.

Referenced by CLAM::AudioManager::FindOrCreateDevice().

virtual std::string CLAM::AudioDeviceList::DefaultDevice ( void   )  [pure virtual]

Pure virtual function that the concrete AudioDeviceList class implements to get the name of the default device.

Implemented in CLAM::RtAAudioDeviceList.

Referenced by CLAM::AudioManager::FindOrCreateDevice().


Member Data Documentation

std::vector<std::string> CLAM::AudioDeviceList::mAvailableDevices [protected]

Definition at line 46 of file AudioDeviceList.hxx.

Referenced by AvailableDevices().


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3