Enums

Enums#

Type-safe Dart enums that wrap the engine’s C-side enum values.

enum ChannelType#

enum ChannelType

Speaker layout for [System.openDevice].

Values are kept in lockstep with YSE::CHANNEL_TYPE (see YseEngine/headers/enums.hpp) so the Dart enum value cast equals the underlying C enum.

Values#

auto

Pick stereo when possible.

mono

stereo

quad

surround51

5.1 surround.

surround51Side

5.1-side variant.

surround61

6.1 surround.

surround71

7.1 surround.

custom

Custom layout — the caller is expected to set speaker positions.

Constructors#

ChannelType(this.native)

Properties#

final raw.YseChannelType native

The raw FFI enum value passed to the C ABI.

enum ReconnectState#

enum ReconnectState

What the [System.setAutoReconnect] watchdog last did, read from [System.reconnectState].

Values match YSE::RECONNECT_STATE (see YseEngine/headers/enums.hpp).

Values#

none

No attempt since the session started, the last successful [System.openDevice], or the last [System.setAutoReconnect] call.

reconnecting

The last attempt opened nothing; the watchdog tries again after the delay. No stream is open, so [System.refreshDevices] can be called to pick up a device that was plugged back in.

restored

The last attempt reopened the device the session had.

fellBackToDefault

The session’s device could not be reopened, so the default output device was opened instead (only with fallbackToDefault).

failed

The attempt limit was reached and the watchdog stopped trying.

Constructors#

ReconnectState(this.native)

Static methods#

static ReconnectState fromNative(raw.YseReconnectState native)

Maps a raw C-side [raw.YseReconnectState] to its Dart enum.

Properties#

final raw.YseReconnectState native

The raw FFI enum value used by the C ABI.

enum LfoType#

enum LfoType

Low-frequency-oscillator shape used by [DspObject.lfoType].

Values match YSE::DSP::LFO_TYPE.

Values#

none

saw

sawReversed

triangle

sine

square

random

Constructors#

LfoType(this.native)

Properties#

final raw.YseLfoType native

enum VaWaveform#

enum VaWaveform

Oscillator waveform for a synth’s virtual-analog voice ([Synth.setVaOscWave]).

Values match YSE::SYNTH::VA_WAVEFORM (see synth/vaVoice.hpp).

Values#

saw

Band-limited sawtooth.

pulse

Band-limited pulse with variable width (PWM).

triangle

Band-limited triangle.

sine

Sine.

noise

White noise.

wavetable

Morph across the wavetable bank (see [Synth.loadVaWavetable]).

Constructors#

VaWaveform(this.native)

Properties#

final raw.YseVaWaveform native

The raw FFI enum value passed to the C ABI.

enum SweepShape#

enum SweepShape

LFO shape used by the [DspObject.sweep] constructor.

Values#

triangle

saw

square

Constructors#

SweepShape(this.native)

Properties#

final raw.YseDspSweepShape native

enum LogLevel#

enum LogLevel

Log-level filter for [Log].

Values match YSE::ERROR_LEVEL.

Values#

none

error

warning

debug

Constructors#

LogLevel(this.native)

Properties#

final raw.YseErrorLevel native

enum OutType#

enum OutType

Data type produced by a patcher outlet ([PHandle.outputDataType]).

Values match YSE::OUT_TYPE.

Values#

invalid

bang

float

integer

buffer

list

any

Constructors#

OutType(this.native)

Static methods#

static OutType fromNative(raw.YseOutType native)

Maps a raw C-side [raw.YseOutType] to its Dart enum, defaulting to [OutType.invalid] for unknown values.

Properties#

final raw.YseOutType native

enum PCategory#

enum PCategory

Documentation category a patcher object type is filed under ([PatcherObjectType.category]).

Drives the section headings on the patcher object reference. Values match YSE::PATCHER::pCategory (mirrored by the C enum YsePCategory).

Values#

unset

Uncategorised — should not reach a shipped object in practice.

oscillator

Oscillators / signal generators.

filter

Filters.

math

Arithmetic / math objects.

generic

Generic routing / utility objects.

gui

GUI control objects.

time

Timing objects.

midi

MIDI message objects.

routing

Message steering (.gate, .route, .sel, …).

control

Control flow and ordering (.trigger, .uzi, …).

list

Building and taking apart lists (.pack, .zl, …).

string

Symbols and text (.sprintf, .regexp, …).

collection

Stores (.coll, .table, .bag, …).

dict

The .dict family.

array

The .array family.

random

Random and probabilistic sources.

io

Audio and host I/O (~adc, ~dac, .s, .r, .print, …).

encapsulation

Subpatchers and their inlets / outlets.

sequence

Timed recorders / players (.seq, .mtr, .qlist).

Constructors#

PCategory(this.native)

Static methods#

static PCategory fromNative(raw.YsePCategory native)

Maps a raw C-side [raw.YsePCategory] to its Dart enum, defaulting to [PCategory.unset] for unknown values.

Properties#

final raw.YsePCategory native

enum InletAccepts#

enum InletAccepts

One message kind a patcher inlet accepts ([PatcherInlet.accepts]).

The engine reports the set as an OR-ed bitmask; the wrapper decodes it into a Set<InletAccepts>. Values match YSE::PATCHER::InletType (mirrored by the C enum YseInletAccepts).

Values#

buffer

Accepts an audio-rate DSP buffer.

float

Accepts a float.

integer

Accepts an integer.

bang

Accepts a bang.

list

Accepts a list.

Constructors#

InletAccepts(this.native)

Static methods#

static Set<InletAccepts> fromBitmask(int mask)

Decodes an engine accepts bitmask into the set of flags it encodes.

Properties#

final raw.YseInletAccepts native

enum DelayTap#

enum DelayTap

One of the three delay taps on a [DspObject.basicDelay] (and its filtered subclasses).

Values#

first

second

third

Constructors#

DelayTap(this.native)

Properties#

final raw.YseDspDelayTap native

enum ReverbPreset#

enum ReverbPreset

Named reverb-tail presets for [Reverb.preset].

Values match YSE::REVERB_PRESET.

Values#

off

generic

padded

room

bathroom

stoneroom

largeroom

hall

cave

sewerpipe

underwater

Constructors#

ReverbPreset(this.native)

Properties#

final raw.YseReverbPreset native

The raw FFI enum value passed to the C ABI.

enum ChorusMode#

enum ChorusMode

Modulation character of a [Chorus] module.

Values match YSE::DSP::MODULES::chorusMode (see chorus.hpp).

Values#

chorus

Longer base delay with a wide, slow sweep.

flanger

Short base delay with a feedback comb.

Constructors#

ChorusMode(this.native)

Properties#

final raw.YseChorusMode native

enum EqBand#

enum EqBand

One of the four fixed bands of a [ParametricEq].

Values match YSE::DSP::MODULES::eqBand (see parametricEQ.hpp). The YSE_EQ_BAND_COUNT sentinel is intentionally omitted.

Values#

lowShelf

Low shelf.

peak1

First peaking band.

peak2

Second peaking band.

highShelf

High shelf.

Constructors#

EqBand(this.native)

Properties#

final raw.YseEqBand native

enum CompressorDetector#

enum CompressorDetector

Level-detector mode of a [Compressor].

Values match YSE::DSP::MODULES::compressorDetector (see compressor.hpp).

Values#

peak

Instantaneous linked peak.

rms

Short mean-square window.

Constructors#

CompressorDetector(this.native)

Properties#

final raw.YseCompressorDetector native