Schemas / Music

rig.music.sequencer

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

Fields

FieldTypeMeaning
pattern entity required Entity with rig.music.pattern
currentStep int optional Optional. Playhead index into pattern.steps; absent = 0
clock entity optional Optional. Entity with rig.music.clock; absent = the host's default clock

Playhead over a pattern. Format when present.

A sequencer has a pattern. The pattern has steps.

Running state comes from transport (playing). Step count = pattern.steps.length. No onStep callbacks.

JSON Schema

Resolves at https://rig.works/schemas/rig.music.sequencer.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.music.sequencer.schema.json",
  "title": "rig.music.sequencer",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "pattern": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "currentStep": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "clock": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "pattern"
  ],
  "x-rig-maturity": "draft"
}

Seen in

music-sequencer.json