Async::AudioDeviceFactory Class Reference

A factory class for audio devices. More...

#include <AsyncAudioDeviceFactory.h>

Public Types
typedef AudioDevice *(*	CreatorFunc) (const std::string &dev_designator)

Public Member Functions
	~AudioDeviceFactory (void)
	Destructor.
bool	registerCreator (const std::string &name, CreatorFunc creator)
	Register a new audio device type.
AudioDevice *	create (const std::string &name, const std::string &dev_name)
	Create a new instance of the specified audio device type.
std::string	validDevTypes (void) const
	List valid device types.

Static Public Member Functions
static AudioDeviceFactory &	instance (void)
	Get the factory singleton instance.

Protected Member Functions
	AudioDeviceFactory (void)
	Default constuctor.

Detailed Description

A factory class for audio devices.

Author

Tobias Blomberg / SM0SVX

Date

2009-12-26

This class is a factory class for creating audio devices. Use the REGISTER_AUDIO_DEVICE_TYPE macro to register a new audio device type. New audio device instances are created using the create method.

Definition at line 128 of file AsyncAudioDeviceFactory.h.

Member Typedef Documentation

CreatorFunc

typedef AudioDevice *(* Async::AudioDeviceFactory::CreatorFunc) (const std::string &dev_designator)

Definition at line 131 of file AsyncAudioDeviceFactory.h.

Constructor & Destructor Documentation

~AudioDeviceFactory()

Async::AudioDeviceFactory::~AudioDeviceFactory

(

void

)

Destructor.

AudioDeviceFactory()

Async::AudioDeviceFactory::AudioDeviceFactory ( void )

protected

Default constuctor.

References AudioDeviceFactory().

Referenced by AudioDeviceFactory(), and instance().

Member Function Documentation

create()

AudioDevice * Async::AudioDeviceFactory::create	(	const std::string &	name,
		const std::string &	dev_name )

Create a new instance of the specified audio device type.

Parameters

name	The audio device type (e.g. alsa, oss etc)
dev_name	The audio device name (e.g. plughw:0, /dev/dsp etc)

Returns

Returns an AudioDevice object

instance()

AudioDeviceFactory & Async::AudioDeviceFactory::instance ( void )

inlinestatic

Get the factory singleton instance.

Returns

Returns the factory instance

Definition at line 137 of file AsyncAudioDeviceFactory.h.

References AudioDeviceFactory().

registerCreator()

bool Async::AudioDeviceFactory::registerCreator	(	const std::string &	name,
		CreatorFunc	creator )

Register a new audio device type.

Parameters

name	The name of the audio device type (e.g. alsa, oss etc)
creator	A function that create the AudioDevice object

Returns

Return true on success or else false

validDevTypes()

std::string Async::AudioDeviceFactory::validDevTypes

(

void

)

const

List valid device types.

Returns

Returns a space separated list of valid device type names

---

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

• AsyncAudioDeviceFactory.h