Class RingBuffer¶
Note
Construct via the Class AniraWeb factory in most cases:
aniraWeb.RingBuffer(...) rather than new RingBuffer(...). The
factory threads the WASM instance through for you.
- class RingBuffer(wasmInstance)¶
TypeScript wrapper for anira::RingBuffer Thread-safe C API wrapper
- Extends:
BaseWrapper
- Arguments:
wasmInstance (AniraWasmInstance)
- clearWithPositions()¶
- destroy()¶
Free the underlying C++ object. See Lifecycle and Cleanup for when to call this.
- getAvailablePastSamples(channel)¶
Mirrors
anira::RingBuffer::get_available_past_samples().- Arguments:
channel (number)
- Returns:
number
- getAvailableSamples(channel)¶
Mirrors
anira::RingBuffer::get_available_samples().- Arguments:
channel (number)
- Returns:
number
- getFutureSample(channel, offset)¶
Mirrors
anira::RingBuffer::get_future_sample().- Arguments:
channel (number)
offset (number)
- Returns:
number
- getPastSample(channel, offset)¶
Mirrors
anira::RingBuffer::get_past_sample().- Arguments:
channel (number)
offset (number)
- Returns:
number
- initializeWithPositions(numChannels, numSamples)¶
Mirrors
anira::RingBuffer::initialize_with_positions().- Arguments:
numChannels (number)
numSamples (number)
- popSample(channel)¶
Mirrors
anira::RingBuffer::pop_sample().- Arguments:
channel (number)
- Returns:
number
- pushSample(channel, sample)¶
Mirrors
anira::RingBuffer::push_sample().- Arguments:
channel (number)
sample (number)