Interface ILfoModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

LFO - Low Frequency Oscillator. Can work as amplitude/balance modulator or as standalone generator.

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

GetAmplitude(ValueScalingMode)

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

int GetAmplitude(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetChannels()

Original name: 6 'Channels'

Channels GetChannels()

Returns

Channels

GetDutyCycle(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 8 'Duty cycle'

int GetDutyCycle(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFilterType()

Original name: 1 'Type'

LfoType GetFilterType()

Returns

LfoType

GetFineTune(ValueScalingMode)

Value range: displayed: -256 to 256, real: 0 to 512 Original name: 14 'Finetune'

int GetFineTune(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFreq(ValueScalingMode)

Value range: displayed: 1 to 256, real: 1 to 256 Original name: 3 'Freq'

int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFreqScale(ValueScalingMode)

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

int GetFreqScale(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFrequencyUnit()

Original name: 7 'Frequency unit'

LfoFrequencyUnit GetFrequencyUnit()

Returns

LfoFrequencyUnit

GetGenerator()

Original name: 9 'Generator'

Toggle GetGenerator()

Returns

Toggle

GetSetPhase(ValueScalingMode)

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

int GetSetPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSineQuality()

Original name: 12 'Sine quality'

LfoSineQuality GetSineQuality()

Returns

LfoSineQuality

GetSmoothTransitions()

Original name: 11 'Smooth transitions'

LfoSmoothTransitions GetSmoothTransitions()

Returns

LfoSmoothTransitions

GetTranspose(ValueScalingMode)

Original name: 13 'Transpose'

int GetTranspose(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVolume(ValueScalingMode)

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

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetWaveform()

Original name: 4 'Waveform'

LfoWaveform GetWaveform()

Returns

LfoWaveform

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

Parameters

value int

Returns

PatternEvent

MakeChannelsEvent(Channels)

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 MakeChannelsEvent(Channels value)

Parameters

value Channels

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

MakeFilterTypeEvent(LfoType)

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

Parameters

value LfoType

Returns

PatternEvent

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

PatternEvent MakeFineTuneEvent(int value)

Parameters

value int

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

PatternEvent MakeFreqEvent(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

MakeFrequencyUnitEvent(LfoFrequencyUnit)

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 MakeFrequencyUnitEvent(LfoFrequencyUnit value)

Parameters

value LfoFrequencyUnit

Returns

PatternEvent

MakeGeneratorEvent(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 MakeGeneratorEvent(Toggle value)

Parameters

value Toggle

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

MakeSineQualityEvent(LfoSineQuality)

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 MakeSineQualityEvent(LfoSineQuality value)

Parameters

value LfoSineQuality

Returns

PatternEvent

MakeSmoothTransitionsEvent(LfoSmoothTransitions)

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 MakeSmoothTransitionsEvent(LfoSmoothTransitions value)

Parameters

value LfoSmoothTransitions

Returns

PatternEvent

MakeTransposeEvent(int)

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

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeWaveformEvent(LfoWaveform)

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 MakeWaveformEvent(LfoWaveform value)

Parameters

value LfoWaveform

Returns

PatternEvent

SetAmplitude(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetChannels(Channels)

Original name: 6 'Channels' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetChannels(Channels value)

Parameters

value Channels

SetDutyCycle(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetFilterType(LfoType)

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

Parameters

value LfoType

SetFineTune(int, ValueScalingMode)

Value range: displayed: -256 to 256, real: 0 to 512 Original name: 14 '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 SetFineTune(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetFreq(int, ValueScalingMode)

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

SetFreqScale(int, ValueScalingMode)

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

SetFrequencyUnit(LfoFrequencyUnit)

Original name: 7 'Frequency 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 SetFrequencyUnit(LfoFrequencyUnit value)

Parameters

value LfoFrequencyUnit

SetGenerator(Toggle)

Original name: 9 'Generator' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetGenerator(Toggle value)

Parameters

value Toggle

SetSetPhase(int, ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 5 'Set 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 SetSetPhase(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetSineQuality(LfoSineQuality)

Original name: 12 'Sine quality' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetSineQuality(LfoSineQuality value)

Parameters

value LfoSineQuality

SetSmoothTransitions(LfoSmoothTransitions)

Original name: 11 'Smooth transitions' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetSmoothTransitions(LfoSmoothTransitions value)

Parameters

value LfoSmoothTransitions

SetTranspose(int, ValueScalingMode)

Original name: 13 'Transpose' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

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

Parameters

value int

valueScalingMode ValueScalingMode

SetVolume(int, ValueScalingMode)

Value range: displayed: 0 to 512, real: 0 to 512 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

SetWaveform(LfoWaveform)

Original name: 4 '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 SetWaveform(LfoWaveform value)

Parameters

value LfoWaveform