Schemas / Synth
rig.synth.filter
v1.4.0 · stable maturity: draft 5 fields 2 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
mode |
enumlow-pass · high-pass · band-pass | required | low-pass, high-pass, band-pass |
cutoffHertz |
number0 – * | required | Cutoff (Hz) at no modulation. 0 is closed |
resonance |
number0 – 1 | optional | Optional. 0-1 emphasis at the cutoff. Absent = 0 |
decibelsPerOctave |
number> 0 | optional | Optional. Slope (dB/octave). Absent = unset |
input |
entity | optional | Optional. Entity whose audio this filter reads. Absent = unset |
Audio filter in a voice. Format when present.
A drawing filter is rig.paint.filter.
cutoffHertz is the corner when nothing is pushing it. An envelope or an LFO moves it through a rig.mod.binding on cutoffHertz. The open frequency after that push stays host cache.
input is one source, the previous block in the voice. A saw into this filter points input at that rig.synth.oscillator.
Fulfillment
Hosts run the filter in Update over the source sample. Coefficients and the last sample stay a runtime cache.
JSON Schema
Resolves at https://rig.works/schemas/rig.synth.filter.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.synth.filter.schema.json",
"title": "rig.synth.filter",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"type": "string",
"enum": [
"low-pass",
"high-pass",
"band-pass"
]
},
"cutoffHertz": {
"type": "number",
"minimum": 0
},
"resonance": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"decibelsPerOctave": {
"type": "number",
"exclusiveMinimum": 0
},
"input": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"mode",
"cutoffHertz"
],
"x-rig-maturity": "draft"
}