FMAR.Audio.MicrophoneCapturer.CircularBuffer< T > Class Template Reference

Circular buffer data structure for storing audio samples. More...

Public Member Functions
	CircularBuffer (int size)
	Initializes a new instance of the CircularBuffer class with the specified size.
void	Enqueue (T item)
	Enqueues an item into the buffer.
void	EnqueueArray (T[] items)
	Enqueues an array of items into the buffer.
T	Dequeue ()
	Dequeues an item from the buffer.
T[]	DequeueArray (int count)
	Dequeues an array of items from the buffer.
T	Peek ()
	Peeks at the item at the head of the buffer without dequeuing it.
T[]	PeekAll ()
	Peeks at all items in the buffer without dequeuing them.

Properties
int	Count [get]
	Gets the number of items currently in the buffer.

Detailed Description

Circular buffer data structure for storing audio samples.

Template Parameters

T	The type of data to store in the buffer.

Constructor & Destructor Documentation

CircularBuffer()

FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.CircularBuffer ( int size )

inline

Initializes a new instance of the CircularBuffer class with the specified size.

Parameters

size	The size of the buffer.

Member Function Documentation

Dequeue()

T FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.Dequeue ( )

inline

Dequeues an item from the buffer.

Returns

The dequeued item.

Exceptions

InvalidOperationException

Thrown when the buffer is empty.

DequeueArray()

T[] FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.DequeueArray ( int count )

inline

Dequeues an array of items from the buffer.

Parameters

count

The number of items to dequeue.

Returns

An array of dequeued items.

Exceptions

InvalidOperationException

Thrown when the buffer does not contain enough items.

Enqueue()

void FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.Enqueue ( T item )

inline

Enqueues an item into the buffer.

Parameters

item	The item to enqueue.

EnqueueArray()

void FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.EnqueueArray ( T[] items )

inline

Enqueues an array of items into the buffer.

Parameters

items

The array of items to enqueue.

Exceptions

InvalidOperationException

Thrown when the input array is too large to fit in the buffer.

Peek()

T FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.Peek ( )

inline

Peeks at the item at the head of the buffer without dequeuing it.

Returns

The item at the head of the buffer.

Exceptions

InvalidOperationException

Thrown when the buffer is empty.

PeekAll()

T[] FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.PeekAll ( )

inline

Peeks at all items in the buffer without dequeuing them.

Returns

An array of all items in the buffer.

Property Documentation

Count

int FMAR.Audio.MicrophoneCapturer.CircularBuffer< T >.Count

get

Gets the number of items currently in the buffer.

---

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

• /github/workspace/Packages/FMAR/Audio/Runtime/Scripts/MicrophoneCapturer.cs