CLAM::AudioIOConfig Class Reference

#include <AudioIO.hxx>

Inheritance diagram for CLAM::AudioIOConfig:

CLAM::ProcessingConfig CLAM::DynamicType CLAM::Component

List of all members.


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.


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.

Protected Member Functions

void DefaultInit (void)
 The concrete dynamic type constructor calls DefaultInit().

Member Function Documentation

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

CLAM::AudioIOConfig::DYN_ATTRIBUTE ( ,
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 ( ,
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 ( ,
public  ,
int  ,
FrameSize   
)

FrameSize of the AudioIn or AudioOut audio port.

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

Sample Rate of the AudioIn or AudioOut class.

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


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

Generated on Tue Aug 12 22:33:48 2008 for CLAM by  doxygen 1.5.5