CLAM::AudioIOConfig Class Reference

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

#include <AudioIO.hxx>

List of all members.

Public Member Functions
	AudioIOConfig ()
	AudioIOConfig (const AudioIOConfig &prototype, const bool shareData=false, const bool deep=true)
	__COMMON_DYNAMIC_TYPE (AudioIOConfig, 4)
	__COMMON_DYN_ATTRIBUTE (0, public, std::string, Device) protected
	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.
bool	LoadDevice (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (1, public, int, ChannelID) protected
	Channel attached to object; in case of stereo configuration 0 will be left channel and 1 right channel.
bool	LoadChannelID (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (2, public, int, FrameSize) protected
	FrameSize of the AudioIn or AudioOut audio port.
bool	LoadFrameSize (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (3, public, int, SampleRate) protected
	Sample Rate of the AudioIn or AudioOut class.
bool	LoadSampleRate (CLAM::Storage &s)
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.

---

Constructor & Destructor Documentation

CLAM::AudioIOConfig::AudioIOConfig

(

)

[inline]

Definition at line 53 of file AudioIO.hxx.

CLAM::AudioIOConfig::AudioIOConfig	(	const AudioIOConfig &	prototype,
		const bool	shareData = false,
		const bool	deep = true
	)			[inline]

Definition at line 53 of file AudioIO.hxx.

---

Member Function Documentation

CLAM::AudioIOConfig::__COMMON_DYN_ATTRIBUTE	(	3	,
		public	,
		int	,
		SampleRate
	)			[inline]

Sample Rate of the AudioIn or AudioOut class.

Definition at line 61 of file AudioIO.hxx.

CLAM::AudioIOConfig::__COMMON_DYN_ATTRIBUTE	(	2	,
		public	,
		int	,
		FrameSize
	)			[inline]

FrameSize of the AudioIn or AudioOut audio port.

Definition at line 59 of file AudioIO.hxx.

CLAM::AudioIOConfig::__COMMON_DYN_ATTRIBUTE	(	1	,
		public	,
		int	,
		ChannelID
	)			[inline]

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

Definition at line 57 of file AudioIO.hxx.

CLAM::AudioIOConfig::__COMMON_DYN_ATTRIBUTE	(	0	,
		public	,
		std::string	,
		Device
	)			[inline]

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.

Definition at line 55 of file AudioIO.hxx.

CLAM::AudioIOConfig::__COMMON_DYNAMIC_TYPE	(	AudioIOConfig	,
		4
	)

void CLAM::AudioIOConfig::DefaultInit

(

void

)

[inline, protected]

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().

bool CLAM::AudioIOConfig::LoadChannelID

(

CLAM::Storage &

s

)

[inline]

Definition at line 57 of file AudioIO.hxx.

bool CLAM::AudioIOConfig::LoadDevice

(

CLAM::Storage &

s

)

[inline]

Definition at line 55 of file AudioIO.hxx.

bool CLAM::AudioIOConfig::LoadFrameSize

(

CLAM::Storage &

s

)

[inline]

Definition at line 59 of file AudioIO.hxx.

bool CLAM::AudioIOConfig::LoadSampleRate

(

CLAM::Storage &

s

)

[inline]

Definition at line 61 of file AudioIO.hxx.

---

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

• AudioIO.hxx