Table of Contents

Interface IPitchShifterModuleHandle

Namespace
SunSharp.Modules
Assembly
SunSharp.dll

Pitch shifter is a module for changing the pitch of any sound in real time. The signal at the output of the module is always slightly delayed.

public interface IPitchShifterModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle
Inherited Members

Methods

GetBypassIfPitch0()

Original name: 6 'Bypass if pitch=0'

PitchShifterBypassMode GetBypassIfPitch0()

Returns

PitchShifterBypassMode

GetFeedback(ValueScalingMode)

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

int GetFeedback(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetGrainSize(ValueScalingMode)

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

int GetGrainSize(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetMode()

Original name: 5 'Mode'

Quality GetMode()

Returns

Quality

GetPitch(ValueScalingMode)

Value range: displayed: -600 to 600, real: 0 to 1200 Original name: 1 'Pitch'

int GetPitch(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetPitchScale(ValueScalingMode)

Value range: displayed: 0 to 200, real: 0 to 200 Original name: 2 'Pitch scale'

int GetPitchScale(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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

MakeBypassIfPitch0Event(PitchShifterBypassMode)

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 MakeBypassIfPitch0Event(PitchShifterBypassMode value)

Parameters

value PitchShifterBypassMode

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

PatternEvent MakeFeedbackEvent(int value)

Parameters

value int

Returns

PatternEvent

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

Parameters

value int

Returns

PatternEvent

MakeModeEvent(Quality)

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

Parameters

value Quality

Returns

PatternEvent

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

PatternEvent MakePitchEvent(int value)

Parameters

value int

Returns

PatternEvent

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

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

PatternEvent MakeVolumeEvent(int value)

Parameters

value int

Returns

PatternEvent

SetBypassIfPitch0(PitchShifterBypassMode)

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

void SetBypassIfPitch0(PitchShifterBypassMode value)

Parameters

value PitchShifterBypassMode

SetFeedback(int, ValueScalingMode)

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

SetGrainSize(int, ValueScalingMode)

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

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

Parameters

value int
valueScalingMode ValueScalingMode

SetMode(Quality)

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

Parameters

value Quality

SetPitch(int, ValueScalingMode)

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

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

Parameters

value int
valueScalingMode ValueScalingMode

SetPitchScale(int, ValueScalingMode)

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

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

Parameters

value int
valueScalingMode ValueScalingMode

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