TCircularBufferState Type

Summary

Type used by circular buffering.

Declaration

TCircularBufferState = record
          ReadPosition: integer;
          BufferSize: integer;
          DataLen: integer;
          BufferOverrun: boolean;
          BufferUnderrun: boolean;
          IncrementStep: TSample;
          end;

Description

Record used to hold the state for circular buffering. WritePosition is the current write position index in the buffer and the ReadPosition is the current read position index. BufferSize is initialized with a call to InitCircularBuffer. BufferOverrun flag is set by WriteToCircularBuffer routine, if unread data is overwritten. BufferUnderrun flag is set by the ReadFromCircularBuffer routine, if the data read was already overwritten before it was read for the first time.

See Also
InitCircularBuffer
WriteToCircularBuffer
ReadFromCircularBuffer