Interface IVocalFilterModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

Formant filter - designed to simulate the human vocal tract.

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

GetChannels()

Original name: 6 'Channels'

Channels GetChannels()

Returns

Channels

GetFormantWidth(ValueScalingMode)

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

int GetFormantWidth(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFormants(ValueScalingMode)

Original name: 3 'Formants'

int GetFormants(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetIntensity(ValueScalingMode)

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

int GetIntensity(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRandomFrequency(ValueScalingMode)

Value range: displayed: 0 to 1024, real: 0 to 1024 Original name: 7 'Random frequency'

int GetRandomFrequency(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetRandomSeed(ValueScalingMode)

Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 8 'Random seed'

int GetRandomSeed(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVoiceType()

Original name: 5 'Voice type'

VocalFilterVoiceType GetVoiceType()

Returns

VocalFilterVoiceType

GetVolume(ValueScalingMode)

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

int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetVowel1()

Original name: 9 'Vowel1'

VocalFilterVowel GetVowel1()

Returns

VocalFilterVowel

GetVowel2()

Original name: 10 'Vowel2'

VocalFilterVowel GetVowel2()

Returns

VocalFilterVowel

GetVowel3()

Original name: 11 'Vowel3'

VocalFilterVowel GetVowel3()

Returns

VocalFilterVowel

GetVowel4()

Original name: 12 'Vowel4'

VocalFilterVowel GetVowel4()

Returns

VocalFilterVowel

GetVowel5()

Original name: 13 'Vowel5'

VocalFilterVowel GetVowel5()

Returns

VocalFilterVowel

GetVowelAEIOU(ValueScalingMode)

Value range: displayed: 0 to 256, real: 0 to 256 Original name: 4 'Vowel (a,e,i,o,u)'

int GetVowelAEIOU(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

MakeVoiceTypeEvent(VocalFilterVoiceType)

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 MakeVoiceTypeEvent(VocalFilterVoiceType value)

Parameters

value VocalFilterVoiceType

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

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeVowel1Event(VocalFilterVowel)

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 MakeVowel1Event(VocalFilterVowel value)

Parameters

value VocalFilterVowel

Returns

PatternEvent

MakeVowel2Event(VocalFilterVowel)

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 MakeVowel2Event(VocalFilterVowel value)

Parameters

value VocalFilterVowel

Returns

PatternEvent

MakeVowel3Event(VocalFilterVowel)

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 MakeVowel3Event(VocalFilterVowel value)

Parameters

value VocalFilterVowel

Returns

PatternEvent

MakeVowel4Event(VocalFilterVowel)

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 MakeVowel4Event(VocalFilterVowel value)

Parameters

value VocalFilterVowel

Returns

PatternEvent

MakeVowel5Event(VocalFilterVowel)

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 MakeVowel5Event(VocalFilterVowel value)

Parameters

value VocalFilterVowel

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

SetChannels(Channels)

Original name: 6 '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

SetFormantWidth(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetFormants(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetIntensity(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetRandomFrequency(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetRandomSeed(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetVoiceType(VocalFilterVoiceType)

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

void SetVoiceType(VocalFilterVoiceType value)

Parameters

value VocalFilterVoiceType

SetVolume(int, ValueScalingMode)

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

SetVowel1(VocalFilterVowel)

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

void SetVowel1(VocalFilterVowel value)

Parameters

value VocalFilterVowel

SetVowel2(VocalFilterVowel)

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

void SetVowel2(VocalFilterVowel value)

Parameters

value VocalFilterVowel

SetVowel3(VocalFilterVowel)

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

void SetVowel3(VocalFilterVowel value)

Parameters

value VocalFilterVowel

SetVowel4(VocalFilterVowel)

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

void SetVowel4(VocalFilterVowel value)

Parameters

value VocalFilterVowel

SetVowel5(VocalFilterVowel)

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

void SetVowel5(VocalFilterVowel value)

Parameters

value VocalFilterVowel

SetVowelAEIOU(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode