aflibaudioconstantsrc.3

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

.TH "aflibAudioConstantSrc" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioConstantSrc \- Inserts a constant audio source in a chain for test purposes. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibAudioConstantSrc.h>\fP
.PP
Inherits \fBaflibAudio\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBwaveform_type\fP { \fBWAVEFORM_DCLEVEL\fP, \fBWAVEFORM_TRIANGLE\fP, \fBWAVEFORM_SQUAREWAVE\fP, \fBWAVEFORM_SINEWAVE\fP }"
.br
.in -1c
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibAudioConstantSrc\fP (\fBaflibAudio\fP &audio)"
.br
.RI "\fIConstructor - defaults to a DC level fullscale signal.\fP"
.ti -1c
.RI "\fBaflibAudioConstantSrc\fP ()"
.br
.RI "\fIConstructor - defaults to a DC level fullscale signal.\fP"
.ti -1c
.RI "\fB~aflibAudioConstantSrc\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "void \fBsetWaveformType\fP (\fBaflibAudioConstantSrc::waveform_type\fP wave, double max_amp, double min_amp, int frequency)"
.br
.RI "\fI.TP
Sets the type of waveform to be output.
.PP
\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBcompute_segment\fP (list< \fBaflibData\fP * > &data, long long position=-1)"
.br
.RI "\fIWork function, must be implemented by derived class.\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 
Inserts a constant audio source in a chain for test purposes.
.PP
This class allows one to insert a test signal anywhere in an audio chain. It is mainly used for debugging other audio objects that work on audio  data. When it is inserted in a chain it takes on the characteristics of everything before it in the chain. For instance a parent that is outputting a 22050 sample rate mono signal will cause this object to throw away the data from the parent and instead insert a test signal that is 22050 mono.
.PP
One can select a DC level, triangle wave, square wave, or sine wave. One can also adjust the frequency and amplitude. 
.PP
.SH "MEMBER ENUMERATION DOCUMENTATION"
.PP 
.SS "enum aflibAudioConstantSrc::waveform_type"
.PP
\fBEnumeration values:\fP
.in +1c
.TP
\fB\fI\fIWAVEFORM_DCLEVEL\fP \fP\fP
.TP
\fB\fI\fIWAVEFORM_TRIANGLE\fP \fP\fP
.TP
\fB\fI\fIWAVEFORM_SQUAREWAVE\fP \fP\fP
.TP
\fB\fI\fIWAVEFORM_SINEWAVE\fP \fP\fP

.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibAudioConstantSrc::aflibAudioConstantSrc (\fBaflibAudio\fP & audio)"
.PP
Constructor - defaults to a DC level fullscale signal.
.PP
.SS "aflibAudioConstantSrc::aflibAudioConstantSrc ()"
.PP
Constructor - defaults to a DC level fullscale signal.
.PP
.SS "aflibAudioConstantSrc::~aflibAudioConstantSrc ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibAudioConstantSrc::compute_segment (list< \fBaflibData\fP * > & data, long long position = -1)\fC [virtual]\fP"
.PP
Work function, must be implemented by derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "const char* aflibAudioConstantSrc::getName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "void aflibAudioConstantSrc::setWaveformType (\fBaflibAudioConstantSrc::waveform_type\fP wave, double max_amp, double min_amp, int frequency)"
.PP
.TP
Sets the type of waveform to be output.
.PP
.PP
Allow the user to select the waveform type, amplitude, and frequency. The amplitude will be the peak amplitude of the signal specified in percent. Both a max and min are required. For full scale one would use 100.0 for max and -100.0 for min. For the waveform DC level only max is used and min must be less than or equal to max. The frequency must be in Hz. 

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