Function list#

Module-level free functions exported by @anira-project/anira. The C ABI itself is reached through AniraBindings (anira.abi, generated from the registry), documented with the C headers (Usage Guide); the record offsets are in abi/layout.ts (exported as layout) and the enums and defines in abi/enums.ts.

Processors and engines#

In every scope that runs one of their phases: the main thread, an inference Worker’s module, a worklet’s module (@anira-project/anira/scope).

defineProcessor(name, factory)#
Arguments:
  • name (string)

  • factory (ProcessorFactory)

Returns:

number

defineEngine(id, factory)#
Arguments:
  • id (string)

  • factory (EngineFactory)

Returns:

number

keyOf(name)#
Arguments:
  • name (string)

Returns:

number

engineTensors(env, ctx)#
Arguments:
  • env (ScopeEnv)

  • ctx (number)

Returns:

{ inputs: EngineTensorView[]; outputs: EngineTensorView[]; }

engineModel(env, prepared)#
Arguments:
  • env (ScopeEnv)

  • prepared (number)

Returns:

EngineModel

scopeRegistry()#
Returns:

Registry

Audio#

async createAudioNode(anira, audioContext, handler, inputs, options={})#
Arguments:
  • anira (WithAbi)

  • audioContext (BaseAudioContext)

  • handler (number)

  • inputs (readonly InputSpec[])

  • options (AudioNodeOptions)

Returns:

Promise<AniraAudioNode>

async measureRenderGeometry(context, options={})#
Arguments:
  • context (BaseAudioContext)

  • options (RenderGeometryOptions)

Returns:

Promise<RenderGeometry>

Configs#

enabledEngines(abi)#
Arguments:
  • abi (AniraBindings)

Returns:

Set<number>

Log#

consoleLogSink(record)#
Arguments:
  • record (LogRecord)