Interface IAdsrModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

ADSR envelope generator. The module can be started either by notes at the input (reacts to note ON/OFF), or by setting the 'State' controller to the 'start' value.

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

GetAttack(ValueScalingMode)

Value range: displayed: 0 to 10000, real: 0 to 10000 Original name: 1 'Attack'

int GetAttack(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetAttackCurve()

Original name: 5 'Attack curve'

AdsrCurveType GetAttackCurve()

Returns

AdsrCurveType

GetDecay(ValueScalingMode)

Value range: displayed: 0 to 10000, real: 0 to 10000 Original name: 2 'Decay'

int GetDecay(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDecayCurve()

Original name: 6 'Decay curve'

AdsrCurveType GetDecayCurve()

Returns

AdsrCurveType

GetMode()

Original name: 13 'Mode'

AdsrMode GetMode()

Returns

AdsrMode

GetOnNoteoff()

Original name: 12 'On NoteOFF'

AdsrOnNoteOffBehaviour GetOnNoteoff()

Returns

AdsrOnNoteOffBehaviour

GetOnNoteon()

Original name: 11 'On NoteON'

AdsrOnNoteOnBehaviour GetOnNoteon()

Returns

AdsrOnNoteOnBehaviour

GetRelease(ValueScalingMode)

Value range: displayed: 0 to 10000, real: 0 to 10000 Original name: 4 'Release'

int GetRelease(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetReleaseCurve()

Original name: 7 'Release curve'

AdsrCurveType GetReleaseCurve()

Returns

AdsrCurveType

GetSmoothTransitions()

Original name: 14 'Smooth transitions'

AdsrSmoothTransitions GetSmoothTransitions()

Returns

AdsrSmoothTransitions

GetState()

Original name: 10 'State'

Toggle GetState()

Returns

Toggle

GetSustain()

Original name: 8 'Sustain'

AdsrSustainMode GetSustain()

Returns

AdsrSustainMode

GetSustainLevel(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 3 'Sustain level'

int GetSustainLevel(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSustainPedal()

Original name: 9 'Sustain pedal'

Toggle GetSustainPedal()

Returns

Toggle

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

MakeAttackCurveEvent(AdsrCurveType)

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 MakeAttackCurveEvent(AdsrCurveType value)

Parameters

value AdsrCurveType

Returns

PatternEvent

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

PatternEvent MakeAttackEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeDecayCurveEvent(AdsrCurveType)

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 MakeDecayCurveEvent(AdsrCurveType value)

Parameters

value AdsrCurveType

Returns

PatternEvent

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

PatternEvent MakeDecayEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeModeEvent(AdsrMode)

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

Parameters

value AdsrMode

Returns

PatternEvent

MakeOnNoteoffEvent(AdsrOnNoteOffBehaviour)

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 MakeOnNoteoffEvent(AdsrOnNoteOffBehaviour value)

Parameters

value AdsrOnNoteOffBehaviour

Returns

PatternEvent

MakeOnNoteonEvent(AdsrOnNoteOnBehaviour)

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 MakeOnNoteonEvent(AdsrOnNoteOnBehaviour value)

Parameters

value AdsrOnNoteOnBehaviour

Returns

PatternEvent

MakeReleaseCurveEvent(AdsrCurveType)

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 MakeReleaseCurveEvent(AdsrCurveType value)

Parameters

value AdsrCurveType

Returns

PatternEvent

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

PatternEvent MakeReleaseEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeSmoothTransitionsEvent(AdsrSmoothTransitions)

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

Parameters

value AdsrSmoothTransitions

Returns

PatternEvent

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

Parameters

value Toggle

Returns

PatternEvent

MakeSustainEvent(AdsrSustainMode)

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 MakeSustainEvent(AdsrSustainMode value)

Parameters

value AdsrSustainMode

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value Toggle

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

SetAttack(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetAttackCurve(AdsrCurveType)

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

void SetAttackCurve(AdsrCurveType value)

Parameters

value AdsrCurveType

SetDecay(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetDecayCurve(AdsrCurveType)

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

void SetDecayCurve(AdsrCurveType value)

Parameters

value AdsrCurveType

SetMode(AdsrMode)

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

Parameters

value AdsrMode

SetOnNoteoff(AdsrOnNoteOffBehaviour)

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

void SetOnNoteoff(AdsrOnNoteOffBehaviour value)

Parameters

value AdsrOnNoteOffBehaviour

SetOnNoteon(AdsrOnNoteOnBehaviour)

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

void SetOnNoteon(AdsrOnNoteOnBehaviour value)

Parameters

value AdsrOnNoteOnBehaviour

SetRelease(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetReleaseCurve(AdsrCurveType)

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

void SetReleaseCurve(AdsrCurveType value)

Parameters

value AdsrCurveType

SetSmoothTransitions(AdsrSmoothTransitions)

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

Parameters

value AdsrSmoothTransitions

SetState(Toggle)

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

void SetState(Toggle value)

Parameters

value Toggle

SetSustain(AdsrSustainMode)

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

void SetSustain(AdsrSustainMode value)

Parameters

value AdsrSustainMode

SetSustainLevel(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetSustainPedal(Toggle)

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

void SetSustainPedal(Toggle value)

Parameters

value Toggle

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