aflibbufferutils.3

来自「一个共享源码的音频库5(doc 文档)」· 3 代码 · 共 75 行

.TH "aflibBufferUtils" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibBufferUtils \- Class that implements a buffer for devices that need one. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibBufferUtils.h>\fP
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibBufferUtils\fP ()"
.br
.ti -1c
.RI "\fB~aflibBufferUtils\fP ()"
.br
.ti -1c
.RI "bool \fBinit\fP (int buf_size)"
.br
.RI "\fIInitializes the buffer class.\fP"
.ti -1c
.RI "int \fBgetBufferSize\fP () const"
.br
.RI "\fIGets the total size of the buffer.\fP"
.ti -1c
.RI "int \fBbytes_available\fP ()"
.br
.RI "\fIGets the number bytes available to read from the buffer.\fP"
.ti -1c
.RI "void \fBwrite\fP (unsigned char *buf, int num_bytes)"
.br
.ti -1c
.RI "void \fBread\fP (unsigned char *buf, int num_bytes)"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Class that implements a buffer for devices that need one.
.PP
Some audio devices do not provide buffering for audio data. The Solaris audio device in record mode is one. For record mode one must read data in blocks exactly. If the user requests a size different than the audio device block size then we must read the audio device block size and buffer the data and return the requested size from the buffer. This class provides this buffer. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibBufferUtils::aflibBufferUtils ()"
.PP
.SS "aflibBufferUtils::~aflibBufferUtils ()"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "int aflibBufferUtils::bytes_available ()\fC [inline]\fP"
.PP
Gets the number bytes available to read from the buffer.
.PP
.SS "int aflibBufferUtils::getBufferSize () const\fC [inline]\fP"
.PP
Gets the total size of the buffer.
.PP
.SS "bool aflibBufferUtils::init (int buf_size)"
.PP
Initializes the buffer class.
.PP
This will initialize the buffer class with a size of buf_size. Subsequent calls to this function will free any previous memory allocated with a call to init. 
.SS "void aflibBufferUtils::read (unsigned char * buf, int num_bytes)"
.PP
.SS "void aflibBufferUtils::write (unsigned char * buf, int num_bytes)"
.PP


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