Schemas / Synth

rig.synth.oscillator

v1.4.0 · stable maturity: draft 3 fields 1 required

Fields

FieldTypeMeaning
waveform enumsine · tri · saw · square required sine, tri, saw, square. The same four words as rig.mod.lfo
pitch integer0 – 127 optional Optional. MIDI note 0-127 at no modulation. 60 is C4. Absent = 60. Same numbering as rig.music.note
pulseWidth number0 – 1 optional Optional. 0-1 duty of a square. Absent = 0.5. Other waveforms ignore it

Pitched audio oscillator. Format when present.

The shapes are the same four words as rig.mod.lfo. This one is the tone. The LFO is the slow modulator. Unpitched noise stays waveform 4 on rig.music.step.

pitch is the note the oscillator holds when nothing is pushing it. A host turns that note into a frequency. The live frequency, the phase, and the sample stay host cache.

Frequency modulation and pulse-width modulation are a rig.mod.binding onto pitch or pulseWidth. A second oscillator is a second entity.

A panel that carries this block also carries rig.modular.module. Its jacks are child rig.modular.port entities. Volts per octave stay on the jack.

Fulfillment

Hosts advance the oscillator in Update. Sample into a runtime cache. Do not serialize the last sample.

JSON Schema

Resolves at https://rig.works/schemas/rig.synth.oscillator.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.synth.oscillator.schema.json",
  "title": "rig.synth.oscillator",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "waveform": {
      "type": "string",
      "enum": [
        "sine",
        "tri",
        "saw",
        "square"
      ]
    },
    "pitch": {
      "type": "integer",
      "minimum": 0,
      "maximum": 127
    },
    "pulseWidth": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  },
  "required": [
    "waveform"
  ],
  "x-rig-maturity": "draft"
}

Seen in

synth-voice.json