Table of Contents

Namespace SunSharp.Modules

Classes

IncorrectSynthHandleTypeException

Structs

AdsrModuleHandle

ADSR envelope generator. The module can be started either by notes at the input (reacts to note ON/OFF), or by setting the 'State' controller to the 'start' value.

AmplifierModuleHandle

Signal amplifier with various settings.

AnalogGeneratorModuleHandle

Generator with 32 double alias-free oscillators, 12/24dB filters, envelopes, and smooth change of parameters. The sound quality of this module is better at a sample rate of 44100Hz.

CompressorModuleHandle

Side chain compressor

ControlToNoteModuleHandle

Ctl2Note converts the value of the 'Pitch' controller to a note (Note ON/OFF commands at the output).

DcBlockerModuleHandle

DC blocking filter.

DelayModuleHandle

This module delays the sound and the incoming events (note, pitch, phase, velocity). Max delay length = 1 min.

DistortionModuleHandle

This module adds various types of distortion to the sound.

DrumSynthModuleHandle

Drum synthesizer with variety of predefined sounds. The sound quality of this module is better at a sample rate of 44100Hz.

EchoModuleHandle

Stereo echo. Maximum delay length: 4 seconds.

EqModuleHandle

3Band equalizer.

FeedbackModuleHandle

Generally the feedback is not allowed in SunVox: you can't create an endless loop between the modules. But you can do it by placing two Feedback modules inside of the loop.

FftModuleHandle

FFT-based frequency transformator.

FilterModuleHandle

IIR Filter that can remove some unwanted frequency ranges.

FilterProModuleHandle

High-quality 64-bit IIR Filter that can amplify, pass or attenuate some frequency ranges. This module is faster than Filter on modern CPUs and slower on older CPUs.

FlangerModuleHandle

Flanger effect.

FmModuleHandle

Frequency Modulation (FM) Synthesizer. Each voice of polyphony includes two operators with ADSR envelopes: 1) C (carrier) - base sine wave generator; 2) M (modulator) - sine wave that changes the frequency of the first operator. The sound quality of this module is better at a sample rate of 44100Hz.

FmxModuleHandle

5-operator Frequency Modulation (FM) Synthesizer.

GeneratorModuleHandle

Basic generator of different types of periodic signal waveforms with the volume envelope. This module can receive the incoming signal and use it for the frequency modulation.

GlideModuleHandle

Glide is similar to the MultiSynth (which sends the input events to the connected output modules), but it also adds the commands of smooth transition between the notes.

GpioModuleHandle

With this module you can use the General-Purpose Input/Output (GPIO) pins of the device board. For example, you can send some signals to the LEDs, or receive the ON/OFF (1/0) messages from the buttons.

InputModuleHandle

Audio input from Microphone/Line-in. Compatibility: implemented in the iOS and Android versions only.

KickerModuleHandle

Drum kick synthesizer with waveform type, attack, release, boost and envelope acceleration controls.

LfoModuleHandle

LFO - Low Frequency Oscillator. Can work as amplitude/balance modulator or as standalone generator.

LoopModuleHandle

This module repeats a fragment of the incoming sound a specified number of times.

MetaModuleModuleHandle

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

ModulatorModuleHandle

Amplitude or Phase modulator. First input = Carrier. Other inputs = Modulators (will be mixed into a single signal).

MultiControlModuleHandle

With this module you can change the values of multiple controllers (in different modules) at once. Maximum number of connected controllers - 16.

MultiSynthModuleHandle

This module sends the incoming events (notes, pitch change, phase change) to any number of connected modules (receivers).

OutputModuleHandle

Audio output module.

PitchDetectorModuleHandle

Pitch Detector tries to detect the pitch of the incoming audio signal. The frequency and note will be displayed. Notes will be sent to the module output.

PitchShifterModuleHandle

Pitch shifter is a module for changing the pitch of any sound in real time. The signal at the output of the module is always slightly delayed.

PitchToControlModuleHandle

This module converts the incoming notes to the controller values (in some another connected module).

ReverbModuleHandle

Reverb is a module that simulates the reverberation effect (echo with numerous reflections to make the sound more natural).

SamplerModuleHandle

Sampler can play and record audio files. Supported file formats: WAV (PCM, uncompressed), AIFF (PCM, uncompressed), XI, OGG (Vorbis), MP3, FLAC, JPEG, RAW.

SoundToControlModuleHandle

This module converts the audio signal to the numeric value of any selected controller.

SpectraVoiceModuleHandle

SpectraVoice synthesizes sound with a complex spectrum. You can place 16 harmonics on the spectrum graph, specifying the position, amplitude, shape and width for each.

VelocityToControlModuleHandle

This module converts the velocity parameter of the incoming notes to the controller values (in some another connected module).

VibratoModuleHandle

Vibrato effect.

VocalFilterModuleHandle

Formant filter - designed to simulate the human vocal tract.

VorbisPlayerModuleHandle

OGG Vorbis player.

WaveShaperModuleHandle

In simple terms, WaveShaper allows you to change the shape of the input signal. In math terms, WaveShaper is the expression y = f( x ); where y - output; x - input; f - function with graph which you can see in the WaveShaper interface.

Interfaces

IAdsrModuleHandle

ADSR envelope generator. The module can be started either by notes at the input (reacts to note ON/OFF), or by setting the 'State' controller to the 'start' value.

IAmplifierModuleHandle

Signal amplifier with various settings.

IAnalogGeneratorModuleHandle

Generator with 32 double alias-free oscillators, 12/24dB filters, envelopes, and smooth change of parameters. The sound quality of this module is better at a sample rate of 44100Hz.

ICompressorModuleHandle

Side chain compressor

IControlToNoteModuleHandle

Ctl2Note converts the value of the 'Pitch' controller to a note (Note ON/OFF commands at the output).

IDcBlockerModuleHandle

DC blocking filter.

IDelayModuleHandle

This module delays the sound and the incoming events (note, pitch, phase, velocity). Max delay length = 1 min.

IDistortionModuleHandle

This module adds various types of distortion to the sound.

IDrumSynthModuleHandle

Drum synthesizer with variety of predefined sounds. The sound quality of this module is better at a sample rate of 44100Hz.

IEchoModuleHandle

Stereo echo. Maximum delay length: 4 seconds.

IEqModuleHandle

3Band equalizer.

IFeedbackModuleHandle

Generally the feedback is not allowed in SunVox: you can't create an endless loop between the modules. But you can do it by placing two Feedback modules inside of the loop.

IFftModuleHandle

FFT-based frequency transformator.

IFilterModuleHandle

IIR Filter that can remove some unwanted frequency ranges.

IFilterProModuleHandle

High-quality 64-bit IIR Filter that can amplify, pass or attenuate some frequency ranges. This module is faster than Filter on modern CPUs and slower on older CPUs.

IFlangerModuleHandle

Flanger effect.

IFmModuleHandle

Frequency Modulation (FM) Synthesizer. Each voice of polyphony includes two operators with ADSR envelopes: 1) C (carrier) - base sine wave generator; 2) M (modulator) - sine wave that changes the frequency of the first operator. The sound quality of this module is better at a sample rate of 44100Hz.

IFmxModuleHandle

5-operator Frequency Modulation (FM) Synthesizer.

IGeneratorModuleHandle

Basic generator of different types of periodic signal waveforms with the volume envelope. This module can receive the incoming signal and use it for the frequency modulation.

IGlideModuleHandle

Glide is similar to the MultiSynth (which sends the input events to the connected output modules), but it also adds the commands of smooth transition between the notes.

IGpioModuleHandle

With this module you can use the General-Purpose Input/Output (GPIO) pins of the device board. For example, you can send some signals to the LEDs, or receive the ON/OFF (1/0) messages from the buttons.

IInputModuleHandle

Audio input from Microphone/Line-in. Compatibility: implemented in the iOS and Android versions only.

IKickerModuleHandle

Drum kick synthesizer with waveform type, attack, release, boost and envelope acceleration controls.

ILfoModuleHandle

LFO - Low Frequency Oscillator. Can work as amplitude/balance modulator or as standalone generator.

ILoopModuleHandle

This module repeats a fragment of the incoming sound a specified number of times.

IMetaModuleModuleHandle

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

IModulatorModuleHandle

Amplitude or Phase modulator. First input = Carrier. Other inputs = Modulators (will be mixed into a single signal).

IMultiControlModuleHandle

With this module you can change the values of multiple controllers (in different modules) at once. Maximum number of connected controllers - 16.

IMultiSynthModuleHandle

This module sends the incoming events (notes, pitch change, phase change) to any number of connected modules (receivers).

IOutputModuleHandle

Audio output module.

IPitchDetectorModuleHandle

Pitch Detector tries to detect the pitch of the incoming audio signal. The frequency and note will be displayed. Notes will be sent to the module output.

IPitchShifterModuleHandle

Pitch shifter is a module for changing the pitch of any sound in real time. The signal at the output of the module is always slightly delayed.

IPitchToControlModuleHandle

This module converts the incoming notes to the controller values (in some another connected module).

IReverbModuleHandle

Reverb is a module that simulates the reverberation effect (echo with numerous reflections to make the sound more natural).

ISamplerModuleHandle

Sampler can play and record audio files. Supported file formats: WAV (PCM, uncompressed), AIFF (PCM, uncompressed), XI, OGG (Vorbis), MP3, FLAC, JPEG, RAW.

ISoundToControlModuleHandle

This module converts the audio signal to the numeric value of any selected controller.

ISpectraVoiceModuleHandle

SpectraVoice synthesizes sound with a complex spectrum. You can place 16 harmonics on the spectrum graph, specifying the position, amplitude, shape and width for each.

ITypedModuleHandle
IVelocityToControlModuleHandle

This module converts the velocity parameter of the incoming notes to the controller values (in some another connected module).

IVibratoModuleHandle

Vibrato effect.

IVocalFilterModuleHandle

Formant filter - designed to simulate the human vocal tract.

IVorbisPlayerModuleHandle

OGG Vorbis player.

IWaveShaperModuleHandle

In simple terms, WaveShaper allows you to change the shape of the input signal. In math terms, WaveShaper is the expression y = f( x ); where y - output; x - input; f - function with graph which you can see in the WaveShaper interface.

Enums

AdsrCurveType

ADSR envelope curve types.

AdsrMode

ADSR operation modes.

AdsrOnNoteOffBehaviour
AdsrOnNoteOnBehaviour
AdsrSmoothTransitions

ADSR smooth transition modes.

AdsrSustainMode

ADSR sustain modes.

AnalogGeneratorEnvelopeMode
AnalogGeneratorFilterType

Analog Generator filter types.

AnalogGeneratorSecondaryOscillatorMode

Analog Generator secondary oscillator mixing modes.

AnalogGeneratorWaveform
Channels
ChannelsInverted
CompressorMode

Compressor operation modes.

ControlToNoteOffBehaviour
ControlToNoteOnBehaviour
DelayUnit

Time unit for Delay module.

DistortionType
EchoDelayUnit

Time unit for Echo module delay.

EchoFilter

Echo filter types.

FftBufferOverlap

FFT buffer overlap settings. Less overlap = less CPU load; the more overlap, the softer the sound.

FftBufferSize

FFT buffer size. The larger the buffer, the more precisely the module works and the higher the delay.

FftSampleRate

FFT sample rate. This value can be reduced if the CPU load is too high.

FilterLfoFrequencyUnit
FilterLfoWaveform
FilterProMode
FilterProRollOff

Filter Pro roll-off (dB per octave). Affects all types except peaking and low/high shelf.

FilterProType

Filter Pro filter types.

FilterRollOff
FilterType
FlangerLfoFrequencyUnit
FlangerLfoWaveform
FmxCustomWaveform
FmxModulationType

FMX modulation types between operators.

FmxSampleRate

FMX sample rate. This value can be reduced if the CPU load is too high.

FmxWaveform
GeneratorWaveform
KickerWaveform
LfoFrequencyUnit
LfoSineQuality

LFO sine waveform quality settings.

LfoSmoothTransitions
LfoType

LFO operation types.

LfoWaveform
LoopMode
LoopOnNoteOn
LoopTimeUnit
MetaModulePatternMode

MetaModule pattern playback modes.

ModulationType

Modulator modulation types.

ModulatorMaxPhaseModulationDelay
ModulatorPhaseModulationInterpolation
PitchDetectorAlgSampleRate

Pitch Detector sampling rate for algorithms 1 and 2. A lower value will reduce the CPU load, but also reduce the quality of detection.

PitchDetectorAlgorithm

Pitch Detector algorithm types.

PitchDetectorBufferSize

Pitch Detector buffer size for algorithms 1 and 2. Less buffer size = less latency; larger buffer size = better detection quality.

PitchShifterBypassMode

Pitch Shifter bypass modes when pitch is zero.

PitchToControlMode

Pitch2Ctl conversion modes.

PitchToControlOnNoteOff
Quality

Quality modes for various modules.

ReverbAllPassFilter
SamplerEnvelopeInterpolation
SamplerInterpolation
SamplerRecordState
SoundToControlMode
SpectraVoiceHarmonicType
SpectraVoiceMode
SpectraVoiceResolution

SpectraVoice spectrum resolution (number of samples).

Toggle
ToggleInverse
VelocityToControlOnNoteOff
VibratoFrequencyUnit
VocalFilterVoiceType

Vocal Filter voice types representing different vocal tract characteristics.

VocalFilterVowel

Vocal Filter vowel types for formant simulation.