SignalUtils.PeekCircularBuffer Method

function PeekCircularBuffer(const State: TCircularBufferState): Integer;

Get the number of available samples within the circular buffer.

#NameTypeDescription
1StateTCircularBufferState

Returns: Int32

Remarks:

Returns number of available samples, that can be read by ReadFromCircularBuffer. This function allows you to guard against buffer underflow. (reading data that is not there yet)

See Also: SignalUtils.InitCircularBuffer, SignalUtils.WriteToCircularBuffer, SignalUtils.ResizeCircularBuffer, SignalUtils.MonitorCircularBuffer