csl::RingBufferTap Class Reference

#include <RingBuffer.h>

Inheritance diagram for csl::RingBufferTap:

List of all members.

---

Detailed Description

RingBufferTap is a reader that loops over a buffer

Public Member Functions
	RingBufferTap (RingBuffer *parent, int offset=0)
	Create a tap on a ring buffer, optionally offset relative to the current write position.
unsigned	duration () const
unsigned	seekTo (int position, SeekPosition whence) throw (CException)
void	setLoopStart (unsigned frame)
void	setLoopEnd (unsigned frame)
void	nextBuffer (Buffer &outputBuffer) throw (CException)
	nextBuffer method
void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
void	destructiveNextBuffer (Buffer &outputBuffer) throw (CException)
	Same as the next buffer but zeroing as it goes.
void	destructiveNextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
Public Attributes
unsigned	mLoopStartFrame
	Number of frames from the beginning to start a loop at.
unsigned	mLoopEndFrame
	Number of frames away from buffer end.
Protected Member Functions
void	setOffset (int offset)
Protected Attributes
unsigned	mTempCurrentFrame
RingBuffer *	mParentBuffer
Friends
class	RingBuffer
	Allow RingBuffer to access private members of RingBufferTap.

---

Constructor & Destructor Documentation

RingBufferTap::RingBufferTap (  RingBuffer *  parent, int  offset = 0 )

Create a tap on a ring buffer, optionally offset relative to the current write position.

---

Member Function Documentation

unsigned RingBufferTap::duration (   )  const

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

void csl::RingBufferTap::setLoopStart (  unsigned  frame  )  [inline]

void csl::RingBufferTap::setLoopEnd (  unsigned  frame  )  [inline]

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

nextBuffer method

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

void RingBufferTap::destructiveNextBuffer (  Buffer &  outputBuffer  )  throw (CException)

Same as the next buffer but zeroing as it goes.

void RingBufferTap::destructiveNextBuffer (  Buffer &  outputBuffer, unsigned  outBufNum )  throw (CException)

void RingBufferTap::setOffset (  int  offset  )  [protected]

---

Friends And Related Function Documentation

friend class RingBuffer [friend]

Allow RingBuffer to access private members of RingBufferTap.

---

Member Data Documentation

unsigned csl::RingBufferTap::mLoopStartFrame

Number of frames from the beginning to start a loop at.

unsigned csl::RingBufferTap::mLoopEndFrame

Number of frames away from buffer end.

unsigned csl::RingBufferTap::mTempCurrentFrame [protected]

RingBuffer* csl::RingBufferTap::mParentBuffer [protected]

---

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

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

---