Table of Contents

Struct MetaModuleModuleHandle

Namespace
SunSharp.Modules
Assembly
SunSharp.dll

MetaModule is a full-featured copy of SunVox in a single module. So you can include one SunVox-project into another recursively.

public readonly struct MetaModuleModuleHandle : IMetaModuleModuleHandle, ITypedModuleHandle, IGenericSynthModuleHandle
Implements

Constructors

MetaModuleModuleHandle(SynthModuleHandle) 

public MetaModuleModuleHandle(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.

GetBeatsPerMinute(ValueScalingMode)

Original name: 3 'BPM (Beats Per Minute)'

public int GetBeatsPerMinute(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

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).

GetExists()

Check if a module exists.

public bool GetExists()

Returns

bool

true if module exists.

Remarks

Calls sv_get_module_flags(int, int).

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).

GetInputModule(ValueScalingMode)

Original name: 1 'Input module'

public int GetInputModule(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

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).

GetPlayPatterns()

Original name: 2 'Play patterns'

public MetaModulePatternMode GetPlayPatterns()

Returns

MetaModulePatternMode

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).

GetTicksPerLine(ValueScalingMode)

Original name: 4 'TPL (Ticks Per Line)'

public int GetTicksPerLine(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

valueScalingMode ValueScalingMode

Returns

int

GetUserControllerCount()

Get the count of a user-defined controllers. User-defined controllers start at index 5.

Get the number of controllers in the module.

public int GetUserControllerCount()

Returns

int

Number of controllers.

Remarks

Calls sv_get_number_of_module_ctls(int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

GetUserControllerMaxValue(int, ValueScalingMode)

Get the maximum value of a user-defined controller. User-defined controllers start at index 5.

Get the controller maximum value.

public void GetUserControllerMaxValue(int index, ValueScalingMode scalingMode)

Parameters

index int
scalingMode ValueScalingMode

Value scaling mode.

Remarks

Calls sv_get_module_ctl_max(int, int, int, int).

GetUserControllerMinValue(int, ValueScalingMode)

Get the minimum value of a user-defined controller. User-defined controllers start at index 5.

Get the controller minimum value.

public void GetUserControllerMinValue(int index, ValueScalingMode scalingMode)

Parameters

index int
scalingMode ValueScalingMode

Value scaling mode.

Remarks

Calls sv_get_module_ctl_min(int, int, int, int).

GetUserControllerName(int)

Get the name of a user-defined controller. User-defined controllers start at index 5.

Get the controller name.

public string? GetUserControllerName(int index)

Parameters

index int

Returns

string

Controller name, or null if unavailable.

Remarks

Calls sv_get_module_ctl_name(int, int, int).

GetUserControllerOffset(int)

Get the offset value of a user-defined controller. User-defined controllers start at index 5.

Get the controller display value offset.

public void GetUserControllerOffset(int index)

Parameters

index int

Remarks

Calls sv_get_module_ctl_offset(int, int, int).

GetUserControllerType(int)

Get the type of a user-defined controller. User-defined controllers start at index 5.

Get the controller type.

public ControllerType GetUserControllerType(int index)

Parameters

index int

Returns

ControllerType

Controller type.

Remarks

Calls sv_get_module_ctl_type(int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

GetUserControllerValue(int, ValueScalingMode)

Get the value of a user-defined controller. User-defined controllers start at index 5.

Get the controller value.

public void GetUserControllerValue(int index, ValueScalingMode scalingMode)

Parameters

index int
scalingMode ValueScalingMode

Value scaling mode.

Remarks

Calls sv_get_module_ctl_value(int, int, int, int).

GetVolume(ValueScalingMode)

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

public int GetVolume(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

LoadFile(byte[])

Load a file into a MetaModule from memory. Supported file formats: sunvox, mod, xm, midi.

public void LoadFile(byte[] data)

Parameters

data byte[]

Byte array with project data.

Remarks

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

Exceptions

SunVoxException

Thrown when the operation fails.

ArgumentNullException

Thrown if data is null.

LoadFile(string)

Load a file into a MetaModule. Supported file formats: sunvox, mod, xm, midi.

public void LoadFile(string path)

Parameters

path string

File path (relative or absolute).

Remarks

Calls sv_metamodule_load(int, int, IntPtr).

Exceptions

SunVoxException

Thrown when the operation fails.

ArgumentNullException

Thrown if path is null.

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

public PatternEvent MakeBeatsPerMinuteEvent(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.

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

public PatternEvent MakeInputModuleEvent(int value)

Parameters

value int

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

MakePlayPatternsEvent(MetaModulePatternMode)

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 MakePlayPatternsEvent(MetaModulePatternMode value)

Parameters

value MetaModulePatternMode

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);

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

public PatternEvent MakeTicksPerLineEvent(int value)

Parameters

value int

Returns

PatternEvent

MakeUserControllerEvent(int, int, int, int, int)

Make a pattern event that sets a user-defined controller value. User-defined controllers start at index 5.

This overload allows for using display-values, as long as offset, min and max values of the controller are known..

public PatternEvent MakeUserControllerEvent(int index, int value, int offset, int minValue, int maxValue)

Parameters

index int
value int
offset int
minValue int
maxValue int

Returns

PatternEvent

MakeUserControllerEvent(int, ushort)

Make a pattern event that sets a user-defined controller value. User-defined controllers start at index 5.

This overload allows for raw column values to be used. Values are clamped to the 0x0 to 0x8000 range.

public PatternEvent MakeUserControllerEvent(int index, ushort value)

Parameters

index int
value ushort

Returns

PatternEvent

MakeUserControllerEvent<T>(int, T)

Make a pattern event that sets a user-defined controller value. User-defined controllers start at index 5.

This overload allows for any enum value to be used.

public PatternEvent MakeUserControllerEvent<T>(int index, T value) where T : Enum, IConvertible

Parameters

index int
value T

Returns

PatternEvent

Type Parameters

T

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

public PatternEvent MakeVolumeEvent(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.

SetBeatsPerMinute(int, ValueScalingMode)

Original name: 3 'BPM (Beats Per Minute)' 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 SetBeatsPerMinute(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

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.

SetFineTune(FineTunePair)

Sets the fine tune for the module.

public void SetFineTune(FineTunePair fineTune)

Parameters

fineTune FineTunePair

SetInputModule(int, ValueScalingMode)

Original name: 1 'Input module' 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 SetInputModule(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

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.

SetPlayPatterns(MetaModulePatternMode)

Original name: 2 'Play patterns' 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 SetPlayPatterns(MetaModulePatternMode value)

Parameters

value MetaModulePatternMode

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.

SetTicksPerLine(int, ValueScalingMode)

Original name: 4 'TPL (Ticks Per Line)' 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 SetTicksPerLine(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)

Parameters

value int
valueScalingMode ValueScalingMode

SetUserControllerValue(int, int, ValueScalingMode)

Set the value of a user-defined controller. User-defined controllers start at index 5.

Set a controller value. Note: SendEvent(int, int, PatternEvent) will be used internally, which may introduce latency.

public void SetUserControllerValue(int index, int value, ValueScalingMode scalingMode)

Parameters

index int
value int

Controller value.

scalingMode ValueScalingMode

Value scaling mode.

Remarks

Calls sv_set_module_ctl_value(int, int, int, int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

SetVolume(int, ValueScalingMode)

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

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

Parameters

value int
valueScalingMode ValueScalingMode

Operators

implicit operator SynthModuleHandle(MetaModuleModuleHandle) 

public static implicit operator SynthModuleHandle(MetaModuleModuleHandle handle)

Parameters

handle MetaModuleModuleHandle

Returns

SynthModuleHandle
Edit this page