Skip to main content

Manual Engine

The Manual audio engine allows you to process audio buffers on demand by calling the process action. This method is designed to be safe for use in real-time audio contexts. If your graph does not produce output, the output buffer parameter is optional. Similarly, if your graph does not require input, the input buffer parameter is also optional.


Configuration

This object does not provide any configuration options.


Values

Inherits values from its parent, SwitchboardObject.

graph

Type: graph config

The configuration of the graph that is set in the engine.


Actions

Inherits actions from its parent, SwitchboardObject.

process

Processes the given audio buffer.

Parameters

NameTypeDescription
inputBuffer (Optional)float*Pointer to the input buffer the contains audio samples.
outputBuffer (Optional)float*Pointer to the output buffer that will be filled with audio samples.
numChannelsuintThe number of channels in the audio buffers.
numFramesuintThe number of frames in the input audio buffer.
sampleRateuintThe sample rate of the input audio buffer.
isInterleaved (optional)boolTells whether input audio buffer contains interleaved or non-interleaved samples. Not used for mono audio.

Events

Inherits events from its parent, SwitchboardObject.

This object does not provide any events.