Interface IPitchDetectorModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

Pitch Detector tries to detect the pitch of the incoming audio signal. The frequency and note will be displayed. Notes will be sent to the module output.

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

GetAlgBufOverlap12(ValueScalingMode)

Value range: displayed: 0 to 100, real: 0 to 100 Original name: 9 'Alg1-2 Buf overlap'

int GetAlgBufOverlap12(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetAlgBufferMs12()

Original name: 8 'Alg1-2 Buffer (ms)'

PitchDetectorBufferSize GetAlgBufferMs12()

Returns

PitchDetectorBufferSize

GetAlgSampleRateHz12()

Original name: 7 'Alg1-2 Sample rate (Hz)'

PitchDetectorAlgSampleRate GetAlgSampleRateHz12()

Returns

PitchDetectorAlgSampleRate

GetAlgSensitivityAbsoluteThreshold1(ValueScalingMode)

Value range: displayed: 0 to 100, real: 0 to 100 Original name: 10 'Alg1 Sensitivity (absolute threshold)'

int GetAlgSensitivityAbsoluteThreshold1(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetAlgorithm()

Original name: 0 'Algorithm'

PitchDetectorAlgorithm GetAlgorithm()

Returns

PitchDetectorAlgorithm

GetDetectorFineTune(ValueScalingMode)

Value range: displayed: -256 to 256, real: 0 to 512 Original name: 4 'Detector finetune'

int GetDetectorFineTune(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetGain(ValueScalingMode)

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

int GetGain(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLpFilterFreqOff0(ValueScalingMode)

Value range: displayed: 0 to 4000, real: 0 to 4000 Original name: 5 'LP filter freq (0 - OFF)'

int GetLpFilterFreqOff0(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetLpFilterRollOff()

Original name: 6 'LP filter roll-off'

FilterRollOff GetLpFilterRollOff()

Returns

FilterRollOff

GetMicrotones()

Original name: 3 'Microtones'

Toggle GetMicrotones()

Returns

Toggle

GetRecordNotes()

Original name: 11 'Record notes'

Toggle GetRecordNotes()

Returns

Toggle

GetThreshold(ValueScalingMode)

Value range: displayed: 0 to 10000, real: 0 to 10000 Original name: 1 'Threshold'

int GetThreshold(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

PatternEvent MakeAlgBufOverlap12Event(int value)

Parameters

value int

Returns

PatternEvent

MakeAlgBufferMs12Event(PitchDetectorBufferSize)

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 MakeAlgBufferMs12Event(PitchDetectorBufferSize value)

Parameters

value PitchDetectorBufferSize

Returns

PatternEvent

MakeAlgSampleRateHz12Event(PitchDetectorAlgSampleRate)

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 MakeAlgSampleRateHz12Event(PitchDetectorAlgSampleRate value)

Parameters

value PitchDetectorAlgSampleRate

Returns

PatternEvent

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

PatternEvent MakeAlgSensitivityAbsoluteThreshold1Event(int value)

Parameters

value int

Returns

PatternEvent

MakeAlgorithmEvent(PitchDetectorAlgorithm)

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 MakeAlgorithmEvent(PitchDetectorAlgorithm value)

Parameters

value PitchDetectorAlgorithm

Returns

PatternEvent

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

PatternEvent MakeDetectorFineTuneEvent(int value)

Parameters

value int

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

PatternEvent MakeGainEvent(int value)

Parameters

value int

Returns

PatternEvent

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

PatternEvent MakeLpFilterFreqOff0Event(int value)

Parameters

value int

Returns

PatternEvent

MakeLpFilterRollOffEvent(FilterRollOff)

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 MakeLpFilterRollOffEvent(FilterRollOff value)

Parameters

value FilterRollOff

Returns

PatternEvent

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

Parameters

value Toggle

Returns

PatternEvent

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

Parameters

value Toggle

Returns

PatternEvent

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

PatternEvent MakeThresholdEvent(int value)

Parameters

value int

Returns

PatternEvent

SetAlgBufOverlap12(int, ValueScalingMode)

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

Parameters

value int

valueScalingMode ValueScalingMode

SetAlgBufferMs12(PitchDetectorBufferSize)

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

void SetAlgBufferMs12(PitchDetectorBufferSize value)

Parameters

value PitchDetectorBufferSize

SetAlgSampleRateHz12(PitchDetectorAlgSampleRate)

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

void SetAlgSampleRateHz12(PitchDetectorAlgSampleRate value)

Parameters

value PitchDetectorAlgSampleRate

SetAlgSensitivityAbsoluteThreshold1(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetAlgorithm(PitchDetectorAlgorithm)

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

void SetAlgorithm(PitchDetectorAlgorithm value)

Parameters

value PitchDetectorAlgorithm

SetDetectorFineTune(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetGain(int, ValueScalingMode)

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

SetLpFilterFreqOff0(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode

SetLpFilterRollOff(FilterRollOff)

Original name: 6 'LP filter roll-off' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.

void SetLpFilterRollOff(FilterRollOff value)

Parameters

value FilterRollOff

SetMicrotones(Toggle)

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

void SetMicrotones(Toggle value)

Parameters

value Toggle

SetRecordNotes(Toggle)

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

void SetRecordNotes(Toggle value)

Parameters

value Toggle

SetThreshold(int, ValueScalingMode)

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

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

Parameters

value int

valueScalingMode ValueScalingMode