Struct DrumSynthModuleHandle
Drum synthesizer with variety of predefined sounds. The sound quality of this module is better at a sample rate of 44100Hz.
public readonly struct DrumSynthModuleHandle : IDrumSynthModuleHandle, ITypedModuleHandle, IGenericSynthModuleHandle
- Implements
Constructors
DrumSynthModuleHandle(SynthModuleHandle)
public DrumSynthModuleHandle(SynthModuleHandle moduleHandle)
Parameters
moduleHandleSynthModuleHandle
Properties
Id
Gets the ID of the synthesizer module.
public int Id { get; }
Property Value
- int
ModuleHandle
public SynthModuleHandle ModuleHandle { get; }
Property Value
Slot
Gets the slot associated with this instance.
public ISlot Slot { get; }
Property Value
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
targetModuleSynthModuleHandle
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
targetModuleSynthModuleHandle
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
targetModuleSynthModuleHandle
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
targetModuleSynthModuleHandle
Remarks
Requires LockSlot(int) / UnlockSlot(int).
Calls sv_connect_module(int, int, int).Exceptions
- SunVoxException
Thrown when the operation fails.
GetBassLength(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 6 'Bass length'
public int GetBassLength(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetBassPanning(ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 12 'Bass panning'
public int GetBassPanning(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetBassPower(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 4 'Bass power'
public int GetBassPower(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetBassTone(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 5 'Bass tone'
public int GetBassTone(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetBassVolume(ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 3 'Bass volume'
public int GetBassVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
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
GetExists()
Check if a module exists.
public bool GetExists()
Returns
- bool
true if module exists.
Remarks
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
GetFlags()
Get the module flags.
public ModuleFlags GetFlags()
Returns
- ModuleFlags
Module flags indicating existence, type, state, and connections.
Remarks
GetHihatLength(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 8 'Hihat length'
public int GetHihatLength(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetHihatPanning(ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 13 'Hihat panning'
public int GetHihatPanning(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetHihatVolume(ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 7 'Hihat volume'
public int GetHihatVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
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
GetInputs()
Get the array of input module numbers connected to this module.
public int[] GetInputs()
Returns
- int[]
Array of connected input module numbers.
Remarks
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
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
GetOutputs()
Get the array of output module numbers connected from this module.
public int[] GetOutputs()
Returns
- int[]
Array of connected output module numbers.
Remarks
GetPanning(ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 1 'Panning'
public int GetPanning(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetPolyphony(ValueScalingMode)
Original name: 2 'Polyphony'
public int GetPolyphony(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- 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).
GetSnareLength(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 11 'Snare length'
public int GetSnareLength(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetSnarePanning(ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 14 'Snare panning'
public int GetSnarePanning(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetSnareTone(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 10 'Snare tone'
public int GetSnareTone(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetSnareVolume(ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 9 'Snare volume'
public int GetSnareVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetVolume(ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 0 'Volume'
public int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
IsCorrectHandleType()
Determines whether the underlying module is of the correct type.
public bool IsCorrectHandleType()
Returns
- bool
MakeBassLengthEvent(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 MakeBassLengthEvent(int value)
Parameters
valueint
Returns
MakeBassPanningEvent(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 (-128 to 128) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeBassPanningEvent(int value)
Parameters
valueint
Returns
MakeBassPowerEvent(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 MakeBassPowerEvent(int value)
Parameters
valueint
Returns
MakeBassToneEvent(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 MakeBassToneEvent(int value)
Parameters
valueint
Returns
MakeBassVolumeEvent(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.
public PatternEvent MakeBassVolumeEvent(int value)
Parameters
valueint
Returns
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
noteNoteNote value. Allows for explicit note commands. velocitybyte?Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data. controllerbyte?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. effectEffectPattern event effect code. valueushortParameter 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.
MakeHihatLengthEvent(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 MakeHihatLengthEvent(int value)
Parameters
valueint
Returns
MakeHihatPanningEvent(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 (-128 to 128) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeHihatPanningEvent(int value)
Parameters
valueint
Returns
MakeHihatVolumeEvent(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.
public PatternEvent MakeHihatVolumeEvent(int value)
Parameters
valueint
Returns
MakeNoteEvent(Note, byte?)
Creates a note event that triggers a note on the specified module.
public PatternEvent MakeNoteEvent(Note note, byte? velocity = null)
Parameters
noteNoteNote value. Allows for explicit note commands. velocitybyte?Note velocity. Returns null when default velocity is used. Automatically handles the +1 offset used in raw data.
Returns
MakePanningEvent(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 (-128 to 128) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakePanningEvent(int value)
Parameters
valueint
Returns
MakePolyphonyEvent(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 MakePolyphonyEvent(int value)
Parameters
valueint
Returns
MakeSetControllerValueEvent(byte, ushort)
Creates a controller event that changes a module parameter.
public PatternEvent MakeSetControllerValueEvent(byte controllerId, ushort value)
Parameters
controllerIdbytevalueushortParameter 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
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
frequencydoubleFrequency in Hz (e.g., 440.0 for A4).
velocitybyte?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
pitchushortPitch value where 0x0000 = highest pitch, 0x7800 = C0 (lowest), 0x100 = one semitone.
velocitybyte?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);
MakeSnareLengthEvent(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 MakeSnareLengthEvent(int value)
Parameters
valueint
Returns
MakeSnarePanningEvent(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 (-128 to 128) to column range (0 to 0x8000). Out of range values are clamped.
public PatternEvent MakeSnarePanningEvent(int value)
Parameters
valueint
Returns
MakeSnareToneEvent(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 MakeSnareToneEvent(int value)
Parameters
valueint
Returns
MakeSnareVolumeEvent(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.
public PatternEvent MakeSnareVolumeEvent(int value)
Parameters
valueint
Returns
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.
public PatternEvent MakeVolumeEvent(int value)
Parameters
valueint
Returns
ReadScope(AudioChannel, short[])
Read module scope view, and write it to a buffer.
public int ReadScope(AudioChannel channel, short[] buffer)
Parameters
channelAudioChannelAudio channel.
buffershort[]Buffer to receive scope data.
Returns
- int
Number of samples successfully read.
Remarks
Exceptions
- ArgumentNullException
Thrown if
bufferis null.
SetBassLength(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 6 'Bass length' 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 SetBassLength(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetBassPanning(int, ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 12 'Bass panning' 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 SetBassPanning(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetBassPower(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 4 'Bass power' 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 SetBassPower(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetBassTone(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 5 'Bass tone' 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 SetBassTone(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetBassVolume(int, ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 3 'Bass 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 SetBassVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetColor(byte, byte, byte)
Set the module color.
public void SetColor(byte r, byte g, byte b)
Parameters
rbyteRed component (0 to 255).
gbyteGreen component (0 to 255).
bbyteBlue component (0 to 255).
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
SetFineTune(FineTunePair)
Sets the fine tune for the module.
public void SetFineTune(FineTunePair fineTune)
Parameters
fineTuneFineTunePair
SetHihatLength(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 8 'Hihat length' 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 SetHihatLength(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetHihatPanning(int, ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 13 'Hihat panning' 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 SetHihatPanning(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetHihatVolume(int, ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 7 'Hihat 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 SetHihatVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetName(string)
Set the module name.
public void SetName(string name)
Parameters
namestringNew module name.
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
- ArgumentNullException
Thrown if
nameis null.
SetPanning(int, ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 1 'Panning' 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 SetPanning(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetPolyphony(int, ValueScalingMode)
Original name: 2 'Polyphony' 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 SetPolyphony(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetPosition(int, int)
Set the module position.
public void SetPosition(int x, int y)
Parameters
xintX coordinate (center: 512, working area: 0 to 1024).
yintY coordinate (center: 512, working area: 0 to 1024).
Remarks
Exceptions
- SunVoxException
Thrown when the operation fails.
SetSnareLength(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 11 'Snare length' 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 SetSnareLength(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetSnarePanning(int, ValueScalingMode)
Value range: displayed: -128 to 128, real: 0 to 256 Original name: 14 'Snare panning' 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 SetSnarePanning(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetSnareTone(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 10 'Snare tone' 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 SetSnareTone(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetSnareVolume(int, ValueScalingMode)
Value range: displayed: 0 to 512, real: 0 to 512 Original name: 9 'Snare 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 SetSnareVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
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.
public void SetVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
Operators
implicit operator SynthModuleHandle(DrumSynthModuleHandle)
public static implicit operator SynthModuleHandle(DrumSynthModuleHandle handle)
Parameters
handleDrumSynthModuleHandle