Interface IFilterModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

IIR Filter that can remove some unwanted frequency ranges.

public interface IFilterModuleHandle : 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: 11 'Exponential freq'

Toggle GetExponentialFreq()

Returns

Toggle

GetFilterType()

Original name: 3 'Type'

FilterType GetFilterType()

Returns

FilterType

GetFreq(ValueScalingMode)

Value range: displayed: 0 to 14000, real: 0 to 14000 Original name: 1 'Freq'

int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetImpulse(ValueScalingMode)

Value range: displayed: 0 to 14000, real: 0 to 14000 Original name: 6 'Impulse'

int GetImpulse(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoAmp(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 9 '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: 8 'LFO freq'

int GetLfoFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoFreqUnit()

Original name: 13 'LFO freq unit'

FilterLfoFrequencyUnit GetLfoFreqUnit()

Returns

FilterLfoFrequencyUnit

GetLfoWaveform()

Original name: 14 'LFO waveform'

FilterLfoWaveform GetLfoWaveform()

Returns

FilterLfoWaveform

GetMix(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 7 'Mix'

int GetMix(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMode()

Original name: 5 'Mode'

Quality GetMode()

Returns

Quality

GetResonance(ValueScalingMode)

Value range: displayed: 0 to 1530, real: 0 to 1530 Original name: 2 'Resonance'

int GetResonance(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetResponse(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 4 'Response'

int GetResponse(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRollOff()

Original name: 12 'Roll-off'

FilterRollOff GetRollOff()

Returns

FilterRollOff

GetSetLfoPhase(ValueScalingMode)

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

int GetSetLfoPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVolume(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 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(FilterType)

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(FilterType value)

Parameters

value FilterType

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 14000) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeImpulseEvent(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 14000) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeImpulseEvent(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 256) 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 256) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeMixEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeModeEvent(Quality)

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(Quality value)

Parameters

value Quality

Returns

PatternEvent

MakeResonanceEvent(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 1530) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeResonanceEvent(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 256) to column range (0 to 0x8000). Out of range values are clamped.

PatternEvent MakeResponseEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeRollOffEvent(FilterRollOff)

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(FilterRollOff value)

Parameters

value FilterRollOff

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 256) 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: 11 '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(FilterType)

Original name: 3 '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(FilterType value)

Parameters

value FilterType

SetFreq(int, ValueScalingMode)

Value range: displayed: 0 to 14000, real: 0 to 14000 Original name: 1 '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

SetImpulse(int, ValueScalingMode)

Value range: displayed: 0 to 14000, real: 0 to 14000 Original name: 6 'Impulse' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

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

Parameters

value int

valueScalingMode ValueScalingMode

SetLfoAmp(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 9 '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: 8 '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: 13 '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 256, real: 0 to 256 Original name: 7 '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(Quality)

Original name: 5 '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(Quality value)

Parameters

value Quality

SetResonance(int, ValueScalingMode)

Value range: displayed: 0 to 1530, real: 0 to 1530 Original name: 2 'Resonance' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

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

Parameters

value int

valueScalingMode ValueScalingMode

SetResponse(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 4 '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(FilterRollOff)

Original name: 12 '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(FilterRollOff value)

Parameters

value FilterRollOff

SetSetLfoPhase(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 10 '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 256, real: 0 to 256 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