Interface IFlangerModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

Flanger effect.

public interface IFlangerModuleHandle : 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

GetDelay(ValueScalingMode)

Value range: displayed: 8 to 1000, real: 8 to 1000 Original name: 3 'Delay'

int GetDelay(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDry(ValueScalingMode)

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

int GetDry(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFeedback(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 2 'Feedback'

int GetFeedback(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoAmp(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 6 'LFO amp'

int GetLfoAmp(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoFreq(ValueScalingMode)

Value range: displayed: 0 to 512, real: 0 to 512 Original name: 5 'LFO freq'

int GetLfoFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLfoFreqUnit()

Original name: 9 'LFO freq unit'

FlangerLfoFrequencyUnit GetLfoFreqUnit()

Returns

FlangerLfoFrequencyUnit

GetLfoWaveform()

Original name: 7 'LFO waveform'

FlangerLfoWaveform GetLfoWaveform()

Returns

FlangerLfoWaveform

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

GetSetLfoPhase(ValueScalingMode)

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

int GetSetLfoPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetWet(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 1 'Wet'

int GetWet(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

PatternEvent MakeDelayEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeDryEvent(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 MakeDryEvent(int value)

Parameters

value int

Returns

PatternEvent

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

PatternEvent MakeLfoFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeLfoFreqUnitEvent(FlangerLfoFrequencyUnit)

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

Parameters

value FlangerLfoFrequencyUnit

Returns

PatternEvent

MakeLfoWaveformEvent(FlangerLfoWaveform)

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

Parameters

value FlangerLfoWaveform

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

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

MakeWetEvent(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 MakeWetEvent(int value)

Parameters

value int

Returns

PatternEvent

SetDelay(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetDry(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetFeedback(int, ValueScalingMode)

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

void SetFeedback(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: 6 '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 512, real: 0 to 512 Original name: 5 '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(FlangerLfoFrequencyUnit)

Original name: 9 '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(FlangerLfoFrequencyUnit value)

Parameters

value FlangerLfoFrequencyUnit

SetLfoWaveform(FlangerLfoWaveform)

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

Parameters

value FlangerLfoWaveform

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

SetSetLfoPhase(int, ValueScalingMode)

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

SetWet(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode