csl::BufferStream Class Reference

#include <RingBuffer.h>

Inheritance diagram for csl::BufferStream:

List of all members.

---

Detailed Description

Class to simplify writing into and playing back buffers. Think of this as a simple buffer that has a seek, read and write calls built-in.

Public Member Functions
	BufferStream (Buffer &buffer)
void	nextBuffer (Buffer &outputBuffer) throw (CException)
	Read a buffer from the buffer stream.
void	writeBuffer (Buffer &inputBuffer) throw (CException)
	Write a buffer of data into the ring buffer.
void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
void	writeBuffer (Buffer &inputBuffer, unsigned bufNum) throw (CException)
void	setBuffer (Buffer &buffer)
unsigned	seekTo (int position, SeekPosition whence) throw (CException)
unsigned	duration () const
Protected Attributes
Buffer *	mBuffer
unsigned	mCurrentWriteFrame
unsigned	mTempCurrentFrame
	a little hack necessary to track info
unsigned	mTempCurrentWriteFrame
	a little hack necessary to track info

---

Constructor & Destructor Documentation

csl::BufferStream::BufferStream (  Buffer &  buffer  )  [inline]

---

Member Function Documentation

void BufferStream::nextBuffer (  Buffer &  outputBuffer  )  throw (CException)

Read a buffer from the buffer stream.

void BufferStream::writeBuffer (  Buffer &  inputBuffer  )  throw (CException)

Write a buffer of data into the ring buffer.

void BufferStream::nextBuffer (  Buffer &  outputBuffer, unsigned  outBufNum )  throw (CException)

void BufferStream::writeBuffer (  Buffer &  inputBuffer, unsigned  bufNum )  throw (CException)

void csl::BufferStream::setBuffer (  Buffer &  buffer  )  [inline]

unsigned BufferStream::seekTo (  int  position, SeekPosition  whence )  throw (CException)

unsigned BufferStream::duration (   )  const

---

Member Data Documentation

Buffer* csl::BufferStream::mBuffer [protected]

unsigned csl::BufferStream::mCurrentWriteFrame [protected]

unsigned csl::BufferStream::mTempCurrentFrame [protected]

a little hack necessary to track info

unsigned csl::BufferStream::mTempCurrentWriteFrame [protected]

a little hack necessary to track info

---

The documentation for this class was generated from the following files:

• CSL/Kernel/RingBuffer.h
• CSL/Kernel/RingBuffer.cpp

---