Interface ISoundToControlModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

This module converts the audio signal to the numeric value of any selected controller.

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

GetAbsolute()

Original name: 2 'Absolute'

Toggle GetAbsolute()

Returns

Toggle

GetChannels()

Original name: 1 'Channels'

ChannelsInverted GetChannels()

Returns

ChannelsInverted

GetGain(ValueScalingMode)

Value range: displayed: 0 to 1024, real: 0 to 1024 Original name: 3 'Gain'

int GetGain(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMode()

Original name: 5 'Mode'

SoundToControlMode GetMode()

Returns

SoundToControlMode

GetOutController(ValueScalingMode)

Original name: 8 'OUT controller'

int GetOutController(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetOutMax(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 7 'OUT max'

int GetOutMax(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetOutMin(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'OUT min'

int GetOutMin(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSampleRate(ValueScalingMode)

Value range: displayed: 1 to 32768, real: 1 to 32768 Original name: 0 'Sample rate'

int GetSampleRate(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSmooth(ValueScalingMode)

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

int GetSmooth(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

Parameters

value Toggle

Returns

PatternEvent

MakeChannelsEvent(ChannelsInverted)

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

Parameters

value ChannelsInverted

Returns

PatternEvent

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

PatternEvent MakeGainEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeModeEvent(SoundToControlMode)

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

Parameters

value SoundToControlMode

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

PatternEvent MakeSampleRateEvent(int value)

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

SetAbsolute(Toggle)

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

void SetAbsolute(Toggle value)

Parameters

value Toggle

SetChannels(ChannelsInverted)

Original name: 1 '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(ChannelsInverted value)

Parameters

value ChannelsInverted

SetGain(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetMode(SoundToControlMode)

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

Parameters

value SoundToControlMode

SetOutController(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetOutMax(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetOutMin(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetSampleRate(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetSmooth(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode