Struct EchoModuleHandle

Namespace

SunSharp.Modules

Assembly

SunSharp.dll

Stereo echo. Maximum delay length: 4 seconds.

public readonly struct EchoModuleHandle : IEchoModuleHandle, ITypedModuleHandle, IGenericSynthModuleHandle

Implements

IEchoModuleHandle

ITypedModuleHandle

IGenericSynthModuleHandle

Constructors

EchoModuleHandle(SynthModuleHandle)

public EchoModuleHandle(SynthModuleHandle moduleHandle)

Parameters

moduleHandle SynthModuleHandle

Properties

Id

Gets the ID of the synthesizer module.

public int Id { get; }

Property Value

int

ModuleHandle

public SynthModuleHandle ModuleHandle { get; }

Property Value

SynthModuleHandle

Slot

Gets the slot associated with this instance.

public ISlot Slot { get; }

Property Value

ISlot

Methods

AssertCorrectHandleType()

Throws an exception if the underlying module is not of the correct type.

public void AssertCorrectHandleType()

Exceptions

IncorrectSynthHandleTypeException

Thrown if the underlying module is not of the correct type.

ConnectInput(SynthModuleHandle)

Connect the input of this module to the output of another module.

public void ConnectInput(SynthModuleHandle targetModule)

Parameters

targetModule SynthModuleHandle

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_connect_module(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

ConnectOutput(SynthModuleHandle)

Connect the output of this module to the input of another module.

public void ConnectOutput(SynthModuleHandle targetModule)

Parameters

targetModule SynthModuleHandle

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_connect_module(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

DisconnectInput(SynthModuleHandle)

Disconnect the input of this module from the output of another module.

public void DisconnectInput(SynthModuleHandle targetModule)

Parameters

targetModule SynthModuleHandle

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_connect_module(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

DisconnectOutput(SynthModuleHandle)

Disconnect the output of this module from the input of another module.

public void DisconnectOutput(SynthModuleHandle targetModule)

Parameters

targetModule SynthModuleHandle

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_connect_module(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

GetColor()

Get the module color.

public (byte, byte, byte) GetColor()

Returns

(byte R, byte G, byte B)

RGB color tuple (r, g, b).

Remarks

Calls sv_get_module_color(int, int).

GetDelay(ValueScalingMode)

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

public int GetDelay(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetDelayUnit()

Original name: 5 'Delay unit'

public EchoDelayUnit GetDelayUnit()

Returns

EchoDelayUnit

GetDry(ValueScalingMode)

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

public int GetDry(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetExists()

Check if a module exists.

public bool GetExists()

Returns

bool

true if module exists.

Remarks

Calls sv_get_module_flags(int, int).

GetFFreq(ValueScalingMode)

Value range: displayed: 0 to 22000, real: 0 to 22000 Original name: 8 'F.freq'

public int GetFFreq(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFeedback(ValueScalingMode)

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

public int GetFeedback(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetFilter()

Original name: 7 'Filter'

public EchoFilter GetFilter()

Returns

EchoFilter

GetFineTune()

Get the module fine tune and relative note values.

public FineTunePair GetFineTune()

Returns

FineTunePair

Fine tune pair containing fine tune value and relative note.

Remarks

Calls sv_get_module_finetune(int, int).

GetFlags()

Get the module flags.

public ModuleFlags GetFlags()

Returns

ModuleFlags

Module flags indicating existence, type, state, and connections.

Remarks

Calls sv_get_module_flags(int, int).

GetInputModules()

Get the array of input modules connected to this module.

public SynthModuleHandle[] GetInputModules()

Returns

SynthModuleHandle[]

Array of connected input module numbers.

Remarks

Calls sv_get_module_inputs(int, int).

GetInputs()

Get the array of input module numbers connected to this module.

public int[] GetInputs()

Returns

int[]

Array of connected input module numbers.

Remarks

Calls sv_get_module_inputs(int, int).

GetModuleType()

Returns the module type. If the module does not exist, returns null. If the module type is unknown (due to library mismatch or otherwise), returns Unknown.

public SynthModuleType? GetModuleType()

Returns

SynthModuleType?

GetName()

Get the module name.

public string? GetName()

Returns

string

Module name, or null if unavailable.

Remarks

Calls sv_get_module_name(int, int).

GetOutputModules()

Gets the array of output modules connected to this module.

public SynthModuleHandle[] GetOutputModules()

Returns

SynthModuleHandle[]

Array of connected output module numbers.

Remarks

Calls sv_get_module_outputs(int, int).

GetOutputs()

Get the array of output module numbers connected from this module.

public int[] GetOutputs()

Returns

int[]

Array of connected output module numbers.

Remarks

Calls sv_get_module_outputs(int, int).

GetPosition()

Get the module position on the canvas.

public (int, int) GetPosition()

Returns

(int x, int y)

Tuple containing X and Y coordinates.

Remarks

Calls sv_get_module_xy(int, int).

GetRightChannelOffset()

Original name: 4 'Right channel offset'

public Toggle GetRightChannelOffset()

Returns

Toggle

GetRightChannelOffsetDelay(ValueScalingMode)

Expressed as Delay/32768.
Value range: displayed: 0 to 32768, real: 0 to 32768 Original name: 6 'Right channel offset'

public int GetRightChannelOffsetDelay(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetWet(ValueScalingMode)

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

public int GetWet(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

IsCorrectHandleType()

Determines whether the underlying module is of the correct type.

public bool IsCorrectHandleType()

Returns

bool

MakeDelayEvent(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.

public PatternEvent MakeDelayEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeDelayUnitEvent(EchoDelayUnit)

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.

public PatternEvent MakeDelayUnitEvent(EchoDelayUnit value)

Parameters

value EchoDelayUnit

Returns

PatternEvent

MakeDryEvent(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.

public PatternEvent MakeDryEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeEvent(Note, byte?, byte?, Effect, ushort)

Creates a new generic pattern event with optional parameters for flexible event construction.

public PatternEvent MakeEvent(Note note = default, byte? velocity = null, byte? controller = null, Effect effect = Effect.None, ushort value = 0)

Parameters

note Note

Note value. Allows for explicit note commands.

velocity byte?

Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data.

controller byte?

Controller identifier (0-based). Returns null when no controller is specified. Module controllers: 0-126 (raw data: 1-127). MIDI controllers: 127+ (raw data: 0x80+). Automatically handles the +1 offset used in raw data.

effect Effect

Pattern event effect code.

value ushort

Parameter value for controller or effect (16-bit unsigned integer).

Range: 0-32768 (0x8000) for controllers, 0-65535 (0xFFFF) for effects.

For pitch commands: 0x0000 = highest pitch, 0x7800 = C0, 0x100 = one semitone.

Returns

PatternEvent

A new PatternEvent with the specified fields.

Remarks

This method provides maximum flexibility for creating events. For common scenarios, consider using specific factory methods like NoteEvent(Note, int?, byte?), ControllerEvent(int, byte, ushort), etc.

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

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

public PatternEvent MakeFeedbackEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeFilterEvent(EchoFilter)

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.

public PatternEvent MakeFilterEvent(EchoFilter value)

Parameters

value EchoFilter

Returns

PatternEvent

MakeNoteEvent(Note, byte?)

Creates a note event that triggers a note on the specified module.

public PatternEvent MakeNoteEvent(Note note, byte? velocity = null)

Parameters

note Note

Note value. Allows for explicit note commands.

velocity byte?

Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data.

Returns

PatternEvent

MakeRightChannelOffsetDelayEvent(int)

Expressed as Delay/32768.

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.

public PatternEvent MakeRightChannelOffsetDelayEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeRightChannelOffsetEvent(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.

public PatternEvent MakeRightChannelOffsetEvent(Toggle value)

Parameters

value Toggle

Returns

PatternEvent

MakeSetControllerValueEvent(byte, ushort)

Creates a controller event that changes a module parameter.

public PatternEvent MakeSetControllerValueEvent(byte controllerId, ushort value)

Parameters

controllerId byte

value ushort

Parameter value for controller or effect (16-bit unsigned integer).

Range: 0-32768 (0x8000) for controllers, 0-65535 (0xFFFF) for effects.

For pitch commands: 0x0000 = highest pitch, 0x7800 = C0, 0x100 = one semitone.

Returns

PatternEvent

Remarks

For better type safety and readability, consider using typed module handles and extension methods.

MakeSetFrequencyEvent(double, byte?)

Creates a Set Pitch event by converting a frequency in Hz to the appropriate pitch value.

public PatternEvent MakeSetFrequencyEvent(double frequency, byte? velocity = null)

Parameters

frequency double

Frequency in Hz (e.g., 440.0 for A4).

velocity byte?

Velocity value (0-128). Use null for default velocity.

Returns

PatternEvent

A new PatternEvent with the calculated pitch value.

Examples

// Set pitch to A4 (440 Hz)
var a440 = PatternEvent.SetFrequencyEvent(0, 440.0, 100);
// Set pitch to middle C (261.63 Hz)
var c4 = PatternEvent.SetFrequencyEvent(0, 261.63);

MakeSetPitchEvent(ushort, byte?)

Creates a Set Pitch event with exact pitch value for microtonal or pitch-bend effects.

public PatternEvent MakeSetPitchEvent(ushort pitch, byte? velocity = null)

Parameters

pitch ushort

Pitch value where 0x0000 = highest pitch, 0x7800 = C0 (lowest), 0x100 = one semitone.

velocity byte?

Velocity value (0-128). Use null for default velocity.

Returns

PatternEvent

A new PatternEvent configured as a set pitch event.

Examples

// Set pitch to middle C (C4 = 0x3C00)
var middleC = PatternEvent.SetPitchEvent(0, 0x3C00);
// Set pitch to A4 (440Hz reference = 0x4500)
var a440 = PatternEvent.SetPitchEvent(0, 0x4500, 100);

MakeWetEvent(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.

public PatternEvent MakeWetEvent(int value)

Parameters

value int

Returns

PatternEvent

ReadScope(AudioChannel, short[])

Read module scope view, and write it to a buffer.

public int ReadScope(AudioChannel channel, short[] buffer)

Parameters

channel AudioChannel

Audio channel.

buffer short[]

Buffer to receive scope data.

Returns

int

Number of samples successfully read.

Remarks

Calls sv_get_module_scope2(int, int, int, IntPtr, uint).

Exceptions

ArgumentNullException

Thrown if buffer is null.

SetColor(byte, byte, byte)

Set the module color.

public void SetColor(byte r, byte g, byte b)

Parameters

r byte

Red component (0 to 255).

g byte

Green component (0 to 255).

b byte

Blue component (0 to 255).

Remarks

Calls sv_set_module_color(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

SetDelay(int, ValueScalingMode)

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

public void SetDelay(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetDelayUnit(EchoDelayUnit)

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

public void SetDelayUnit(EchoDelayUnit value)

Parameters

value EchoDelayUnit

SetDry(int, ValueScalingMode)

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

public void SetDry(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetFFreq(int, ValueScalingMode)

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

public void SetFFreq(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetFeedback(int, ValueScalingMode)

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

public void SetFeedback(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetFilter(EchoFilter)

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

public void SetFilter(EchoFilter value)

Parameters

value EchoFilter

SetFineTune(FineTunePair)

Sets the fine tune for the module.

public void SetFineTune(FineTunePair fineTune)

Parameters

fineTune FineTunePair

SetName(string)

Set the module name.

public void SetName(string name)

Parameters

name string

New module name.

Remarks

Calls sv_set_module_name(int, int, IntPtr).

Exceptions

SunVoxException

Thrown when the operation fails.

ArgumentNullException

Thrown if name is null.

SetPosition(int, int)

Set the module position.

public void SetPosition(int x, int y)

Parameters

x int

X coordinate (center: 512, working area: 0 to 1024).

y int

Y coordinate (center: 512, working area: 0 to 1024).

Remarks

Calls sv_set_module_xy(int, int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

SetRightChannelOffset(Toggle)

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

public void SetRightChannelOffset(Toggle value)

Parameters

value Toggle

SetRightChannelOffsetDelay(int, ValueScalingMode)

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

public void SetRightChannelOffsetDelay(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

SetWet(int, ValueScalingMode)

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

public void SetWet(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int

valueScalingMode ValueScalingMode

Operators

implicit operator SynthModuleHandle(EchoModuleHandle)

public static implicit operator SynthModuleHandle(EchoModuleHandle handle)

Parameters

handle EchoModuleHandle

Returns

SynthModuleHandle