dawdreamer.PluginProcessor

class dawdreamer.PluginProcessor

A Plugin Processor can load VST “.dll” and “.vst3” files on Windows. It can load “.vst”, “.vst3”, and “.component” files on macOS. The files can be for either instruments or effects. Some plugins such as ones that do sidechain compression can accept two inputs when loading a graph.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
add_midi_note(self, note, velocity, ...[, beats])	Add a single MIDI note whose note and velocity are integers between 0 and 127.
can_set_bus(self, inputs, outputs)	Return bool for whether this combination of input and output channels can be set.
clear_midi(self)	Remove all MIDI notes.
disable_nonmain_buses(self)	Disable all non-main buses (aux and sidechains).
enable_all_buses(self)	Enable all buses.
get_audio(self)	Get the audio data of the processor after a render, assuming recording was enabled.
get_automation(*args, **kwargs)	Overloaded function.
get_latency_samples(self)	Get the latency measured in samples of the plugin.
get_name(self)	Get the user-defined name of a processor instance.
get_num_input_channels(self)	Get the total number of input channels (2 indicates stereo input).
get_num_output_channels(self)	Get the total number of output channels (2 indicates stereo output).
get_parameter(self, index)	Get a parameter's value.
get_parameter_name(self, index)	Get a parameter's name.
get_parameter_range(self, index[, ...])	Return a dictionary with information about the parameter's range. The dictionary's keys are tuples of the form (domain1, domain2)
get_parameter_text(self, index)	Get a parameter's value as text.
get_parameters_description(self)	Get a list of dictionaries describing the plugin's parameters.
get_patch(self)
get_plugin_parameter_size(self)	Get the number of parameters.
get_plugin_parameters_description(self)	[DEPRECATED: Use get_parameters_description].
load_midi(self, filepath, *[, ...])	Load MIDI from a file.
load_preset(self, filepath)	Load an FXP preset with an absolute filepath and ".fxp" extension.
load_state(self, filepath)	Load the state from a file.
load_vst3_preset(self, filepath)	Load a VST3 preset with an absolute filepath and ".vstpreset" extension.
open_editor(self)	Open the UI editor for the plugin.
save_midi(self, filepath)	After rendering, you can save the MIDI to a file using absolute times (SMPTE format).
save_state(self, filepath)	Save the state to a file.
set_automation(self, parameter_index, data, *)	Set the automation based on its index.
set_bus(self, inputs, outputs)	Set the number of input and output channels.
set_parameter(self, index, value)	Set a parameter's value to a constant.
set_patch(self, patch)

Attributes

n_midi_events	The number of MIDI events stored in the buffer.
record	Whether recording of this processor is enabled.
record_automation	Whether recording of this processor's automation is enabled.