Interface IVibratoModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

Vibrato effect.

public interface IVibratoModuleHandle : 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: 1 'Amplitude'

int GetAmplitude(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetChannels()

Original name: 3 'Channels'

Channels GetChannels()

Returns

Channels

GetExponentialAmplitude()

Original name: 6 'Exponential amplitude'

Toggle GetExponentialAmplitude()

Returns

Toggle

GetFreq(ValueScalingMode)

Value range: displayed: 1 to 2048, real: 1 to 2048 Original name: 2 'Freq'

int GetFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFrequencyUnit()

Original name: 5 'Frequency unit'

VibratoFrequencyUnit GetFrequencyUnit()

Returns

VibratoFrequencyUnit

GetSetPhase(ValueScalingMode)

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

int GetSetPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVolume(ValueScalingMode)

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

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

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

Parameters

value Toggle

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

PatternEvent MakeFreqEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeFrequencyUnitEvent(VibratoFrequencyUnit)

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

Parameters

value VibratoFrequencyUnit

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

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

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

SetAmplitude(int, ValueScalingMode)

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

SetExponentialAmplitude(Toggle)

Original name: 6 'Exponential 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 SetExponentialAmplitude(Toggle value)

Parameters

value Toggle

SetFreq(int, ValueScalingMode)

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

SetFrequencyUnit(VibratoFrequencyUnit)

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

Parameters

value VibratoFrequencyUnit

SetSetPhase(int, ValueScalingMode)

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

SetVolume(int, ValueScalingMode)

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