aflibaudiomemoryinput.3

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

.TH "aflibAudioMemoryInput" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioMemoryInput \- Provides ability to insert raw audio data into audio chain. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibAudioMemoryInput.h>\fP
.PP
Inherits \fBaflibAudio\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibAudioMemoryInput\fP (const \fBaflibConfig\fP &config)"
.br
.RI "\fIConstructor - Default constructor.\fP"
.ti -1c
.RI "\fB~aflibAudioMemoryInput\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "void \fBsetAudioMemoryInputCallback\fP (\fBsamples_callback\fP func_ptr)"
.br
.RI "\fIEnables and disables the memory input callback.\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 
Provides ability to insert raw audio data into audio chain.
.PP
This class allows one to insert raw data into an audio chain at the start of the chain. This class can't be used anywhere in a chain other than at the start. Once an audio chain is formed then the caller can call the process member function of the last item in the chain and retrieve the \fBaflibData\fP object to get the raw audio data out of the chain.  Users will call the process member function at the end of an audio chain. This will result in data being requested down the chain until this class is reached. Then the samples_callback will be called requesting audio data from the user. Users of this class should call the setAudioMemoryInputCallback function to register a callback function that will provide data to the chain. This callback function shall have 5 parameters and shall return the actual number of data stored. Since this object is at the beginning of the audio chain then in order for data to be inserted into the chain the caller must register a callback function before calling the process member function of the chain. The 5 parameters are: 
.br
 \fBaflibAudio\fP * - the aflibAudioMemoryInput object that is making this call. 
.br
 void * - pointer to the audio data memory location. 
.br
 long - number of samples to read. 
.br
 long - total length of samples (ie samples above * size of each sample). 
.br
 long long - position in data stream that is requested. 
.br

.PP
The last parameter is the position of the data to read from. The user can request to start reading anywhere they wish. Thus they can start 10000 samples from the beginning of the audio data. If the user is streaming data then the library will make every attempt to request data sequentially from this class, but this is not guaranteed. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibAudioMemoryInput::aflibAudioMemoryInput (const \fBaflibConfig\fP & config)"
.PP
Constructor - Default constructor.
.PP
.SS "aflibAudioMemoryInput::~aflibAudioMemoryInput ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibAudioMemoryInput::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* aflibAudioMemoryInput::getName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "void aflibAudioMemoryInput::setAudioMemoryInputCallback (\fBsamples_callback\fP func_ptr)"
.PP
Enables and disables the memory input callback.
.PP
This function enables or disables the memory input callback. The callback registered must accept 5 parameters. The first is a pointer to this \fBaflibAudio\fP object. This allows the caller to know which object is generating this callback. This is so that if people have multiple objects all registering the same callback. The next parameter is the pointer to the memory location to store the data in. The next is the number of elements requested to be stored into the pointer. The next is the total number of bytes to store. The last parameter is the position of the audio data that is requested. 

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