Interface IFilterProModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

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 interface IFilterProModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle

Inherited Members

ITypedModuleHandle.IsCorrectHandleType()

ITypedModuleHandle.AssertCorrectHandleType()

IGenericSynthModuleHandle.Id

IGenericSynthModuleHandle.Slot

IGenericSynthModuleHandle.GetFlags()

IGenericSynthModuleHandle.GetModuleType()

IGenericSynthModuleHandle.GetExists()

IGenericSynthModuleHandle.GetFineTune()

IGenericSynthModuleHandle.SetFineTune(FineTunePair)

IGenericSynthModuleHandle.ReadScope(AudioChannel, short[])

IGenericSynthModuleHandle.GetName()

IGenericSynthModuleHandle.SetName(string)

IGenericSynthModuleHandle.GetPosition()

IGenericSynthModuleHandle.SetPosition(int, int)

IGenericSynthModuleHandle.GetColor()

IGenericSynthModuleHandle.SetColor(byte, byte, byte)

IGenericSynthModuleHandle.GetInputs()

IGenericSynthModuleHandle.GetInputModules()

IGenericSynthModuleHandle.GetOutputs()

IGenericSynthModuleHandle.GetOutputModules()

IGenericSynthModuleHandle.ConnectInput(int)

IGenericSynthModuleHandle.ConnectInput(ISynthModuleHandle)

IGenericSynthModuleHandle.ConnectOutput(int)

IGenericSynthModuleHandle.ConnectOutput(ISynthModuleHandle)

IGenericSynthModuleHandle.DisconnectInput(int)

IGenericSynthModuleHandle.DisconnectInput(ISynthModuleHandle)

IGenericSynthModuleHandle.DisconnectOutput(int)

IGenericSynthModuleHandle.DisconnectOutput(ISynthModuleHandle)

IGenericSynthModuleHandle.MakeSetControllerValueEvent(byte, ushort)

IGenericSynthModuleHandle.MakeNoteEvent(Note, byte?)

IGenericSynthModuleHandle.MakeSetPitchEvent(ushort, byte?)

IGenericSynthModuleHandle.MakeSetFrequencyEvent(double, byte?)

IGenericSynthModuleHandle.MakeEvent(Note, byte?, byte?, Effect, ushort)

Methods

GetExponentialFreq()

Original name: 5 'Exponential freq'

Toggle GetExponentialFreq()

Returns

Toggle

GetFilterType()

Original name: 1 'Type'

FilterProType GetFilterType()

Returns

FilterProType

GetFreq(ValueScalingMode)

Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 2 'Freq'

int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFreqFineTune(ValueScalingMode)

Value range: displayed: -1000 to 1000, real: 0 to 2000 Original name: 3 'Freq finetune'

int GetFreqFineTune(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFreqScale(ValueScalingMode)

Value range: displayed: 0 to 200, real: 0 to 200 Original name: 4 'Freq scale'

int GetFreqScale(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetGain(ValueScalingMode)

Value range: displayed: -16384 to 16384, real: 0 to 32768 Original name: 7 'Gain'

int GetGain(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoAmp(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 13 'LFO amp'

int GetLfoAmp(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoFreq(ValueScalingMode)

Value range: displayed: 0 to 1024, real: 0 to 1024 Original name: 12 'LFO freq'

int GetLfoFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoFreqUnit()

Original name: 16 'LFO freq unit'

FilterLfoFrequencyUnit GetLfoFreqUnit()

Returns

FilterLfoFrequencyUnit

GetLfoWaveform()

Original name: 14 'LFO waveform'

FilterLfoWaveform GetLfoWaveform()

Returns

FilterLfoWaveform

GetMix(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 11 'Mix'

int GetMix(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMode()

Original name: 10 'Mode'

FilterProMode GetMode()

Returns

FilterProMode

GetQ(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Q'

int GetQ(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetResponse(ValueScalingMode)

Value range: displayed: 0 to 1000, real: 0 to 1000 Original name: 9 'Response'

int GetResponse(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRollOff()

Original name: 8 'Roll-off'

FilterProRollOff GetRollOff()

Returns

FilterProRollOff

GetSetLfoPhase(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 15 'Set LFO phase'

int GetSetLfoPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVolume(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 0 'Volume'

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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.

PatternEvent MakeExponentialFreqEvent(Toggle value)

Parameters

value Toggle

Returns

PatternEvent

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.

PatternEvent MakeFilterTypeEvent(FilterProType value)

Parameters

value FilterProType

Returns

PatternEvent

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.

PatternEvent MakeFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeFreqFineTuneEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeFreqScaleEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeGainEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeLfoAmpEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeLfoFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeLfoFreqUnitEvent(FilterLfoFrequencyUnit value)

Parameters

value FilterLfoFrequencyUnit

Returns

PatternEvent

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.

PatternEvent MakeLfoWaveformEvent(FilterLfoWaveform value)

Parameters

value FilterLfoWaveform

Returns

PatternEvent

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.

PatternEvent MakeMixEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeModeEvent(FilterProMode value)

Parameters

value FilterProMode

Returns

PatternEvent

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.

PatternEvent MakeQEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeResponseEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeRollOffEvent(FilterProRollOff value)

Parameters

value FilterProRollOff

Returns

PatternEvent

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.

PatternEvent MakeSetLfoPhaseEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

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.

void SetExponentialFreq(Toggle value)

Parameters

value Toggle

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.

void SetFilterType(FilterProType value)

Parameters

value FilterProType

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.

void SetFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetFreqFineTune(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetFreqScale(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetGain(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetLfoAmp(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetLfoFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetLfoFreqUnit(FilterLfoFrequencyUnit value)

Parameters

value FilterLfoFrequencyUnit

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.

void SetLfoWaveform(FilterLfoWaveform value)

Parameters

value FilterLfoWaveform

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.

void SetMix(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetMode(FilterProMode value)

Parameters

value FilterProMode

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.

void SetQ(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetResponse(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetRollOff(FilterProRollOff value)

Parameters

value FilterProRollOff

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.

void SetSetLfoPhase(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

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.

void SetVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode