Table of Contents

Interface IEchoModuleHandle

Namespace
SunSharp.Modules
Assembly
SunSharp.dll

Stereo echo. Maximum delay length: 4 seconds.

public interface IEchoModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle
Inherited Members

Methods

GetDelay(ValueScalingMode)

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

int GetDelay(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDelayUnit()

Original name: 5 'Delay unit'

EchoDelayUnit GetDelayUnit()

Returns

EchoDelayUnit

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

GetFFreq(ValueScalingMode)

Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 8 'F.freq'

int GetFFreq(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

GetFilter()

Original name: 7 'Filter'

EchoFilter GetFilter()

Returns

EchoFilter

GetRightChannelOffset()

Original name: 4 'Right channel offset'

Toggle GetRightChannelOffset()

Returns

Toggle

GetRightChannelOffsetDelay(ValueScalingMode)

Expressed as Delay/32768.
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Right channel offset'

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

PatternEvent MakeDelayEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeDelayUnitEvent(EchoDelayUnit)

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 MakeDelayUnitEvent(EchoDelayUnit value)

Parameters

value EchoDelayUnit

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

MakeFFreqEvent(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 MakeFFreqEvent(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

MakeFilterEvent(EchoFilter)

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 MakeFilterEvent(EchoFilter value)

Parameters

value EchoFilter

Returns

PatternEvent

MakeRightChannelOffsetDelayEvent(int)

Expressed as Delay/32768.

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value Toggle

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: 0 to 256, real: 0 to 256 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

SetDelayUnit(EchoDelayUnit)

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

Parameters

value EchoDelayUnit

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

SetFFreq(int, ValueScalingMode)

Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 8 'F.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 SetFFreq(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

SetFilter(EchoFilter)

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

void SetFilter(EchoFilter value)

Parameters

value EchoFilter

SetRightChannelOffset(Toggle)

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

void SetRightChannelOffset(Toggle value)

Parameters

value Toggle

SetRightChannelOffsetDelay(int, ValueScalingMode)

Expressed as Delay/32768.
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Right channel offset' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetRightChannelOffsetDelay(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