Table of Contents

Interface IWaveShaperModuleHandle

Namespace
SunSharp.Modules
Assembly
SunSharp.dll

In simple terms, WaveShaper allows you to change the shape of the input signal. In math terms, WaveShaper is the expression y = f( x ); where y - output; x - input; f - function with graph which you can see in the WaveShaper interface.

public interface IWaveShaperModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle
Inherited Members

Methods

GetDcBlocker()

Original name: 5 'DC blocker'

Toggle GetDcBlocker()

Returns

Toggle

GetInputVolume(ValueScalingMode)

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

int GetInputVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMix(ValueScalingMode)

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

int GetMix(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMode()

Original name: 4 'Mode'

Quality GetMode()

Returns

Quality

GetOutputVolume(ValueScalingMode)

Value range: displayed: 0 to 512, real: 0 to 512 Original name: 2 'Output volume'

int GetOutputVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSymmetric()

Original name: 3 'Symmetric'

Toggle GetSymmetric()

Returns

Toggle

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

Parameters

value Toggle

Returns

PatternEvent

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

Parameters

value int

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

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value Toggle

Returns

PatternEvent

ReadCurveValueMap(float[])

Maps input to output.

Read from curve 0 of WaveShaper.

The curve contains 256 values in range of 0 to 1.
int ReadCurveValueMap(float[] buffer)

Parameters

buffer float[]

Returns

int

SetDcBlocker(Toggle)

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

void SetDcBlocker(Toggle value)

Parameters

value Toggle

SetInputVolume(int, ValueScalingMode)

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

Parameters

value int
valueScalingMode ValueScalingMode

SetMix(int, ValueScalingMode)

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

SetOutputVolume(int, ValueScalingMode)

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

Parameters

value int
valueScalingMode ValueScalingMode

SetSymmetric(Toggle)

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

void SetSymmetric(Toggle value)

Parameters

value Toggle

WriteCurveValueMap(float[])

Maps input to output.

Write to curve 0 of WaveShaper.

The curve contains 256 values in range of 0 to 1.
int WriteCurveValueMap(float[] buffer)

Parameters

buffer float[]

Returns

int