aflibaudiostereotomono.3

一个共享源码的音频库5(doc 文档)

.TH "aflibAudioStereoToMono" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioStereoToMono \- Implements mixing a stereo or mono signal to a mono signal. 
.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 Methods"

.in +1c
.ti -1c
.RI "\fBaflibAudioStereoToMono\fP (\fBaflibAudio\fP &audio, \fBaflibAudioStereoToMono::aflib_mix_type\fP 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 (\fBaflibAudioStereoToMono::aflib_mix_type\fP 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.
.PP
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 "MEMBER ENUMERATION DOCUMENTATION"
.PP 
.SS "enum aflibAudioStereoToMono::aflib_mix_type"
.PP
\fBEnumeration values:\fP
.in +1c
.TP
\fB\fI\fIAFLIB_MIX_UNDEF\fP \fP\fP
.TP
\fB\fI\fIAFLIB_MIX_BOTH\fP \fP\fP
.TP
\fB\fI\fIAFLIB_MIX_CHAN1\fP \fP\fP
.TP
\fB\fI\fIAFLIB_MIX_CHAN2\fP \fP\fP

.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibAudioStereoToMono::aflibAudioStereoToMono (\fBaflibAudio\fP & audio, \fBaflibAudioStereoToMono::aflib_mix_type\fP mix = AFLIB_MIX_BOTH, int amplitude = 100)"
.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 (\fBaflibAudioStereoToMono::AFLIB_MIX_BOTH\fP),  or channel 1 (\fBaflibAudioStereoToMono::AFLIB_MIX_CHAN1\fP),  or channel 2 (\fBaflibAudioStereoToMono::AFLIB_MIX_CHAN2\fP). 
.SS "aflibAudioStereoToMono::~aflibAudioStereoToMono ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "const char* aflibAudioStereoToMono::getName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the derived class.
.PP
Reimplemented from \fBaflibAudioMixer\fP.
.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 (\fBaflibAudioStereoToMono::aflib_mix_type\fP 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 (\fBaflibAudioStereoToMono::AFLIB_MIX_BOTH\fP),  or channel 1 (\fBaflibAudioStereoToMono::AFLIB_MIX_CHAN1\fP),  or channel 2 (\fBaflibAudioStereoToMono::AFLIB_MIX_CHAN2\fP). 

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