Struct FilterProModuleHandle
High-quality 64-bit IIR Filter that can amplify, pass or attenuate some frequency ranges. This module is faster than Filter on modern CPUs and slower on older CPUs.
public readonly struct FilterProModuleHandle : IFilterProModuleHandle, ITypedModuleHandle, IGenericSynthModuleHandle- Implements
Constructors
FilterProModuleHandle(SynthModuleHandle)
public FilterProModuleHandle(SynthModuleHandle moduleHandle)Parameters
moduleHandleSynthModuleHandle
Properties
Id
Gets the ID of the synthesizer module.
public int Id { get; }Property Value
- int
ModuleHandle
public SynthModuleHandle ModuleHandle { get; }Property Value
Slot
Gets the slot associated with this instance.
public ISlot Slot { get; }Property Value
Methods
AssertCorrectHandleType()
Throws an exception if the underlying module is not of the correct type.
public void AssertCorrectHandleType()Exceptions
- IncorrectSynthHandleTypeException
Thrown if the underlying module is not of the correct type.
ConnectInput(SynthModuleHandle)
Connect the input of this module to the output of another module.
public void ConnectInput(SynthModuleHandle targetModule)Parameters
targetModuleSynthModuleHandle
Remarks
Requires LockSlot(int) / UnlockSlot(int).
Calls sv_connect_module(int, int, int).Exceptions
- SunVoxException
Thrown when the operation fails.
ConnectOutput(SynthModuleHandle)
Connect the output of this module to the input of another module.
public void ConnectOutput(SynthModuleHandle targetModule)Parameters
targetModuleSynthModuleHandle
Remarks
Requires LockSlot(int) / UnlockSlot(int).
Calls sv_connect_module(int, int, int).Exceptions
- SunVoxException
Thrown when the operation fails.
DisconnectInput(SynthModuleHandle)
Disconnect the input of this module from the output of another module.
public void DisconnectInput(SynthModuleHandle targetModule)Parameters
targetModuleSynthModuleHandle
Remarks
Requires LockSlot(int) / UnlockSlot(int).
Calls sv_connect_module(int, int, int).Exceptions
- SunVoxException
Thrown when the operation fails.
DisconnectOutput(SynthModuleHandle)
Disconnect the output of this module from the input of another module.
public void DisconnectOutput(SynthModuleHandle targetModule)Parameters
targetModuleSynthModuleHandle
Remarks
Requires LockSlot(int) / UnlockSlot(int).
Calls sv_connect_module(int, int, int).Exceptions
- SunVoxException
Thrown when the operation fails.
GetColor()
Get the module color.
public (byte, byte, byte) GetColor()Returns
- (byte R, byte G, byte B)
RGB color tuple (r, g, b).
Remarks
GetExists()
Check if a module exists.
public bool GetExists()Returns
- bool
true if module exists.
Remarks
GetExponentialFreq()
Original name: 5 'Exponential freq'
public Toggle GetExponentialFreq()Returns
GetFilterType()
Original name: 1 'Type'
public FilterProType GetFilterType()Returns
GetFineTune()
Get the module fine tune and relative note values.
public FineTunePair GetFineTune()Returns
- FineTunePair
Fine tune pair containing fine tune value and relative note.
Remarks
GetFlags()
Get the module flags.
public ModuleFlags GetFlags()Returns
- ModuleFlags
Module flags indicating existence, type, state, and connections.
Remarks
GetFreq(ValueScalingMode)
Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 2 'Freq'
public int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetFreqFineTune(ValueScalingMode)
Value range: displayed: -1000 to 1000, real: 0 to 2000 Original name: 3 'Freq finetune'
public int GetFreqFineTune(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetFreqScale(ValueScalingMode)
Value range: displayed: 0 to 200, real: 0 to 200 Original name: 4 'Freq scale'
public int GetFreqScale(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetGain(ValueScalingMode)
Value range: displayed: -16384 to 16384, real: 0 to 32768 Original name: 7 'Gain'
public int GetGain(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetInputModules()
Get the array of input modules connected to this module.
public SynthModuleHandle[] GetInputModules()Returns
- SynthModuleHandle[]
Array of connected input module numbers.
Remarks
GetInputs()
Get the array of input module numbers connected to this module.
public int[] GetInputs()Returns
- int[]
Array of connected input module numbers.
Remarks
GetLfoAmp(ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 13 'LFO amp'
public int GetLfoAmp(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetLfoFreq(ValueScalingMode)
Value range: displayed: 0 to 1024, real: 0 to 1024 Original name: 12 'LFO freq'
public int GetLfoFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetLfoFreqUnit()
Original name: 16 'LFO freq unit'
public FilterLfoFrequencyUnit GetLfoFreqUnit()Returns
GetLfoWaveform()
Original name: 14 'LFO waveform'
public FilterLfoWaveform GetLfoWaveform()Returns
GetMix(ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 11 'Mix'
public int GetMix(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetMode()
Original name: 10 'Mode'
public FilterProMode GetMode()Returns
GetModuleType()
Returns the module type. If the module does not exist, returns null. If the module type is unknown (due to library mismatch or otherwise), returns Unknown.
public SynthModuleType? GetModuleType()Returns
GetName()
Get the module name.
public string? GetName()Returns
- string
Module name, or null if unavailable.
Remarks
Calls sv_get_module_name(int, int).
GetOutputModules()
Gets the array of output modules connected to this module.
public SynthModuleHandle[] GetOutputModules()Returns
- SynthModuleHandle[]
Array of connected output module numbers.
Remarks
GetOutputs()
Get the array of output module numbers connected from this module.
public int[] GetOutputs()Returns
- int[]
Array of connected output module numbers.
Remarks
GetPosition()
Get the module position on the canvas.
public (int, int) GetPosition()Returns
- (int x, int y)
Tuple containing X and Y coordinates.
Remarks
Calls sv_get_module_xy(int, int).
GetQ(ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Q'
public int GetQ(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetResponse(ValueScalingMode)
Value range: displayed: 0 to 1000, real: 0 to 1000 Original name: 9 'Response'
public int GetResponse(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetRollOff()
Original name: 8 'Roll-off'
public FilterProRollOff GetRollOff()Returns
GetSetLfoPhase(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 15 'Set LFO phase'
public int GetSetLfoPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
GetVolume(ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 0 'Volume'
public int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueScalingModeValueScalingMode
Returns
- int
IsCorrectHandleType()
Determines whether the underlying module is of the correct type.
public bool IsCorrectHandleType()Returns
- bool
MakeEvent(Note, byte?, byte?, Effect, ushort)
Creates a new generic pattern event with optional parameters for flexible event construction.
public PatternEvent MakeEvent(Note note = default, byte? velocity = null, byte? controller = null, Effect effect = Effect.None, ushort value = 0)Parameters
noteNoteNote value. Allows for explicit note commands. velocitybyte?Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data. controllerbyte?Controller identifier (0-based). Returns null when no controller is specified. Module controllers: 0-126 (raw data: 1-127). MIDI controllers: 127+ (raw data: 0x80+). Automatically handles the +1 offset used in raw data. effectEffectPattern event effect code. valueushortParameter value for controller or effect (16-bit unsigned integer). Range: 0-32768 (0x8000) for controllers, 0-65535 (0xFFFF) for effects.
For pitch commands: 0x0000 = highest pitch, 0x7800 = C0, 0x100 = one semitone.
Returns
- PatternEvent
A new PatternEvent with the specified fields.
Remarks
This method provides maximum flexibility for creating events. For common scenarios, consider using specific factory methods like NoteEvent(Note, int?, byte?), ControllerEvent(int, byte, ushort), etc.
MakeExponentialFreqEvent(Toggle)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeExponentialFreqEvent(Toggle value)Parameters
valueToggle
Returns
MakeFilterTypeEvent(FilterProType)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeFilterTypeEvent(FilterProType value)Parameters
valueFilterProType
Returns
MakeFreqEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 22000) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeFreqEvent(int value)Parameters
valueint
Returns
MakeFreqFineTuneEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (-1000 to 1000) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeFreqFineTuneEvent(int value)Parameters
valueint
Returns
MakeFreqScaleEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 200) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeFreqScaleEvent(int value)Parameters
valueint
Returns
MakeGainEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (-16384 to 16384) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeGainEvent(int value)Parameters
valueint
Returns
MakeLfoAmpEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 32768) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeLfoAmpEvent(int value)Parameters
valueint
Returns
MakeLfoFreqEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 1024) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeLfoFreqEvent(int value)Parameters
valueint
Returns
MakeLfoFreqUnitEvent(FilterLfoFrequencyUnit)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeLfoFreqUnitEvent(FilterLfoFrequencyUnit value)Parameters
valueFilterLfoFrequencyUnit
Returns
MakeLfoWaveformEvent(FilterLfoWaveform)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeLfoWaveformEvent(FilterLfoWaveform value)Parameters
valueFilterLfoWaveform
Returns
MakeMixEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 32768) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeMixEvent(int value)Parameters
valueint
Returns
MakeModeEvent(FilterProMode)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeModeEvent(FilterProMode value)Parameters
valueFilterProMode
Returns
MakeNoteEvent(Note, byte?)
Creates a note event that triggers a note on the specified module.
public PatternEvent MakeNoteEvent(Note note, byte? velocity = null)Parameters
noteNoteNote value. Allows for explicit note commands. velocitybyte?Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data.
Returns
MakeQEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 32768) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeQEvent(int value)Parameters
valueint
Returns
MakeResponseEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 1000) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeResponseEvent(int value)Parameters
valueint
Returns
MakeRollOffEvent(FilterProRollOff)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
public PatternEvent MakeRollOffEvent(FilterProRollOff value)Parameters
valueFilterProRollOff
Returns
MakeSetControllerValueEvent(byte, ushort)
Creates a controller event that changes a module parameter.
public PatternEvent MakeSetControllerValueEvent(byte controllerId, ushort value)Parameters
controllerIdbytevalueushortParameter value for controller or effect (16-bit unsigned integer). Range: 0-32768 (0x8000) for controllers, 0-65535 (0xFFFF) for effects.
For pitch commands: 0x0000 = highest pitch, 0x7800 = C0, 0x100 = one semitone.
Returns
Remarks
For better type safety and readability, consider using typed module handles and extension methods.
MakeSetFrequencyEvent(double, byte?)
Creates a Set Pitch event by converting a frequency in Hz to the appropriate pitch value.
public PatternEvent MakeSetFrequencyEvent(double frequency, byte? velocity = null)Parameters
frequencydoubleFrequency in Hz (e.g., 440.0 for A4).
velocitybyte?Velocity value (0-128). Use null for default velocity.
Returns
- PatternEvent
A new PatternEvent with the calculated pitch value.
Examples
// Set pitch to A4 (440 Hz)
var a440 = PatternEvent.SetFrequencyEvent(0, 440.0, 100);
// Set pitch to middle C (261.63 Hz)
var c4 = PatternEvent.SetFrequencyEvent(0, 261.63);MakeSetLfoPhaseEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeSetLfoPhaseEvent(int value)Parameters
valueint
Returns
MakeSetPitchEvent(ushort, byte?)
Creates a Set Pitch event with exact pitch value for microtonal or pitch-bend effects.
public PatternEvent MakeSetPitchEvent(ushort pitch, byte? velocity = null)Parameters
pitchushortPitch value where 0x0000 = highest pitch, 0x7800 = C0 (lowest), 0x100 = one semitone.
velocitybyte?Velocity value (0-128). Use null for default velocity.
Returns
- PatternEvent
A new PatternEvent configured as a set pitch event.
Examples
// Set pitch to middle C (C4 = 0x3C00)
var middleC = PatternEvent.SetPitchEvent(0, 0x3C00);
// Set pitch to A4 (440Hz reference = 0x4500)
var a440 = PatternEvent.SetPitchEvent(0, 0x4500, 100);MakeVolumeEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 32768) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeVolumeEvent(int value)Parameters
valueint
Returns
ReadScope(AudioChannel, short[])
Read module scope view, and write it to a buffer.
public int ReadScope(AudioChannel channel, short[] buffer)Parameters
channelAudioChannelAudio channel.
buffershort[]Buffer to receive scope data.
Returns
- int
Number of samples successfully read.
Remarks
Exceptions
- ArgumentNullException
Thrown if
bufferis null.
SetColor(byte, byte, byte)
Set the module color.
public void SetColor(byte r, byte g, byte b)Parameters
rbyteRed component (0 to 255).
gbyteGreen component (0 to 255).
bbyteBlue component (0 to 255).
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
SetExponentialFreq(Toggle)
Original name: 5 'Exponential freq' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetExponentialFreq(Toggle value)Parameters
valueToggle
SetFilterType(FilterProType)
Original name: 1 'Type' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetFilterType(FilterProType value)Parameters
valueFilterProType
SetFineTune(FineTunePair)
Sets the fine tune for the module.
public void SetFineTune(FineTunePair fineTune)Parameters
fineTuneFineTunePair
SetFreq(int, ValueScalingMode)
Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 2 'Freq' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetFreqFineTune(int, ValueScalingMode)
Value range: displayed: -1000 to 1000, real: 0 to 2000 Original name: 3 'Freq finetune' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetFreqFineTune(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetFreqScale(int, ValueScalingMode)
Value range: displayed: 0 to 200, real: 0 to 200 Original name: 4 'Freq scale' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetFreqScale(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetGain(int, ValueScalingMode)
Value range: displayed: -16384 to 16384, real: 0 to 32768 Original name: 7 'Gain' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetGain(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetLfoAmp(int, ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 13 'LFO amp' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetLfoAmp(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetLfoFreq(int, ValueScalingMode)
Value range: displayed: 0 to 1024, real: 0 to 1024 Original name: 12 'LFO freq' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetLfoFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetLfoFreqUnit(FilterLfoFrequencyUnit)
Original name: 16 'LFO freq unit' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetLfoFreqUnit(FilterLfoFrequencyUnit value)Parameters
valueFilterLfoFrequencyUnit
SetLfoWaveform(FilterLfoWaveform)
Original name: 14 'LFO waveform' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetLfoWaveform(FilterLfoWaveform value)Parameters
valueFilterLfoWaveform
SetMix(int, ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 11 'Mix' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetMix(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetMode(FilterProMode)
Original name: 10 'Mode' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetMode(FilterProMode value)Parameters
valueFilterProMode
SetName(string)
Set the module name.
public void SetName(string name)Parameters
namestringNew module name.
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
- ArgumentNullException
Thrown if
nameis null.
SetPosition(int, int)
Set the module position.
public void SetPosition(int x, int y)Parameters
xintX coordinate (center: 512, working area: 0 to 1024).
yintY coordinate (center: 512, working area: 0 to 1024).
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
SetQ(int, ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Q' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetQ(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetResponse(int, ValueScalingMode)
Value range: displayed: 0 to 1000, real: 0 to 1000 Original name: 9 'Response' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetResponse(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetRollOff(FilterProRollOff)
Original name: 8 'Roll-off' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetRollOff(FilterProRollOff value)Parameters
valueFilterProRollOff
SetSetLfoPhase(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 15 'Set LFO phase' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetSetLfoPhase(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
SetVolume(int, ValueScalingMode)
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 0 'Volume' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
public void SetVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)Parameters
valueintvalueScalingModeValueScalingMode
Operators
implicit operator SynthModuleHandle(FilterProModuleHandle)
public static implicit operator SynthModuleHandle(FilterProModuleHandle handle)Parameters
handleFilterProModuleHandle