`rig.media.asset_ref`

v1.0.0 · stable maturity: stable 3 fields 2 required

Fields

Field	Type		Meaning
`kind`	enumimage · audio · video · model · font · document · preset · other	required	image, audio, video, model, font, document, preset, other
`path`	string	required	File or directory path. Sidecars that travel with the document are relative to the package `data/` folder (`covers/moby-dick.jpg`, not `data/covers/moby-dick.jpg`). Absolute, URL, and other host-root paths stay host-root - interchange
`loop`	bool	optional	Optional. Playback loop when the asset kind supports it; meaningless for stills, so absent is not false - it is "not applicable"

File identity. One schema for paths. Format when present.

Decode / GPU / players are fulfillment. Other schemas reference this entity - they do not invent parallel path fields.

JSON Schema

Resolves at https://rig.works/schemas/rig.media.asset_ref.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.media.asset_ref.schema.json",
  "title": "rig.media.asset_ref",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "image",
        "audio",
        "video",
        "model",
        "font",
        "document",
        "preset",
        "other"
      ]
    },
    "path": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "loop": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "kind",
    "path"
  ],
  "x-rig-maturity": "stable"
}

Seen in

art-object.json · bim-bcf.json · book-isbn.json · environment.json · kicad-pcb.json · legal-agreement.json · person-contact.json · plant-taxon.json · play-scene.json · print-fgf.json · record-bank.json · record-care.json · text-path.json · visualizer.json