Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Most modules supplied with Audio Weaver take advantage of this overflow behavior to smoothly transition from internal to external memory once the heaps have filled up.

Module Function Details
Anchor
ModuleFunctionDetails
ModuleFunctionDetails

Each audio module has a set of 5 functions associated with it.  This section describes the arguments to each of the functions.

...

Info

There is no need to manually call the Set function within the Constructor.  The framework takes care of this.

Processing Function
Anchor
ProcessingFunction
ProcessingFunction

The processing function has the signature

...

The processing function does not return an error code.  If you need to track error conditions, do this by adding an error code to the instance structure and then tracking it in the inspector.

Set Function
Anchor
SetFunction
SetFunction

This function implements a module's control functionality and typically converts high-level variables to low-level variables.  The PeakHold module has the function signature

...

When called, the function should update instance variables and can use the mask argument to determine which variables should be updated.

BypassFunction
Anchor
BypassFunction
BypassFunction

This function implements a module's bypass functionality.  The function signature is identical to the processing function

...