io.sound.sequence Documentation (EN)

main record

A sequence of timed events. Full documentation at https://github.com/soundio/sequence/.

Record Key any Any valid record key

Properties

bskyPostRef ref com.atproto.repo.strongRef Optional

Strong reference to a Bluesky post. Useful to keep track of comments off-platform.

credits array of ref io.sound.credit Optional

Attribution for composers, arrangers, etc

maxLength: 60 items

events bytes Required

Serialised and binary encoded array of events of the form `[beat, type, data...]`, where `data` parameters depend on `type` and the byte layout of the serialised data conforms to the Sequence spec at https://github.com/soundio/sequence.

maxLength: 524288

id integer Optional

Identifies this sequence for playback by a "sequence" event.

maximum: 65535

name string Optional

Name of the sequence

maxLength: 1280 bytesmaxGraphemes: 640 graphemes

publishedAt string datetime Optional

Timestamp of the time of publication.

sequences array of ref io.sound.sequence Optional

A collection of sequences that may be played back by "sequence" events.

tags array of string Optional

Array of strings used to tag the sequence.

updatedAt string datetime Optional

Timestamp of the time of last edit.

url string uri Optional

Canonical location of this sequence. May be an `at://` URI or an `https://` URL to a JSON endpoint.

version integer Optional

Version number for the byte array encoding of the events field.

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "events"
    ],
    "properties": {
      "id": {
        "type": "integer",
        "maximum": 65535,
        "description": "Identifies this sequence for playback by a \"sequence\" event."
      },
      "url": {
        "type": "string",
        "format": "uri",
        "description": "Canonical location of this sequence. May be an `at://` URI or an `https://` URL to a JSON endpoint."
      },
      "name": {
        "type": "string",
        "maxLength": 1280,
        "description": "Name of the sequence",
        "maxGraphemes": 640
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 1280,
          "maxGraphemes": 128
        },
        "description": "Array of strings used to tag the sequence."
      },
      "events": {
        "type": "bytes",
        "maxLength": 524288,
        "description": "Serialised and binary encoded array of events of the form `[beat, type, data...]`, where `data` parameters depend on `type` and the byte layout of the serialised data conforms to the Sequence spec at https://github.com/soundio/sequence."
      },
      "credits": {
        "type": "array",
        "items": {
          "ref": "io.sound.credit",
          "type": "ref"
        },
        "maxLength": 60,
        "description": "Attribution for composers, arrangers, etc"
      },
      "version": {
        "type": "integer",
        "description": "Version number for the byte array encoding of the events field."
      },
      "sequences": {
        "type": "array",
        "items": {
          "ref": "io.sound.sequence",
          "type": "ref"
        },
        "description": "A collection of sequences that may be played back by \"sequence\" events."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of the time of last edit."
      },
      "bskyPostRef": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "Strong reference to a Bluesky post. Useful to keep track of comments off-platform."
      },
      "publishedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of the time of publication."
      }
    }
  },
  "description": "A sequence of timed events. Full documentation at https://github.com/soundio/sequence/."
}