.TH "aflibAudioStereoToMono" 3 "16 Jan 2007" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioStereoToMono \- Implements mixing a stereo or mono signal to a mono signal.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <aflibAudioStereoToMono.h>\fP
.PP
Inherits \fBaflibAudioMixer\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBaflib_mix_type\fP { \fBAFLIB_MIX_UNDEF\fP, \fBAFLIB_MIX_BOTH\fP, \fBAFLIB_MIX_CHAN1\fP, \fBAFLIB_MIX_CHAN2\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBaflibAudioStereoToMono\fP (\fBaflibAudio\fP &audio, aflibAudioStereoToMono::aflib_mix_type mix=AFLIB_MIX_BOTH, int amplitude=100)"
.br
.RI "\fIConstructor for type of mixing operation. \fP"
.ti -1c
.RI "\fB~aflibAudioStereoToMono\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBsetMixType\fP (aflibAudioStereoToMono::aflib_mix_type mix)"
.br
.RI "\fISets the type of mixing to perform. \fP"
.ti -1c
.RI "void \fBsetAmplitude\fP (int amplitude)"
.br
.RI "\fISets the amplitude. \fP"
.ti -1c
.RI "const char * \fBgetName\fP () const "
.br
.RI "\fIReturns the name of the derived class. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Implements mixing a stereo or mono signal to a mono signal. 

This class implements converting a stereo or mono signal into a mono signal. It will output either a mix of both channels 1 and 2 inputs, channel 1, or channel 2.
.PP
This class is a convience class derived from \fBaflibAudioMixer\fP since this is a commonly used operation. It takes either a mono or stereo signal so that the programmer does not need to worry about the source. 
.PP
.SH "Constructor & Destructor Documentation"
.PP 
.SS "aflibAudioStereoToMono::aflibAudioStereoToMono (\fBaflibAudio\fP & audio, aflibAudioStereoToMono::aflib_mix_type mix = \fCAFLIB_MIX_BOTH\fP, int amplitude = \fC100\fP)"
.PP
Constructor for type of mixing operation. 
.PP
This constructor allows one to mix any input to a mono signal. It will mix both channels (aflibAudioStereoToMono::AFLIB_MIX_BOTH), or channel 1 (aflibAudioStereoToMono::AFLIB_MIX_CHAN1), or channel 2 (aflibAudioStereoToMono::AFLIB_MIX_CHAN2). 
.SH "Member Function Documentation"
.PP 
.SS "void aflibAudioStereoToMono::setAmplitude (int amplitude)"
.PP
Sets the amplitude. 
.PP
This function allows one to change the amplitude. values between 1 and 100 are supported. 
.SS "void aflibAudioStereoToMono::setMixType (aflibAudioStereoToMono::aflib_mix_type mix)"
.PP
Sets the type of mixing to perform. 
.PP
This function allows one to change the type of mixing performed.
.PP
One can select both channels (aflibAudioStereoToMono::AFLIB_MIX_BOTH), or channel 1 (aflibAudioStereoToMono::AFLIB_MIX_CHAN1), or channel 2 (aflibAudioStereoToMono::AFLIB_MIX_CHAN2). 

.SH "Author"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.