Skip to main content

Module process

Module process 

Source
Expand description

Plugin audio processing types and related utilities.

A plugin’s audio processor can be in two states, either started or stopped, depending on whether it is currently continuously processing audio, or has been put to sleep by the host, respectively.

These states are represented by the StartedPluginAudioProcessor and StoppedPluginAudioProcessor types respectively, using a type-state pattern that only expose the methods that are valid for the plugin’s current state.

Alternatively, users can also use the PluginAudioProcessor convenience type that internalizes the state instead, and allows it to change and be checked at runtime.

Modules§

audio_buffers
Types to manipulate input and output audio buffers for processing.

Structs§

AudioPortProcessingInfo
Processing-related information about an audio port.
ConstantMask
A hint that indicates which channels of an audio port are constant.
ConstantMaskIter
An iterator over the constant status of each channel in a ConstantMask.
PluginAudioConfiguration
The audio configuration passed to a plugin’s audio processor upon activation.
ProcessingStartError
An error that occurred when a plugin instance couldn’t start processing.
StartedPluginAudioProcessor
A handle to a plugin’s audio processor that is in the started state.
StoppedPluginAudioProcessor
A handle to a plugin’s audio processor that is in the stopped state.

Enums§

PluginAudioProcessor
A handle to a plugin’s audio processor that can be in either its started or stopped state.
ProcessStatus
Status returned by a plugin after processing.