org.algorave.set Documentation (EN)

main record

No description available.

Record Key tid Timestamp-based ID

Properties

code ref #codeMeta Required

Source code and language details

event ref #eventMeta Optional

Event where the set was performed (optional)

links ref #linksMeta Optional

Social and source repository links (optional)

metadata ref #metadataMeta Required

Publication metadata (license, timestamps)

performer ref #performer Required

The performer who created the set

recording ref #recordingMeta Optional

Links to audio/video recordings (optional)

set ref #setMeta Required

Set metadata (title, BPM, genre, tags)

type string Required

NSID of the record

version integer Required

Schema version

minimum: 1

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "type",
      "version",
      "performer",
      "set",
      "code",
      "metadata"
    ],
    "properties": {
      "set": {
        "ref": "#setMeta",
        "type": "ref",
        "description": "Set metadata (title, BPM, genre, tags)"
      },
      "code": {
        "ref": "#codeMeta",
        "type": "ref",
        "description": "Source code and language details"
      },
      "type": {
        "type": "string",
        "const": "org.algorave.set",
        "description": "NSID of the record"
      },
      "event": {
        "ref": "#eventMeta",
        "type": "ref",
        "description": "Event where the set was performed (optional)"
      },
      "links": {
        "ref": "#linksMeta",
        "type": "ref",
        "description": "Social and source repository links (optional)"
      },
      "version": {
        "type": "integer",
        "minimum": 1,
        "description": "Schema version"
      },
      "metadata": {
        "ref": "#metadataMeta",
        "type": "ref",
        "description": "Publication metadata (license, timestamps)"
      },
      "performer": {
        "ref": "#performer",
        "type": "ref",
        "description": "The performer who created the set"
      },
      "recording": {
        "ref": "#recordingMeta",
        "type": "ref",
        "description": "Links to audio/video recordings (optional)"
      }
    }
  }
}

codeMeta object

No description available.

Properties

dependencies object Optional

Additional dependencies (freeform key-value)

engine string Optional

Audio engine used (e.g. superdirt, webaudio, scsynth)

engineVersion string Optional

Version of the audio engine

language string Required

Live coding language (e.g. tidalcycles, strudel, sonic-pi)

languageVersion string Optional

Version of the language

seed integer Optional

Random seed for reproducibility

source string Required

The live coding source code

maxLength: 65536 bytes

View raw schema

{
  "type": "object",
  "required": [
    "language",
    "source"
  ],
  "properties": {
    "seed": {
      "type": "integer",
      "nullable": true,
      "description": "Random seed for reproducibility"
    },
    "engine": {
      "type": "string",
      "description": "Audio engine used (e.g. superdirt, webaudio, scsynth)"
    },
    "source": {
      "type": "string",
      "maxLength": 65536,
      "description": "The live coding source code"
    },
    "language": {
      "type": "string",
      "description": "Live coding language (e.g. tidalcycles, strudel, sonic-pi)"
    },
    "dependencies": {
      "type": "object",
      "description": "Additional dependencies (freeform key-value)"
    },
    "engineVersion": {
      "type": "string",
      "description": "Version of the audio engine"
    },
    "languageVersion": {
      "type": "string",
      "description": "Version of the language"
    }
  }
}

eventMeta object

No description available.

Properties

date string Optional

Event date

location string Optional

Event location

maxLength: 256 bytes

name string Optional

Event name

maxLength: 256 bytes

url string uri Optional

Event URL

maxLength: 2048 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Event URL"
    },
    "date": {
      "type": "string",
      "description": "Event date"
    },
    "name": {
      "type": "string",
      "maxLength": 256,
      "description": "Event name"
    },
    "location": {
      "type": "string",
      "maxLength": 256,
      "description": "Event location"
    }
  }
}

linksMeta object

No description available.

Properties

github string uri Optional

URL to GitHub repository

maxLength: 2048 bytes

social string uri Optional

URL to social media profile

maxLength: 2048 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "github": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "URL to GitHub repository"
    },
    "social": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "URL to social media profile"
    }
  }
}

metadataMeta object

No description available.

Properties

createdAt string datetime Optional

ISO 8601 creation timestamp

isLive boolean Optional

Whether the set was performed live

license string Required

License under which the set is published (e.g. CC-BY-SA-4.0)

publishedAt string datetime Optional

ISO 8601 publication timestamp

supersedes string Optional

AT URI of the set this one supersedes

View raw schema

{
  "type": "object",
  "required": [
    "license"
  ],
  "properties": {
    "isLive": {
      "type": "boolean",
      "default": true,
      "description": "Whether the set was performed live"
    },
    "license": {
      "type": "string",
      "description": "License under which the set is published (e.g. CC-BY-SA-4.0)"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "ISO 8601 creation timestamp"
    },
    "supersedes": {
      "type": "string",
      "nullable": true,
      "description": "AT URI of the set this one supersedes"
    },
    "publishedAt": {
      "type": "string",
      "format": "datetime",
      "description": "ISO 8601 publication timestamp"
    }
  }
}

performer object

No description available.

Properties

did string Optional

AT Protocol DID of the performer

displayName string Optional

Display name of the performer

handle string Required

Handle of the performer

View raw schema

{
  "type": "object",
  "required": [
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "description": "AT Protocol DID of the performer"
    },
    "handle": {
      "type": "string",
      "description": "Handle of the performer"
    },
    "displayName": {
      "type": "string",
      "description": "Display name of the performer"
    }
  }
}

recordingMeta object

No description available.

Properties

audio string uri Optional

URL to audio recording

maxLength: 2048 bytes

video string uri Optional

URL to video recording

maxLength: 2048 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "audio": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "URL to audio recording"
    },
    "video": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "URL to video recording"
    }
  }
}

setMeta object

No description available.

Properties

bpm integer Optional

Beats per minute

minimum: 40maximum: 300

description string Optional

Description of the set

maxLength: 2048 bytes

duration integer Optional

Duration in seconds

minimum: 0

genre array of string Optional

Genre tags

tags array of string Optional

Freeform tags

title string Required

Title of the set

maxLength: 256 bytes

View raw schema

{
  "type": "object",
  "required": [
    "title"
  ],
  "properties": {
    "bpm": {
      "type": "integer",
      "maximum": 300,
      "minimum": 40,
      "description": "Beats per minute"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Freeform tags"
    },
    "genre": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Genre tags"
    },
    "title": {
      "type": "string",
      "maxLength": 256,
      "description": "Title of the set"
    },
    "duration": {
      "type": "integer",
      "minimum": 0,
      "description": "Duration in seconds"
    },
    "description": {
      "type": "string",
      "maxLength": 2048,
      "description": "Description of the set"
    }
  }
}