Struct SunVoxLib

Namespace: SunSharp.Native

Assembly: SunSharp.dll

Friendlier interface for SunVox native library functions.

public readonly struct SunVoxLib : ISunVoxLib

Implements: ISunVoxLib

Constructors

SunVoxLib(ISunVoxLibC)

public SunVoxLib(ISunVoxLibC nativeLibrary)

Parameters

nativeLibrary ISunVoxLibC

Methods

AudioCallback(short[], AudioChannels, short[], AudioChannels, int, uint)

Send audio to the Input module and get the next piece of audio from the Output module.

public bool AudioCallback(short[] outputBuffer, AudioChannels outputChannels, short[] inputBuffer, AudioChannels inputChannels, int latency, uint outTime)

Parameters

outputBuffer short[]: Output buffer to write audio data to.
outputChannels AudioChannels: Number of channels the library was initialized with.
inputBuffer short[]: Input buffer. Stereo data must be interleaved.
inputChannels AudioChannels: Number of input channels.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

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

Exceptions

ArgumentException: Thrown when buffer sizes are invalid for the channel count or not equal length.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer or inputBuffer is null.

AudioCallback(short[], AudioChannels, int, uint)

Get the next piece of audio from the Output module.

public bool AudioCallback(short[] outputBuffer, AudioChannels channels, int latency, uint outTime)

Parameters

outputBuffer short[]: Output buffer to write audio data to.
channels AudioChannels: Number of channels the library was initialized with.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

Make sure to call the correct overload for the buffer data type.

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

Exceptions

ArgumentException: Thrown when buffer size is invalid for the channel count.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer is null.

AudioCallback(short[], AudioChannels, float[], AudioChannels, int, uint)

Send audio to the Input module and get the next piece of audio from the Output module.

public bool AudioCallback(short[] outputBuffer, AudioChannels outputChannels, float[] inputBuffer, AudioChannels inputChannels, int latency, uint outTime)

Parameters

outputBuffer short[]: Output buffer to write audio data to.
outputChannels AudioChannels: Number of channels the library was initialized with.
inputBuffer float[]: Input buffer. Stereo data must be interleaved.
inputChannels AudioChannels: Number of input channels.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

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

Exceptions

ArgumentException: Thrown when buffer sizes are invalid for the channel count or not equal length.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer or inputBuffer is null.

AudioCallback(float[], AudioChannels, short[], AudioChannels, int, uint)

Send audio to the Input module and get the next piece of audio from the Output module.

public bool AudioCallback(float[] outputBuffer, AudioChannels outputChannels, short[] inputBuffer, AudioChannels inputChannels, int latency, uint outTime)

Parameters

outputBuffer float[]: Output buffer to write audio data to.
outputChannels AudioChannels: Number of channels the library was initialized with.
inputBuffer short[]: Input buffer. Stereo data must be interleaved.
inputChannels AudioChannels: Number of input channels.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

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

Exceptions

ArgumentException: Thrown when buffer sizes are invalid for the channel count or not equal length.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer or inputBuffer is null.

AudioCallback(float[], AudioChannels, int, uint)

Get the next piece of audio from the Output module.

public bool AudioCallback(float[] outputBuffer, AudioChannels channels, int latency, uint outTime)

Parameters

outputBuffer float[]: Output buffer to write audio data to.
channels AudioChannels: Number of channels the library was initialized with.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

Make sure to call the correct overload for the buffer data type.

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

Exceptions

ArgumentException: Thrown when buffer size is invalid for the channel count.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer is null.

AudioCallback(float[], AudioChannels, float[], AudioChannels, int, uint)

Send audio to the Input module and get the next piece of audio from the Output module.

public bool AudioCallback(float[] outputBuffer, AudioChannels outputChannels, float[] inputBuffer, AudioChannels inputChannels, int latency, uint outTime)

Parameters

outputBuffer float[]: Output buffer to write audio data to.
outputChannels AudioChannels: Number of channels the library was initialized with.
inputBuffer float[]: Input buffer. Stereo data must be interleaved.
inputChannels AudioChannels: Number of input channels.
latency int: Audio latency in frames.
outTime uint: Buffer output time in system ticks. See GetTicks().

Returns

bool: true if buffer contains any non-0 samples.

Remarks

UserAudioCallback must be set in Initialize(int, string?, AudioChannels, SunVoxInitOptions) to use this function.

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

Exceptions

ArgumentException: Thrown when buffer sizes are invalid for the channel count or not equal length.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if outputBuffer or inputBuffer is null.

ClonePattern(int, int, int, int)

Clone a pattern.

public int ClonePattern(int slotId, int originalPatternId, int x, int y)

Parameters

slotId int: Slot number (0 to 15).
originalPatternId int: Pattern to clone.
x int: Line number on which the pattern starts (horizontal).
y int: Vertical position on the timeline.

Returns

int: The number of the newly created pattern.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_pattern(int, int, int, int, int, int, int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.

CloseSlot(int)

Close the slot and free its resources.

public void CloseSlot(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_close_slot(int).

Exceptions

SunVoxException: Thrown when the operation fails.

ConnectModules(int, int, int)

Connect the source module to the destination module.

public void ConnectModules(int slotId, int source, int destination)

Parameters

slotId int: slot number (0 to 15).
source int: Source module number (0-based).
destination int: Destination module number (0-based).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_connect_module(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

CreateModule(int, SynthModuleType, string?, int, int, int)

Create a new module.

public int CreateModule(int slotId, SynthModuleType type, string? name = null, int x = 0, int y = 0, int z = 0)

Parameters

slotId int: slot number (0 to 15).
type SynthModuleType: Type of module to create.
name string: Name of the module.
x int: X coordinate (0 to 1024, center: 512).
y int: Y coordinate (0 to 1024, center: 512).
z int: Layer number (0 to 7).

Returns

int: The identifier of the newly created module (0-based).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_module(int, IntPtr, IntPtr, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if type is null.
ArgumentOutOfRangeException: Thrown when the module type is not valid.

CreateModule(int, string, string?, int, int, int)

Create a new module.

public int CreateModule(int slotId, string type, string? name = null, int x = 0, int y = 0, int z = 0)

Parameters

slotId int: slot number (0 to 15).
type string: Type of module to create.
name string: Name of the module.
x int: X coordinate (0 to 1024, center: 512).
y int: Y coordinate (0 to 1024, center: 512).
z int: Layer number (0 to 7).

Returns

int: The identifier of the newly created module (0-based).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_module(int, IntPtr, IntPtr, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if type is null.

CreatePattern(int, int, int, int, int, int, string?)

Create a new pattern.

public int CreatePattern(int slotId, int x, int y, int tracks, int lines, int iconSeed = 0, string? name = null)

Parameters

slotId int: Slot number (0 to 15).
x int: Line number on which the pattern starts.
y int: Y coordinate on timeline.
tracks int: Number of tracks.
lines int: Number of lines.
iconSeed int: Icon seed for pattern appearance.
name string: Pattern name.

Returns

int: The number of the newly created pattern.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_new_pattern(int, int, int, int, int, int, int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.

Deinitialize()

Deinitialize the SunVox engine and free all resources.

public void Deinitialize()

Remarks

Calls sv_deinit().

Exceptions

SunVoxException: Thrown when the operation fails, or when already deinitialized.

DisconnectModules(int, int, int)

Disconnect the source module from the destination module.

public void DisconnectModules(int slotId, int source, int destination)

Parameters

slotId int: slot number (0 to 15).
source int: Source module number (0-based).
destination int: Destination module number (0-based).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_disconnect_module(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

FindModule(int, string)

Find a module by name.

public int? FindModule(int slotId, string name)

Parameters

slotId int: slot number (0 to 15).
name string: Module name to search for.

Returns

int?: module number (0-based) if found.

Remarks

Calls sv_find_module(int, IntPtr).

Exceptions

SunVoxException: Thrown when an error occurs during the search.
ArgumentNullException: Thrown if name is null.

FindPattern(int, string)

Find a pattern by name.

public int? FindPattern(int slotId, string name)

Parameters

slotId int: Slot number (0 to 15).
name string: Pattern name to search for.

Returns

int?: Pattern number if found.

Remarks

Calls sv_find_pattern(int, IntPtr).

Exceptions

SunVoxException: Thrown when an error occurs during the search.
ArgumentNullException: Thrown if name is null.

GetAutomaticStop(int)

Get the autostop mode. When false, the project loops endlessly.

public bool GetAutomaticStop(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

bool: true if automatic stop is enabled.

Remarks

Calls sv_get_autostop(int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetCurrentLine(int)

Get the current line number on the timeline.

public int GetCurrentLine(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

int: Current line number (playback position).

Remarks

Calls sv_get_current_line(int).

GetCurrentLineWithTenthPart(int)

Get the current line number in fixed point format. The value contains the tenth part of the line for higher precision.

public int GetCurrentLineWithTenthPart(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

int: Current line number in fixed point format.

Remarks

Calls sv_get_current_line2(int).

GetCurrentSignalLevel(int, AudioChannel)

Get the current signal level from the Output module.

public int GetCurrentSignalLevel(int slotId, AudioChannel channel)

Parameters

slotId int: Slot number (0 to 15).
channel AudioChannel: Audio channel.

Returns

int: Signal level (0 to 255).

Remarks

Calls sv_get_current_signal_level(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetLog(int)

Get the latest log messages from the SunVox engine.

public string? GetLog(int size)

Parameters

size int: Maximum number of characters to read.

Returns

string: Log messages, or null if unavailable.

Remarks

Log messages are typically written when a call to another function fails.

Calls sv_get_log(int).

GetModuleColor(int, int)

Get the module color.

public (byte r, byte g, byte b) GetModuleColor(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

(byte R, byte G, byte B): RGB color tuple (r, g, b).

Remarks

Calls sv_get_module_color(int, int).

GetModuleControllerCount(int, int)

Get the number of controllers in the module.

public int GetModuleControllerCount(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

int: Number of controllers.

Remarks

Calls sv_get_number_of_module_ctls(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetModuleControllerGroup(int, int, int)

Get the controller group number.

public int GetModuleControllerGroup(int slotId, int moduleId, int controllerId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: controller number (0-based).

Returns

int: Controller group number.

Remarks

Calls sv_get_module_ctl_group(int, int, int).

GetModuleControllerMaxValue(int, int, int, ValueScalingMode)

Get the controller maximum value.

public int GetModuleControllerMaxValue(int slotId, int moduleId, int controllerId, ValueScalingMode scalingMode)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).
scalingMode ValueScalingMode: Value scaling mode.

Returns

int: Maximum controller value.

Remarks

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

GetModuleControllerMinValue(int, int, int, ValueScalingMode)

Get the controller minimum value.

public int GetModuleControllerMinValue(int slotId, int moduleId, int controllerId, ValueScalingMode scalingMode)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).
scalingMode ValueScalingMode: Value scaling mode.

Returns

int: Minimum controller value.

Remarks

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

GetModuleControllerName(int, int, int)

Get the controller name.

public string? GetModuleControllerName(int slotId, int moduleId, int controllerId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).

Returns

string: Controller name, or null if unavailable.

Remarks

Calls sv_get_module_ctl_name(int, int, int).

GetModuleControllerOffset(int, int, int)

Get the controller display value offset.

public int GetModuleControllerOffset(int slotId, int moduleId, int controllerId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).

Returns

int: Display value offset.

Remarks

Calls sv_get_module_ctl_offset(int, int, int).

GetModuleControllerType(int, int, int)

Get the controller type.

public ControllerType GetModuleControllerType(int slotId, int moduleId, int controllerId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).

Returns

ControllerType: Controller type.

Remarks

Calls sv_get_module_ctl_type(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetModuleControllerValue(int, int, int, ValueScalingMode)

Get the controller value.

public int GetModuleControllerValue(int slotId, int moduleId, int controllerId, ValueScalingMode scalingMode)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: Controller number (0-based).
scalingMode ValueScalingMode: Value scaling mode.

Returns

int: Controller value.

Remarks

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

GetModuleExists(int, int)

Check if a module exists.

public bool GetModuleExists(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

bool: true if module exists.

Remarks

Calls sv_get_module_flags(int, int).

GetModuleFineTune(int, int)

Get the module fine tune and relative note values.

public FineTunePair GetModuleFineTune(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

FineTunePair: Fine tune pair containing fine tune value and relative note.

Remarks

Calls sv_get_module_finetune(int, int).

GetModuleFlags(int, int)

Get the module flags.

public ModuleFlags GetModuleFlags(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

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

Remarks

Calls sv_get_module_flags(int, int).

GetModuleInputs(int, int)

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

public int[] GetModuleInputs(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

int[]: Array of connected input module numbers.

Remarks

Calls sv_get_module_inputs(int, int).

GetModuleName(int, int)

Get the module name.

public string? GetModuleName(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

string: Module name, or null if unavailable.

Remarks

Calls sv_get_module_name(int, int).

GetModuleOutputs(int, int)

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

public int[] GetModuleOutputs(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

int[]: Array of connected output module numbers.

Remarks

Calls sv_get_module_outputs(int, int).

GetModulePosition(int, int)

Get the module position on the canvas.

public (int x, int y) GetModulePosition(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

(int x, int y): Tuple containing X and Y coordinates.

Remarks

Calls sv_get_module_xy(int, int).

GetModuleType(int, int)

Get the module type string.

public string? GetModuleType(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Returns

string: Module type string, or null if unavailable.

Remarks

Calls sv_get_module_type(int, int).

GetPatternData(int, int)

Get the pattern data (all events).

public (PatternEvent[] data, int tracks, int lines)? GetPatternData(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

(PatternEvent[] data, int tracks, int lines)?: Tuple containing event data array, number of tracks, and number of lines if pattern exists.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_get_pattern_data(int, int).

GetPatternEventValue(int, int, int, int, Column)

Get a specific column value from a pattern event.

public int GetPatternEventValue(int slotId, int patternId, int track, int line, Column column)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
track int: Track number.
line int: Line number.
column Column: Column to read.

Returns

int: Column value.

Remarks

Calls sv_get_pattern_event(int, int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetPatternExists(int, int)

Check if a pattern exists.

public bool GetPatternExists(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

bool: true if pattern exists; false otherwise.

Remarks

Calls sv_get_pattern_lines(int, int).

GetPatternLines(int, int)

Get the number of lines in the pattern. Can be used to check if a pattern exists (lines > 0).

public int GetPatternLines(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

int: Number of lines.

Remarks

Calls sv_get_pattern_lines(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetPatternMuted(int, int)

Get the pattern mute state.

public bool GetPatternMuted(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

bool: true if pattern is muted; false otherwise.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_pattern_mute(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetPatternName(int, int)

Get the pattern name.

public string? GetPatternName(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

string: Pattern name, or null if unavailable.

Remarks

Calls sv_get_pattern_name(int, int).

GetPatternPosition(int, int)

Get the pattern position on the timeline.

public (int x, int y) GetPatternPosition(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

(int x, int y): Tuple containing X and Y coordinates.

Remarks

Calls:

GetPatternTracks(int, int)

Get the number of tracks in the pattern.

public int GetPatternTracks(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

int: Number of tracks.

Remarks

Calls sv_get_pattern_tracks(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetPatternX(int, int)

Get the pattern X coordinate on the timeline.

public int GetPatternX(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

int: X coordinate.

Remarks

Calls sv_get_pattern_x(int, int).

GetPatternY(int, int)

Get the pattern Y coordinate on the timeline.

public int GetPatternY(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Returns

int: Y coordinate.

Remarks

Calls sv_get_pattern_y(int, int).

GetSampleRate()

Get the current sampling rate (may differ from the value specified in Initialize(int, string?, AudioChannels, SunVoxInitOptions)).

public int GetSampleRate()

Returns

int: Current sample rate in Hz.

Remarks

Calls sv_get_sample_rate().

Exceptions

SunVoxException: Thrown when the operation fails.

GetSamplerSampleParameter(int, int, int, int)

Get a Sampler sample parameter value.

public int GetSamplerSampleParameter(int slotId, int moduleId, int sampleSlot, int parameter)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Sampler module number (0-based).
sampleSlot int: Sample slot number.
parameter int: Parameter number.

Returns

int: Parameter value.

Remarks

Calls sv_sampler_par(int, int, int, int, int, int).

GetSongBaseVersion(int)

Get the SunVox version used to create this project.

public SunVoxVersion GetSongBaseVersion(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

SunVoxVersion: SunVox version used to create the project.

Remarks

Calls sv_get_base_version(int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetSongBpm(int)

Get the project BPM (Beats Per Minute).

public int GetSongBpm(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

int

Remarks

The value can be set using pattern effects.

Calls sv_get_song_bpm(int).

Exceptions

SunVoxException: Thrown when the operation fails.

See Also: GetSongTpl(int)

GetSongLengthInFrames(int)

Get the project length in frames.

public uint GetSongLengthInFrames(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

uint

Remarks

A frame is a pair of samples for stereo audio, or a single sample for mono audio.

Calls sv_get_song_length_frames(int).

GetSongLengthInLines(int)

Get the project length in lines.

public uint GetSongLengthInLines(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

uint

Remarks

Calls sv_get_song_length_lines(int).

GetSongName(int)

Get the project name.

public string? GetSongName(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

string: Project name, or null if unavailable.

Remarks

Calls sv_get_song_name(int).

GetSongTpl(int)

Get the project TPL (Ticks Per Line).

public int GetSongTpl(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

int

Remarks

The value can be set using pattern effects.

Calls sv_get_song_tpl(int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetTicks()

Get the current system tick counter.

public uint GetTicks()

Returns

uint

Remarks

SunVox engine uses system-provided time space, measured in system ticks (don't confuse it with the project ticks). System ticks are used for timing in functions like AudioCallback(float[], AudioChannels, int, uint) and SetEventTiming(int, int).

Calls sv_get_ticks().

GetTicksPerSecond()

Get the number of system ticks per second.

public uint GetTicksPerSecond()

Returns

uint

Remarks

Calls sv_get_ticks_per_second().

GetTimeMapFrames(int, int, int)

Get the project time map.

public uint[] GetTimeMapFrames(int slotId, int startLine, int length)

Parameters

slotId int: Slot number (0 to 15).
startLine int: First line to read (usually 0).
length int: Number of lines to read.

Returns

uint[]: Array with frame counts for each line.

Remarks

Calls sv_get_time_map(int, int, int, IntPtr, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetTimeMapSpeed(int, int, int)

Get the project time map.

public Speed[] GetTimeMapSpeed(int slotId, int startLine, int length)

Parameters

slotId int: Slot number (0 to 15).
startLine int: First line to read (usually 0).
length int: Number of lines to read.

Returns

Speed[]: Array with information about speed for each line.

Remarks

Calls sv_get_time_map(int, int, int, IntPtr, int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetUpperModuleCount(int)

Get the upper limit of module count (one more than the highest module number).

public int GetUpperModuleCount(int slotId)

Parameters

slotId int: slot number (0 to 15).

Returns

int: Upper limit of module count.

Remarks

Calls sv_get_number_of_modules(int).

Exceptions

SunVoxException: Thrown when the operation fails.

GetUpperPatternCount(int)

Get the upper limit of pattern count (one more than the highest pattern number).

public int GetUpperPatternCount(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

int: Upper limit of pattern count.

Remarks

Calls sv_get_number_of_patterns(int).

Exceptions

SunVoxException: Thrown when the operation fails.

Initialize(int, string?, AudioChannels, SunVoxInitOptions)

Initialize the SunVox engine.

public SunVoxVersion Initialize(int sampleRate, string? config = null, AudioChannels channels = AudioChannels.Stereo, SunVoxInitOptions options = SunVoxInitOptions.None)

Parameters

sampleRate int: Desired sample rate (Hz); minimum 44100. The actual rate may differ if offline mode is not set.
config string: Configuration string in pipe-separated format (e.g., "param1=value1|param2=value2"). Use null for automatic configuration.
channels AudioChannels: Number of audio channels.
options SunVoxInitOptions: Initialization flags.

Returns

SunVoxVersion

Remarks

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

Exceptions

SunVoxException: Thrown when initialization fails, or when already initialized.

IsPlaying(int)

Check if the project is currently playing.

public bool IsPlaying(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Returns

bool

Remarks

Calls sv_end_of_song(int).

Exceptions

SunVoxException: Thrown when the operation fails.

Load(int, byte[])

Load a SunVox project from memory.

public void Load(int slotId, byte[] data)

Parameters

slotId int: Slot number (0 to 15).
data byte[]: Byte array with project data.

Remarks

Calls sv_load_from_memory(int, IntPtr, uint).

Exceptions

SunVoxException: Thrown when the operation fails.

Load(int, string)

Load a SunVox project from file.

public void Load(int slotId, string path)

Parameters

slotId int: Slot number (0 to 15).
path string: File path (relative or absolute).

Remarks

Calls sv_load(int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if path is null.

LoadIntoMetaModule(int, int, byte[])

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

public void LoadIntoMetaModule(int slotId, int moduleId, byte[] data)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Metamodule number (0-based).
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.

LoadIntoMetaModule(int, int, string)

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

public void LoadIntoMetaModule(int slotId, int moduleId, string path)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Metamodule number (0-based).
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.

LoadIntoVorbisPlayer(int, int, byte[])

Load a file into a Vorbis Player module from memory. Supported file formats: ogg.

public void LoadIntoVorbisPlayer(int slotId, int moduleId, byte[] data)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Vorbis Player module number (0-based).
data byte[]: Byte array with audio file data.

Remarks

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

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if data is null.

LoadIntoVorbisPlayer(int, int, string)

Load a file into a Vorbis Player module. Supported file formats: ogg.

public void LoadIntoVorbisPlayer(int slotId, int moduleId, string path)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Vorbis Player module number (0-based).
path string: File path (relative or absolute).

Remarks

Calls sv_vplayer_load(int, int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if path is null.

LoadModule(int, byte[], int, int, int)

Load a module or sample from memory. Supported file formats: sunsynth, xi, wav, aiff.

public int LoadModule(int slotId, byte[] data, int x = 0, int y = 0, int z = 0)

Parameters

slotId int: slot number (0 to 15).
data byte[]: Byte array with module data.
x int: X coordinate (0 to 1024, center: 512).
y int: Y coordinate (0 to 1024, center: 512).
z int: Layer number (0 to 7).

Returns

int: The number of the loaded module.

Remarks

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

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if data is null.

LoadModule(int, string, int, int, int)

Load a module or sample from file. Supported file formats: sunsynth, xi, wav, aiff.

public int LoadModule(int slotId, string path, int x = 0, int y = 0, int z = 0)

Parameters

slotId int: slot number (0 to 15).
path string: File path (relative or absolute).
x int: X coordinate (0 to 1024, center: 512).
y int: Y coordinate (0 to 1024, center: 512).
z int: Layer number (0 to 7).

Returns

int: The number of the loaded module.

Remarks

Calls sv_load_module(int, IntPtr, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if path is null.

LoadSamplerSample(int, int, byte[], int?)

Load a sample into a Sampler module from memory. Supported file formats: xi, wav, aiff. Set sampleSlot to null to apply the sample to all sample slots.

public void LoadSamplerSample(int slotId, int moduleId, byte[] data, int? sampleSlot = null)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Sampler module number (0-based).
data byte[]: Byte array with sample data.
sampleSlot int?: Sample slot number (-1 for auto/all slots).

Remarks

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

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if data is null.

LoadSamplerSample(int, int, string, int?)

Load a sample into a Sampler module. Supported file formats: xi, wav, aiff. Set sampleSlot to null to apply the sample to all sample slots.

public void LoadSamplerSample(int slotId, int moduleId, string path, int? sampleSlot = null)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Sampler module number (0-based).
path string: File path (relative or absolute).
sampleSlot int?: Sample slot number (-1 for auto/all slots).

Remarks

Calls sv_sampler_load(int, int, IntPtr, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if path is null.

LockSlot(int)

Lock the slot for thread-safe access. Use when reading/modifying SunVox data from different threads on the same slot. Some functions require lock/unlock. Remember to call UnlockSlot(int)!

public void LockSlot(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

The library uses a recursive mutex, so the same thread may call LockSlot(int) multiple times without deadlocking itself.

Calls sv_lock_slot(int).

Exceptions

SunVoxException: Thrown when the operation fails.

OpenSlot(int)

Open a slot.

public void OpenSlot(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_open_slot(int).

Exceptions

SunVoxException: Thrown when the operation fails.

PauseAudioStream(int)

Pause the audio stream from a slot.

public void PauseAudioStream(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_pause(int).

Exceptions

SunVoxException: Thrown when the operation fails.

ReadModuleCurve(int, int, int, float[])

Read data from a module curve.

public int ReadModuleCurve(int slotId, int moduleId, int curveId, float[] data)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
curveId int: Curve number.
data float[]: Array to receive curveId data.

Returns

int: Number of values read.

Remarks

Calls sv_module_curve(int, int, int, IntPtr, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if data is null.

ReadModuleScope(int, int, AudioChannel, short[])

Read oscilloscope data from a module.

public int ReadModuleScope(int slotId, int moduleId, AudioChannel channel, short[] buffer)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
channel AudioChannel: Audio channel.
buffer short[]: Buffer to receive scope data.

Returns

int: Number of samples read.

Remarks

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

Exceptions

ArgumentNullException: Thrown if buffer is null.

ReadPatternData(int, int, PatternEvent[], int, int, int, int, int, int, int?, int?)

Read a section or all of the pattern data into a buffer.

public int ReadPatternData(int slotId, int patternId, PatternEvent[] buffer, int bufferTracks, int bufferLines, int bufferOffsetTracks = 0, int bufferOffsetLines = 0, int readOffsetTracks = 0, int readOffsetLines = 0, int? maxTracks = null, int? maxLines = null)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
buffer PatternEvent[]: Buffer to receive pattern data.
bufferTracks int: Width of the buffer.
bufferLines int: Height of the buffer.
bufferOffsetTracks int: Number of tracks in the buffer to skip.
bufferOffsetLines int: Number of lines in the buffer to skip.
readOffsetTracks int: Number of tracks in the pattern to skip.
readOffsetLines int: Number of lines in the pattern to skip.
maxTracks int?: Maximum number of tracks to read.
maxLines int?: Maximum number of lines to read.

Returns

int: Number of events read.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_get_pattern_data(int, int).

Exceptions

ArgumentOutOfRangeException: Thrown if any offset or size parameter is negative.
ArgumentException: Thrown if buffer length doesn't match bufferTracks * bufferLines.
SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if buffer is null.

RemoveModule(int, int)

Remove (delete) a module.

public void RemoveModule(int slotId, int moduleId)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_remove_module(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

RemovePattern(int, int)

Delete a pattern.

public void RemovePattern(int slotId, int patternId)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.

Remarks

Deleting the original pattern also deletes all its clones.

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_remove_pattern(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

ResetEventTiming(int)

Reset the timestamp of events sent by SendEvent(int, int, PatternEvent). If timestamp is zero: event is heard as quickly as possible.

public void ResetEventTiming(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_set_event_t(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

ResumeAudioStream(int)

Resume the audio stream from a slot.

public void ResumeAudioStream(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_resume(int).

Exceptions

SunVoxException: Thrown when the operation fails.

ResumeStreamOnSyncEffect(int)

Wait for sync (pattern effect 0x33 in any slot) and resume the audio stream.

public void ResumeStreamOnSyncEffect(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_sync_resume(int).

Exceptions

SunVoxException: Thrown when the operation fails.

Rewind(int, int)

Jump to the specified line on the timeline.

public void Rewind(int slotId, int line)

Parameters

slotId int: Slot number (0 to 15).
line int: Line number on the timeline.

Remarks

Calls sv_rewind(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SaveToFile(int, string)

Save the SunVox project to a file.

public void SaveToFile(int slotId, string path)

Parameters

slotId int: Slot number (0 to 15).
path string: File path where the project will be saved.

Remarks

Calls sv_save(int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if path is null.

SendEvent(int, int, PatternEvent)

Send an event to the SunVox engine. Sends the specified pattern event to the given track. The event will be processed according to the last set timing.

public void SendEvent(int slotId, int track, PatternEvent data)

Parameters

slotId int: Slot number (0 to 15).
track int: Track number within the virtual pattern.
data PatternEvent: Pattern event data.

Remarks

Calls sv_send_event(int, int, int, int, int, int, int).

See Also: PatternEvent

SendEvent(int, int, int, int, int, int, int)

Send an event to the SunVox engine. Sends the specified pattern event to the given track. The event will be processed according to the last set timing.

public void SendEvent(int slotId, int track, int nn = 0, int vv = 0, int mm = 0, int ccee = 0, int xxyy = 0)

Parameters

slotId int: Slot number (0 to 15).
track int: Track number within the virtual pattern.
nn int: Note.
vv int: Velocity.
mm int: Module.
ccee int: Controller and effect.
xxyy int: Value.

Remarks

Consider using PatternEvent and the overload that accepts it for better readability.

Calls sv_send_event(int, int, int, int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetAutomaticStop(int, bool)

Set autostop mode. When OFF, the project loops endlessly.

public void SetAutomaticStop(int slotId, bool enable)

Parameters

slotId int: Slot number (0 to 15).
enable bool: true - stop at the end.

Remarks

Calls sv_set_autostop(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetEventTiming(int, int)

Set the timestamp of events sent by SendEvent(int, int, PatternEvent). Every event has a timestamp (when it was generated, e.g., key press time). If nonzero: event is heard at timestamp + sound latency * 2.

public void SetEventTiming(int slotId, int timestamp)

Parameters

slotId int: Slot number (0 to 15).
timestamp int: Timestamp (in system ticks) for future events. If not zero, must be ≥ previous value for same slot. See GetTicks() and GetTicksPerSecond().

Remarks

Calls sv_set_event_t(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetModuleColor(int, int, byte, byte, byte)

Set the module color.

public void SetModuleColor(int slotId, int moduleId, byte r, byte g, byte b)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
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.

SetModuleControllerValue(int, int, int, int, ValueScalingMode)

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

public void SetModuleControllerValue(int slotId, int moduleId, int controllerId, int value, ValueScalingMode scalingMode)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
controllerId int: controller number (0-based).
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.

SetModuleFineTune(int, int, int)

Set the module fine tune value.

public void SetModuleFineTune(int slotId, int moduleId, int fineTune)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
fineTune int: Fine tune value (-256 to 256, 1/256 of a semitone).

Remarks

Calls sv_set_module_finetune(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetModuleName(int, int, string)

Set the module name.

public void SetModuleName(int slotId, int moduleId, string name)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
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.

SetModulePosition(int, int, int, int)

Set the module position.

public void SetModulePosition(int slotId, int moduleId, int x, int y)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
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.

SetModuleRelativeNote(int, int, int)

Set the module relative note value.

public void SetModuleRelativeNote(int slotId, int moduleId, int relativeNote)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
relativeNote int: Relative note in semitones.

Remarks

Calls sv_set_module_relnote(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetPatternData(int, int, PatternEvent[], int, int)

Set the pattern data (all events). Resizes the pattern and sets all event data.

public void SetPatternData(int slotId, int patternId, PatternEvent[] data, int tracks, int lines)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
data PatternEvent[]: Event data array (length must equal tracks * lines).
tracks int: Number of tracks.
lines int: Number of lines.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls:

Exceptions

ArgumentOutOfRangeException: Thrown if tracks or lines are negative.
ArgumentException: Thrown if data length doesn't match tracks * lines.
SunVoxException: Thrown when the operation fails or pattern doesn't exist.
ArgumentNullException: Thrown if data is null.

SetPatternEvent(int, int, int, int, PatternEvent)

Set a pattern event at a specific location.

public void SetPatternEvent(int slotId, int patternId, int track, int line, PatternEvent ev)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
track int: Track number.
line int: Line number.
ev PatternEvent: Pattern event data.

Remarks

Calls sv_set_pattern_event(int, int, int, int, int, int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetPatternEvent(int, int, int, int, int, int, int, int, int)

Set a pattern event at a specific location.

public void SetPatternEvent(int slotId, int patternId, int track, int line, int nn, int vv, int mm, int ccee, int xxyy)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
track int: Track number.
line int: Line number.
nn int: Note: 0 - nothing; 1 to 127 - note; 128 - note off; 129+ - see NOTECMD_*.
vv int: Velocity: 1 to 129; 0 - default.
mm int: Module: 0 (empty) or module number + 1 (1 to 65535).
ccee int: Controller/effect: 0xCCEE. CC - controller (1 to 255); EE - effect.
xxyy int: Value: 0xXXYY. Controller value (0 to 32768) or effect parameter (0 to 65535).

Remarks

Calls sv_set_pattern_event(int, int, int, int, int, int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetPatternMuted(int, int, bool)

Set the pattern mute state.

public void SetPatternMuted(int slotId, int patternId, bool muted)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
muted bool: true to mute; false to unmute.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_pattern_mute(int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetPatternName(int, int, string)

Set the pattern name.

public void SetPatternName(int slotId, int patternId, string name)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
name string: New pattern name.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_set_pattern_name(int, int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if name is null.

SetPatternPosition(int, int, int, int)

Set the pattern position on the timeline.

public void SetPatternPosition(int slotId, int patternId, int x, int y)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
x int: Line number on which the pattern starts.
y int: Y coordinate on timeline.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_set_pattern_xy(int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetPatternSize(int, int, int?, int?)

Set the pattern size (number of tracks and/or lines).

public void SetPatternSize(int slotId, int patternId, int? tracks = null, int? lines = null)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
tracks int?: Number of tracks (null to keep current).
lines int?: Number of lines (null to keep current).

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_set_pattern_size(int, int, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

SetSamplerSampleParameter(int, int, int, int, int)

Set a Sampler sample parameter value.

public void SetSamplerSampleParameter(int slotId, int moduleId, int sampleSlot, int parameter, int parameterValue)

Parameters

slotId int: slot number (0 to 15).
moduleId int: Sampler module number (0-based).
sampleSlot int: Sample slot number.
parameter int: Parameter number.
parameterValue int: Parameter value.

Remarks

This method does not throw exceptions on failure. Ensure that the provided parameters are valid.

Calls sv_sampler_par(int, int, int, int, int, int).

SetSongName(int, string)

Set the project name.

public void SetSongName(int slotId, string value)

Parameters

slotId int: Slot number (0 to 15).
value string: New project name.

Remarks

Calls sv_set_song_name(int, IntPtr).

Exceptions

SunVoxException: Thrown when the operation fails.

StartPlayback(int)

Play from the current position.

public void StartPlayback(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_play(int).

Exceptions

SunVoxException: Thrown when the operation fails.

StartPlaybackFromBeginning(int)

Play from the beginning (line 0).

public void StartPlaybackFromBeginning(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_play_from_beginning(int).

Exceptions

SunVoxException: Thrown when the operation fails.

StopPlayback(int)

Stop playing. First call stops playback. The sound engine continues working (e.g., reverb tail may be heard). Second call resets all activity and enters standby mode.

public void StopPlayback(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_stop(int).

Exceptions

SunVoxException: Thrown when the operation fails.

UnlockSlot(int)

Unlock the slot. Must be called after LockSlot(int).

public void UnlockSlot(int slotId)

Parameters

slotId int: Slot number (0 to 15).

Remarks

Calls sv_unlock_slot(int).

Exceptions

SunVoxException: Thrown when the operation fails.

UpdateInputDevices()

Handle input ON/OFF requests to enable/disable sound card input ports (e.g., after Input module creation). Call from the main thread only, where the SunVox sound stream is not locked.

public void UpdateInputDevices()

Remarks

Calls sv_update_input().

Exceptions

SunVoxException: Thrown when the operation fails.

Volume(int, int)

Set the project volume.

public int Volume(int slotId, int volume)

Parameters

slotId int: Slot number (0 to 15).
volume int: Volume: 0 (min) to 256 (max/100%). Negative values are ignored.

Returns

int: Previous volume (0 to 256).

Remarks

Calls sv_volume(int, int).

Exceptions

SunVoxException: Thrown when the operation fails.

WriteModuleCurve(int, int, int, float[])

Write data to a module curve.

public int WriteModuleCurve(int slotId, int moduleId, int curveId, float[] data)

Parameters

slotId int: slot number (0 to 15).
moduleId int: module number (0-based).
curveId int: Curve number.
data float[]: Array containing curveId data to write.

Returns

int: Number of values written.

Remarks

Calls sv_module_curve(int, int, int, IntPtr, int, int).

Exceptions

SunVoxException: Thrown when the operation fails.
ArgumentNullException: Thrown if data is null.

WritePatternData(int, int, PatternEvent[], int, int, int, int, int, int, int?, int?)

Write a section or all of a buffer into the pattern data.

public int WritePatternData(int slotId, int patternId, PatternEvent[] buffer, int bufferTracks, int bufferLines, int bufferOffsetTracks = 0, int bufferOffsetLines = 0, int writeOffsetTracks = 0, int writeOffsetLines = 0, int? maxTracks = null, int? maxLines = null)

Parameters

slotId int: Slot number (0 to 15).
patternId int: Pattern number.
buffer PatternEvent[]: Buffer containing pattern data to write.
bufferTracks int: Width of the buffer.
bufferLines int: Height of the buffer.
bufferOffsetTracks int: Number of tracks in the buffer to skip.
bufferOffsetLines int: Number of lines in the buffer to skip.
writeOffsetTracks int: Number of tracks in the pattern to skip.
writeOffsetLines int: Number of lines in the pattern to skip.
maxTracks int?: Maximum number of tracks to write.
maxLines int?: Maximum number of lines to write.

Returns

int: Number of events written.

Remarks

Requires LockSlot(int) / UnlockSlot(int).

Calls sv_get_pattern_data(int, int).

Exceptions

ArgumentOutOfRangeException: Thrown if any offset or size parameter is negative.
ArgumentException: Thrown if buffer length doesn't match bufferTracks * bufferLines.
ArgumentNullException: Thrown if buffer is null.

Table of Contents

Struct SunVoxLib

Constructors

SunVoxLib(ISunVoxLibC)

Parameters

Methods

AudioCallback(short[], AudioChannels, short[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

AudioCallback(short[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

AudioCallback(short[], AudioChannels, float[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

AudioCallback(float[], AudioChannels, short[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

AudioCallback(float[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

AudioCallback(float[], AudioChannels, float[], AudioChannels, int, uint)

Parameters

Returns

Remarks

Exceptions

ClonePattern(int, int, int, int)

Parameters

Returns

Remarks

Exceptions

CloseSlot(int)

Parameters

Remarks

Exceptions

ConnectModules(int, int, int)

Parameters

Remarks

Exceptions

CreateModule(int, SynthModuleType, string?, int, int, int)

Parameters

Returns

Remarks

Exceptions

CreateModule(int, string, string?, int, int, int)

Parameters

Returns

Remarks

Exceptions

CreatePattern(int, int, int, int, int, int, string?)

Parameters

Returns

Remarks

Exceptions

Deinitialize()

Remarks

Exceptions

DisconnectModules(int, int, int)

Parameters

Remarks

Exceptions

FindModule(int, string)

Parameters

Returns

Remarks

Exceptions

FindPattern(int, string)

Parameters

Returns

Remarks