Schemas / Audio

rig.audio.bus

v0.31.0 · draft 2 fields 0 required

Fields

FieldTypeMeaning
gain number0 – 1 optional Optional. 0-1 linear gain; absent = 1
mute bool optional Optional. Silent when true; absent = false

Master (or named) audio bus gain and mute. Format when present.

Compose rig.meta.named when more than one bus exists.

A house / master mute is this component on a named bus - do not invent a second mute schema. Visuals going dark is fulfillment (rig.render.visibility, light intensity, or a clear), not a portable blackout bit.

Per-stream players, decoders, and mix buffers are fulfillment. Asset identity for clips lives on rig.media.asset_ref.

JSON Schema

Resolves at https://rig.works/schemas/rig.audio.bus.schema.json — raw file. 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.audio.bus.schema.json",
  "title": "rig.audio.bus",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "gain": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "mute": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  }
}