Class BufferF#

Note

Construct via the Class AniraWeb factory in most cases: aniraWeb.Buffer(...) rather than new BufferF(...). The factory threads the WASM instance through for you.

class BufferF(wasmInstance, numChannels, numSamples)#

TypeScript wrapper for anira::BufferF Thread-safe C API wrapper

Extends:
  • BaseWrapper

Arguments:
  • wasmInstance (AniraWasmInstance)

  • numChannels (number)

  • numSamples (number)

clear()#

Mirrors anira::Buffer::clear().

data()#

Mirrors anira::Buffer::data().

Returns:

number

destroy()#

Free the underlying C++ object. See Lifecycle and Cleanup for when to call this.

getArrayOfReadPointers()#

Mirrors anira::Buffer::get_array_of_read_pointers().

Returns:

number[]

getArrayOfWritePointers()#

Mirrors anira::Buffer::get_array_of_write_pointers().

Returns:

number[]

getNumChannels()#

Mirrors anira::Buffer::get_num_channels().

Returns:

number

getNumSamples()#

Mirrors anira::Buffer::get_num_samples().

Returns:

number

getReadPointer(channel)#

Mirrors anira::Buffer::get_read_pointer().

Arguments:
  • channel (number)

Returns:

number

getReadPointer(channel, sampleIndex)#

Mirrors anira::Buffer::get_read_pointer().

Arguments:
  • channel (number)

  • sampleIndex (number)

Returns:

number

getSample(channel, sampleIndex)#

Mirrors anira::Buffer::get_sample().

Arguments:
  • channel (number)

  • sampleIndex (number)

Returns:

number

getWritePointer(channel)#

Mirrors anira::Buffer::get_write_pointer().

Arguments:
  • channel (number)

Returns:

number

getWritePointer(channel, sampleIndex)#

Mirrors anira::Buffer::get_write_pointer().

Arguments:
  • channel (number)

  • sampleIndex (number)

Returns:

number

resetChannelPtr()#

Mirrors anira::Buffer::reset_channel_ptr().

resize(numChannels, numSamples)#

Mirrors anira::Buffer::resize().

Arguments:
  • numChannels (number)

  • numSamples (number)

setSample(channel, sampleIndex, value)#

Mirrors anira::Buffer::set_sample().

Arguments:
  • channel (number)

  • sampleIndex (number)

  • value (number)

swapData(other)#

Mirrors anira::Buffer::swap_data().

Arguments:
  • other (PossiblePointer<BufferF>)

swapData(rawPointer, size)#

Mirrors anira::Buffer::swap_data().

Arguments:
  • rawPointer (number)

  • size (number)