Interface IFftModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

FFT-based frequency transformator.

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

GetAllPassFilter(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 7 'All-pass filter'

int GetAllPassFilter(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetBufOverlap()

Original name: 3 'Buf overlap'

FftBufferOverlap GetBufOverlap()

Returns

FftBufferOverlap

GetBufferSamples()

Original name: 2 'Buffer (samples)'

FftBufferSize GetBufferSamples()

Returns

FftBufferSize

GetChannels()

Original name: 1 'Channels'

ChannelsInverted GetChannels()

Returns

ChannelsInverted

GetDeform1(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 12 'Deform1'

int GetDeform1(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDeform2(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 13 'Deform2'

int GetDeform2(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFeedback(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 4 'Feedback'

int GetFeedback(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFreqShift(ValueScalingMode)

Value range: displayed: -4096 to 4096, real: 0 to 8192 Original name: 11 'Freq shift'

int GetFreqShift(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFrequencySpread(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 8 'Frequency spread'

int GetFrequencySpread(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetHpCutoff(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 14 'HP cutoff'

int GetHpCutoff(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLpCutoff(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 15 'LP cutoff'

int GetLpCutoff(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetNoiseReduction(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 5 'Noise reduction'

int GetNoiseReduction(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetPhaseGainNorm16384(ValueScalingMode)

Original name: 6 'Phase gain (norm=16384)'

int GetPhaseGainNorm16384(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRandomPhase(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 9 'Random phase'

int GetRandomPhase(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRandomPhaseLite(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 10 'Random phase (lite)'

int GetRandomPhaseLite(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetSampleRate()

Original name: 0 'Sample rate'

FftSampleRate GetSampleRate()

Returns

FftSampleRate

GetVolume(ValueScalingMode)

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

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

Parameters

value int

Returns

PatternEvent

MakeBufOverlapEvent(FftBufferOverlap)

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 MakeBufOverlapEvent(FftBufferOverlap value)

Parameters

value FftBufferOverlap

Returns

PatternEvent

MakeBufferSamplesEvent(FftBufferSize)

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 MakeBufferSamplesEvent(FftBufferSize value)

Parameters

value FftBufferSize

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

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

Parameters

value int

Returns

PatternEvent

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

PatternEvent MakeFeedbackEvent(int value)

Parameters

value int

Returns

PatternEvent

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

PatternEvent MakeFreqShiftEvent(int value)

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

MakeSampleRateEvent(FftSampleRate)

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 MakeSampleRateEvent(FftSampleRate value)

Parameters

value FftSampleRate

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

SetAllPassFilter(int, ValueScalingMode)

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

Parameters

value int

valueScalingMode ValueScalingMode

SetBufOverlap(FftBufferOverlap)

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

void SetBufOverlap(FftBufferOverlap value)

Parameters

value FftBufferOverlap

SetBufferSamples(FftBufferSize)

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

void SetBufferSamples(FftBufferSize value)

Parameters

value FftBufferSize

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

SetDeform1(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetDeform2(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetFeedback(int, ValueScalingMode)

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

SetFreqShift(int, ValueScalingMode)

Value range: displayed: -4096 to 4096, real: 0 to 8192 Original name: 11 'Freq shift' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

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

Parameters

value int

valueScalingMode ValueScalingMode

SetFrequencySpread(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetHpCutoff(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetLpCutoff(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetNoiseReduction(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetPhaseGainNorm16384(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetRandomPhase(int, ValueScalingMode)

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

Parameters

value int

valueScalingMode ValueScalingMode

SetRandomPhaseLite(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetSampleRate(FftSampleRate)

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

Parameters

value FftSampleRate

SetVolume(int, ValueScalingMode)

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