Table of Contents

Interface ISynthModuleHandle

Namespace
SunSharp
Assembly
SunSharp.dll
public interface ISynthModuleHandle : IGenericSynthModuleHandle
Inherited Members

Methods

AsAdsr() 

IAdsrModuleHandle AsAdsr()

Returns

IAdsrModuleHandle

AsAmplifier() 

IAmplifierModuleHandle AsAmplifier()

Returns

IAmplifierModuleHandle

AsAnalogGenerator() 

IAnalogGeneratorModuleHandle AsAnalogGenerator()

Returns

IAnalogGeneratorModuleHandle

AsCompressor() 

ICompressorModuleHandle AsCompressor()

Returns

ICompressorModuleHandle

AsControlToNote() 

IControlToNoteModuleHandle AsControlToNote()

Returns

IControlToNoteModuleHandle

AsDcBlocker() 

IDcBlockerModuleHandle AsDcBlocker()

Returns

IDcBlockerModuleHandle

AsDelay() 

IDelayModuleHandle AsDelay()

Returns

IDelayModuleHandle

AsDistortion() 

IDistortionModuleHandle AsDistortion()

Returns

IDistortionModuleHandle

AsDrumSynth() 

IDrumSynthModuleHandle AsDrumSynth()

Returns

IDrumSynthModuleHandle

AsEcho() 

IEchoModuleHandle AsEcho()

Returns

IEchoModuleHandle

AsEq() 

IEqModuleHandle AsEq()

Returns

IEqModuleHandle

AsFeedback() 

IFeedbackModuleHandle AsFeedback()

Returns

IFeedbackModuleHandle

AsFft() 

IFftModuleHandle AsFft()

Returns

IFftModuleHandle

AsFilter() 

IFilterModuleHandle AsFilter()

Returns

IFilterModuleHandle

AsFilterPro() 

IFilterProModuleHandle AsFilterPro()

Returns

IFilterProModuleHandle

AsFlanger() 

IFlangerModuleHandle AsFlanger()

Returns

IFlangerModuleHandle

AsFm() 

IFmModuleHandle AsFm()

Returns

IFmModuleHandle

AsFmx() 

IFmxModuleHandle AsFmx()

Returns

IFmxModuleHandle

AsGenerator() 

IGeneratorModuleHandle AsGenerator()

Returns

IGeneratorModuleHandle

AsGlide() 

IGlideModuleHandle AsGlide()

Returns

IGlideModuleHandle

AsGpio() 

IGpioModuleHandle AsGpio()

Returns

IGpioModuleHandle

AsInput() 

IInputModuleHandle AsInput()

Returns

IInputModuleHandle

AsKicker() 

IKickerModuleHandle AsKicker()

Returns

IKickerModuleHandle

AsLfo() 

ILfoModuleHandle AsLfo()

Returns

ILfoModuleHandle

AsLoop() 

ILoopModuleHandle AsLoop()

Returns

ILoopModuleHandle

AsMetaModule() 

IMetaModuleModuleHandle AsMetaModule()

Returns

IMetaModuleModuleHandle

AsModulator() 

IModulatorModuleHandle AsModulator()

Returns

IModulatorModuleHandle

AsMultiControl() 

IMultiControlModuleHandle AsMultiControl()

Returns

IMultiControlModuleHandle

AsMultiSynth() 

IMultiSynthModuleHandle AsMultiSynth()

Returns

IMultiSynthModuleHandle

AsOutput() 

IOutputModuleHandle AsOutput()

Returns

IOutputModuleHandle

AsPitchDetector() 

IPitchDetectorModuleHandle AsPitchDetector()

Returns

IPitchDetectorModuleHandle

AsPitchShifter() 

IPitchShifterModuleHandle AsPitchShifter()

Returns

IPitchShifterModuleHandle

AsPitchToControl() 

IPitchToControlModuleHandle AsPitchToControl()

Returns

IPitchToControlModuleHandle

AsReverb() 

IReverbModuleHandle AsReverb()

Returns

IReverbModuleHandle

AsSampler() 

ISamplerModuleHandle AsSampler()

Returns

ISamplerModuleHandle

AsSoundToControl() 

ISoundToControlModuleHandle AsSoundToControl()

Returns

ISoundToControlModuleHandle

AsSpectraVoice() 

ISpectraVoiceModuleHandle AsSpectraVoice()

Returns

ISpectraVoiceModuleHandle

AsVelocityToControl() 

IVelocityToControlModuleHandle AsVelocityToControl()

Returns

IVelocityToControlModuleHandle

AsVibrato() 

IVibratoModuleHandle AsVibrato()

Returns

IVibratoModuleHandle

AsVocalFilter() 

IVocalFilterModuleHandle AsVocalFilter()

Returns

IVocalFilterModuleHandle

AsVorbisPlayer() 

IVorbisPlayerModuleHandle AsVorbisPlayer()

Returns

IVorbisPlayerModuleHandle

AsWaveShaper() 

IWaveShaperModuleHandle AsWaveShaper()

Returns

IWaveShaperModuleHandle

GetControllerCount()

Get the number of controllers in the module.

int GetControllerCount()

Returns

int

Number of controllers.

Remarks

Calls sv_get_number_of_module_ctls(int, int).

Exceptions

SunVoxException

Thrown when the operation fails.

GetControllerGroup(int)

Get the controller group number.

int GetControllerGroup(int controllerId)

Parameters

controllerId int

controller number (0-based).

Returns

int

Controller group number.

Remarks

Calls sv_get_module_ctl_group(int, int, int).

GetControllerMaxValue(int, ValueScalingMode)

Get the controller maximum value.

int GetControllerMaxValue(int controllerId, ValueScalingMode scaling)

Parameters

controllerId int

Controller number (0-based).

scaling ValueScalingMode

Returns

int

Maximum controller value.

Remarks

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

GetControllerMinValue(int, ValueScalingMode)

Get the controller minimum value.

int GetControllerMinValue(int controllerId, ValueScalingMode scaling)

Parameters

controllerId int

Controller number (0-based).

scaling ValueScalingMode

Returns

int

Minimum controller value.

Remarks

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

GetControllerName(int)

Get the controller name.

string? GetControllerName(int controllerId)

Parameters

controllerId int

Controller number (0-based).

Returns

string

Controller name, or null if unavailable.

Remarks

Calls sv_get_module_ctl_name(int, int, int).

GetControllerOffset(int)

Get the controller display value offset.

int GetControllerOffset(int controllerId)

Parameters

controllerId int

Controller number (0-based).

Returns

int

Display value offset.

Remarks

Calls sv_get_module_ctl_offset(int, int, int).

GetControllerType(int)

Get the controller type.

ControllerType GetControllerType(int controllerId)

Parameters

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.

GetControllerValue(int, ValueScalingMode)

Get the controller value.

int GetControllerValue(int controllerId, ValueScalingMode scaling = ValueScalingMode.Displayed)

Parameters

controllerId int

Controller number (0-based).

scaling ValueScalingMode

Returns

int

Controller value.

Remarks

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

LoadIntoMetaModule(byte[])

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

void LoadIntoMetaModule(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.

LoadIntoMetaModule(string)

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

void LoadIntoMetaModule(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.

LoadIntoVorbisPlayer(byte[])

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

void LoadIntoVorbisPlayer(byte[] data)

Parameters

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(string)

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

void LoadIntoVorbisPlayer(string path)

Parameters

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.

LoadSamplerSample(byte[], int?)

Load a sample (xi, wav, aiff) to a Sampler module from memory.

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

Parameters

data byte[]

Byte array with sample data.

sampleSlot int?

Sample slot number (-1 for auto/all slots).

Remarks

Set sampleSlot to null to apply the sample to all sample slots.

Exceptions

SunVoxException

Thrown when the operation fails.

ArgumentNullException

Thrown if data is null.

LoadSamplerSample(string, int?)

Load a sample (xi, wav, aiff) to a Sampler module from file.

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

Parameters

path string

File path (relative or absolute).

sampleSlot int?

Sample slot number (-1 for auto/all slots).

Remarks

Set sampleSlot to null to apply the sample to all sample slots.

Exceptions

SunVoxException

Thrown when the operation fails.

ArgumentNullException

Thrown if path is null.

ReadCurve(int, float[])

Read data from a module curve.

int ReadCurve(int curveId, float[] buffer)

Parameters

curveId int

Curve number.

buffer float[]

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.

SetControllerValue(int, int, ValueScalingMode)

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

void SetControllerValue(int controller, int value, ValueScalingMode scaling = ValueScalingMode.Displayed)

Parameters

controller int
value int

Controller value.

scaling ValueScalingMode

Remarks

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

Exceptions

SunVoxException

Thrown when the operation fails.

WriteCurve(int, float[])

Write data to a module curve.

int WriteCurve(int curveId, float[] buffer)

Parameters

curveId int

Curve number.

buffer float[]

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.

Edit this page