Configuration of the AudioIn and AudioOut classes. More...

#include <AudioIO.hxx>

Public Member Functions
	DYNAMIC_TYPE_USING_INTERFACE (AudioIOConfig, 4, ProcessingConfig)
	DYN_ATTRIBUTE (0, public, std::string, Device)
	The Device that will be used by this AudioIn or AudioOut instantiation, if it is not indicated, or its value is "default:default", system will choose the best device for this object.
	DYN_ATTRIBUTE (1, public, int, ChannelID)
	Channel attached to object; in case of stereo configuration 0 will be left channel and 1 right channel.
	DYN_ATTRIBUTE (2, public, int, FrameSize)
	FrameSize of the AudioIn or AudioOut audio port.
	DYN_ATTRIBUTE (3, public, int, SampleRate)
	Sample Rate of the AudioIn or AudioOut class.
Public Member Functions inherited from CLAM::ProcessingConfig
	ProcessingConfig (const int n)
	Constructor.
	ProcessingConfig (const ProcessingConfig &prototype, bool shareData=false, bool deep=true)
	Copy constructor.
virtual	~ProcessingConfig ()
virtual const char *	GetClassName () const
	Return the class name.
Public Member Functions inherited from CLAM::DynamicType
	DynamicType (const int nAttr)
	Constructs a DynamicType object that can hold.
	DynamicType (const DynamicType &prototype, const bool shareData, const bool deepCopy)
	Copy constructor of a dynamic Type.
	DynamicType (const DynamicType &prototype)
virtual	~DynamicType ()
void	CopyInit (const DynamicType &dt)
	This method allows custom code for the copy-constructor of a dynamic type, since the copy-constructor is macro expanded and can not be overwritted.
bool	UpdateData ()
	Method used to resize the data space of the dynamic type, necessary when some AddXXX() / RemoveXXX() (where XXX is an attribute name) has been done.
unsigned	GetNDynamicAttributes () const
const char *	GetDynamicAttributeName (unsigned i)
virtual const std::type_info &	GetTypeId (unsigned i) const =0
bool	AttributeIsComponent (unsigned i) const
bool	AttributeIsDynamictype (unsigned i) const
bool	IsAttributeInstantiated (unsigned i) const
const void *	GetAttributeAsVoidPtr (unsigned i) const
const Component *	GetAttributeAsComponent (unsigned i) const
Component *	GetAttributeAsComponent (unsigned i)
void	FullfilsInvariant () const
virtual Component *	DeepCopy () const
void	Debug () const
virtual void	StoreOn (CLAM::Storage &storage) const
	Stores component's subitems on the given Storage.
virtual void	LoadFrom (CLAM::Storage &storage)
	Loads component's subitems from the given Storage.
Public Member Functions inherited from CLAM::Component
virtual	~Component ()

Protected Member Functions
void	DefaultInit (void)
	The concrete dynamic type constructor calls DefaultInit().

Detailed Description

Configuration of the AudioIn and AudioOut classes.

You can specify a device (string), which will be used by the AudioManager, when creating the AudioDevice objects. When you don't specify a concrete device, or specify "default", the AudioManager will choose the default device for your setup. For multichannel Audio, you need to configure each in/out with it's own channel id, typically 0 for left, and 1 for right.

See also:: AudioIn, AudioOut, AudioDevice, AudioManager, ProcessingConfig

Definition at line 50 of file AudioIO.hxx.

Member Function Documentation

void CLAM::AudioIOConfig::DefaultInit ( void )

inlineprotected

The concrete dynamic type constructor calls DefaultInit().

This allows user to initialize his/her object. But we define DefaultInit() here because we don't want to force writting one DefaultInit() function for each concrete dynamic type. If a dynamic type concrete class defines some (not-default) constructors, this should also call the DefaultInit().

See also:: CopyInit()

Reimplemented from CLAM::DynamicType.

Definition at line 63 of file AudioIO.hxx.

References CLAM::DynamicType::UpdateData().

CLAM::AudioIOConfig::DYN_ATTRIBUTE	(	0	,
		public	,
		std::string	,
		Device
	)

The Device that will be used by this AudioIn or AudioOut instantiation, if it is not indicated, or its value is "default:default", system will choose the best device for this object.

CLAM::AudioIOConfig::DYN_ATTRIBUTE	(	1	,
		public	,
		int	,
		ChannelID
	)

Channel attached to object; in case of stereo configuration 0 will be left channel and 1 right channel.

CLAM::AudioIOConfig::DYN_ATTRIBUTE	(	2	,
		public	,
		int	,
		FrameSize
	)

FrameSize of the AudioIn or AudioOut audio port.

CLAM::AudioIOConfig::DYN_ATTRIBUTE	(	3	,
		public	,
		int	,
		SampleRate
	)

Sample Rate of the AudioIn or AudioOut class.

CLAM::AudioIOConfig::DYNAMIC_TYPE_USING_INTERFACE	(	AudioIOConfig	,
		4	,
		ProcessingConfig
	)

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

AudioIO.hxx

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation