{ "openrpc": "1.3.2", "info": { "title": "MAGDA Remote API", "version": "1.0", "description": "JSON-RPC 2.0 over a loopback WebSocket, generated from MAGDA's operation registry; `system.describe` returns the same catalogue at runtime. `params` objects are closed: unknown fields are rejected." }, "servers": [ { "name": "MAGDA WebSocket", "url": "ws://127.0.0.1:${port}/rpc", "summary": "The loopback listener of a running MAGDA", "description": "Read `url` and `token` from the discovery record `remote-api-.json` in MAGDA's data directory. Name the client with `?client=` and send the token as `Authorization: Bearer `.", "variables": { "port": { "default": "51734", "description": "The discovery record's `port`." } } } ], "methods": [ { "name": "system.describe", "summary": "List the API version and every available operation", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "apiVersion": { "type": "string" }, "operations": { "type": "array" } }, "required": [ "apiVersion", "operations" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "engine.health", "summary": "Read engine binding, callback load, xruns, and recent problems", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "engine": { "type": "string" }, "observedAtMs": { "type": "number", "minimum": 0 }, "sinceMs": { "type": [ "number", "null" ], "minimum": 0 }, "projectBound": { "type": [ "boolean", "null" ] }, "audioDeviceOpen": { "type": [ "boolean", "null" ] }, "xrunCount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "dropoutCount": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "callbackLoad": { "type": [ "number", "null" ], "minimum": 0 }, "problemCoverage": { "type": "string", "enum": [ "audioIoObservations", "unavailable" ] }, "problems": { "type": "array", "maxItems": 32, "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "audio_xrun", "xrun_counter_reset", "audio_device_unavailable" ] }, "atMs": { "type": "number", "minimum": 0 }, "count": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, "required": [ "code", "atMs", "count" ], "additionalProperties": false } }, "discardedProblemCount": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "engine", "observedAtMs", "sinceMs", "projectBound", "audioDeviceOpen", "xrunCount", "dropoutCount", "callbackLoad", "problemCoverage", "problems", "discardedProblemCount" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "meters.read", "summary": "Read one bounded track and master peak snapshot", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "observedAtMs": { "type": "number", "minimum": 0 }, "tracks": { "type": "array", "maxItems": 128, "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "available": { "type": "boolean" }, "peakL": { "type": [ "number", "null" ], "minimum": 0 }, "peakR": { "type": [ "number", "null" ], "minimum": 0 }, "clipped": { "type": [ "boolean", "null" ] } }, "required": [ "trackId", "available", "peakL", "peakR", "clipped" ], "additionalProperties": false } }, "truncatedTrackCount": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "master": { "type": "object", "properties": { "available": { "type": "boolean" }, "peakL": { "type": [ "number", "null" ], "minimum": 0 }, "peakR": { "type": [ "number", "null" ], "minimum": 0 }, "clipped": { "type": [ "boolean", "null" ] } }, "required": [ "available", "peakL", "peakR", "clipped" ], "additionalProperties": false } }, "required": [ "observedAtMs", "tracks", "truncatedTrackCount", "master" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "jobs.list", "summary": "List asynchronous jobs owned by this connection", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "jobs.get", "summary": "Inspect one asynchronous job owned by this connection", "paramStructure": "by-name", "params": [ { "name": "jobId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "jobs.cancel", "summary": "Cancel one owned asynchronous job", "paramStructure": "by-name", "params": [ { "name": "jobId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "engine.renderRange", "summary": "Render an explicit project range to an absolute path", "paramStructure": "by-name", "params": [ { "name": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 } }, { "name": "range", "required": true, "schema": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "beats", "seconds" ], "maxLength": 16384 }, "start": { "type": "number", "minimum": 0, "maximum": 1000000 }, "end": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000000 } }, "required": [ "unit", "start", "end" ], "additionalProperties": false } }, { "name": "format", "required": true, "schema": { "type": "string", "enum": [ "wav", "flac", "opus", "mp3" ], "maxLength": 16384 } }, { "name": "sampleRate", "required": true, "schema": { "type": "integer", "enum": [ 44100, 48000, 88200, 96000, 176400, 192000 ] } }, { "name": "bitDepth", "required": true, "schema": { "type": "integer", "enum": [ 16, 24, 32 ] } }, { "name": "dither", "required": true, "schema": { "type": "string", "enum": [ "none", "tpdf", "shaped" ], "maxLength": 16384 } }, { "name": "normalise", "required": true, "schema": { "type": "boolean" } }, { "name": "normaliseToDb", "required": true, "schema": { "type": "number", "minimum": -60, "maximum": 0 } }, { "name": "includeMasterEffects", "required": true, "schema": { "type": "boolean" } }, { "name": "includeTrackEffects", "required": true, "schema": { "type": "boolean" } }, { "name": "realTime", "required": true, "schema": { "type": "boolean" } }, { "name": "tailSeconds", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 60 } }, { "name": "overwritePolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "replace" ], "maxLength": 16384 } }, { "name": "bitrateKbps", "required": false, "schema": { "type": "integer", "enum": [ 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 510 ] } }, { "name": "vbrQuality", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.freeze", "summary": "Freeze a track: render it offline and play the render in its place", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.unfreeze", "summary": "Unfreeze a track so its devices play live again", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "engine.masterCapture.start", "summary": "Capture the true master callback output", "paramStructure": "by-name", "params": [ { "name": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 } }, { "name": "format", "required": true, "schema": { "type": "string", "enum": [ "wav", "flac" ], "maxLength": 16384 } }, { "name": "bitDepth", "required": true, "schema": { "type": "integer", "enum": [ 16, 24, 32 ] } }, { "name": "overwritePolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "replace" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "engine.masterCapture.stop", "summary": "Stop and finalise one owned master capture", "paramStructure": "by-name", "params": [ { "name": "jobId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "capture.recentMaster", "summary": "KEEP: what was just played, as notes on the track that heard them when a MIDI device was played, else as master audio on a new track. A transport pass lands where it was heard, a phrase played while stopped at the playhead; at most bars bars (default: the Capture Length setting). Fails when the capture buffer is off", "paramStructure": "by-name", "params": [ { "name": "bars", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 64 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number" }, "lengthBeats": { "type": "number" }, "filePath": { "type": "string" }, "midiTrackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "midiClipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "trackId", "clipId", "startBeat", "lengthBeats", "filePath" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "engine.masterCapture.status", "summary": "Read master-capture capability and activity", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "supported": { "type": "boolean" }, "active": { "type": "boolean" }, "failed": { "type": "boolean" }, "jobId": { "type": [ "string", "null" ] } }, "required": [ "supported", "active", "failed", "jobId" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "project.get", "summary": "Get safe project metadata", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "project.new", "summary": "Create an untitled project", "paramStructure": "by-name", "params": [ { "name": "discardUnsavedChanges", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.close", "summary": "Close the current project", "paramStructure": "by-name", "params": [ { "name": "discardUnsavedChanges", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.open", "summary": "Open a project from an absolute path", "paramStructure": "by-name", "params": [ { "name": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 } }, { "name": "dirtyPolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "discard" ], "maxLength": 16384 } }, { "name": "autosavePolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "recover", "ignore" ], "maxLength": 16384 } }, { "name": "missingMediaPolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "allow" ], "maxLength": 16384 } }, { "name": "unavailableDevicePolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "allow" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.save", "summary": "Save the project to its existing target", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.saveAs", "summary": "Save to an absolute path", "paramStructure": "by-name", "params": [ { "name": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 } }, { "name": "overwritePolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "replace" ], "maxLength": 16384 } }, { "name": "mediaPolicy", "required": true, "schema": { "type": "string", "enum": [ "copy", "move" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.setTempo", "summary": "Set the project tempo", "paramStructure": "by-name", "params": [ { "name": "tempo", "required": true, "schema": { "type": "number", "minimum": 20, "maximum": 400 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.setTimeSignature", "summary": "Set the project time signature", "paramStructure": "by-name", "params": [ { "name": "numerator", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 32 } }, { "name": "denominator", "required": true, "schema": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "project.setLoopRange", "summary": "Set the project loop range in beats", "paramStructure": "by-name", "params": [ { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0 } }, { "name": "endBeat", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "open": { "type": "boolean" }, "path": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "tempo": { "type": "number", "minimum": 20, "maximum": 400 }, "timeSignatureNumerator": { "type": "integer", "minimum": 1, "maximum": 32 }, "timeSignatureDenominator": { "type": "integer", "enum": [ 1, 2, 4, 8, 16, 32 ] }, "sampleRate": { "type": "number", "exclusiveMinimum": 0 }, "timelineLengthBars": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "keyRoot": { "type": "integer", "minimum": -1, "maximum": 11 }, "keyQuality": { "type": "string", "enum": [ "major", "minor" ] }, "loopEnabled": { "type": "boolean" }, "loopStartBeats": { "type": "number", "minimum": 0 }, "loopEndBeats": { "type": "number", "minimum": 0 }, "dirty": { "type": "boolean" }, "hasSaveTarget": { "type": "boolean" } }, "required": [ "open", "path", "name", "tempo", "timeSignatureNumerator", "timeSignatureDenominator", "sampleRate", "timelineLengthBars", "keyRoot", "keyQuality", "loopEnabled", "loopStartBeats", "loopEndBeats", "dirty", "hasSaveTarget" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "trackPresets.list", "summary": "List saved track-chain presets by opaque id", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" } }, "required": [ "id", "name", "category" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "chordTrack.get", "summary": "Get the singleton chord track and ordered progression", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "track": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false }, { "type": "null" } ] }, "chords": { "type": "array", "items": { "type": "object", "properties": { "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipBeat": { "type": "number", "minimum": 0 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "name": { "type": "string" } }, "required": [ "clipId", "clipBeat", "startBeat", "lengthBeats", "name" ], "additionalProperties": false } } }, "required": [ "track", "chords" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "chordTrack.ensure", "summary": "Create the singleton chord track when absent", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "track": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false }, { "type": "null" } ] }, "chords": { "type": "array", "items": { "type": "object", "properties": { "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipBeat": { "type": "number", "minimum": 0 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "name": { "type": "string" } }, "required": [ "clipId", "clipBeat", "startBeat", "lengthBeats", "name" ], "additionalProperties": false } } }, "required": [ "track", "chords" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chordTrack.replaceProgression", "summary": "Replace the chord track's structured progression", "paramStructure": "by-name", "params": [ { "name": "chords", "required": true, "schema": { "type": "array", "maxItems": 256, "items": { "type": "object", "properties": { "startBeat": { "type": "number", "minimum": 0, "maximum": 1000000 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000000 }, "root": { "type": "string", "enum": [ "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" ], "maxLength": 16384 }, "quality": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "startBeat", "lengthBeats", "root", "quality" ], "additionalProperties": false } } }, { "name": "voicing", "required": false, "schema": { "type": "string", "const": "root", "maxLength": 16384 } }, { "name": "inversion", "required": false, "schema": { "type": "integer", "const": 0 } }, { "name": "octave", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 6 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "track": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false }, { "type": "null" } ] }, "chords": { "type": "array", "items": { "type": "object", "properties": { "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipBeat": { "type": "number", "minimum": 0 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "name": { "type": "string" } }, "required": [ "clipId", "clipBeat", "startBeat", "lengthBeats", "name" ], "additionalProperties": false } } }, "required": [ "track", "chords" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chordTrack.detect", "summary": "Detect a structured progression in a MIDI clip range", "paramStructure": "by-name", "params": [ { "name": "sourceClipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1000000 } }, { "name": "endBeat", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000000 } }, { "name": "windowBeats", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 64 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "sourceClipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 }, "endBeat": { "type": "number", "exclusiveMinimum": 0 }, "chords": { "type": "array", "maxItems": 256, "items": { "type": "object", "properties": { "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "root": { "type": "string", "enum": [ "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" ] }, "quality": { "type": "string", "minLength": 1, "maxLength": 32 }, "name": { "type": "string", "minLength": 1 }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "partial_match", "missing_chord_tones", "extra_pitch_classes" ] } } }, "required": [ "startBeat", "lengthBeats", "root", "quality", "name", "confidence", "warnings" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "no_supported_chords" ] } } }, "required": [ "sourceClipId", "startBeat", "endBeat", "chords", "warnings" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "chordTrack.extract", "summary": "Detect and atomically materialise a chord-track progression", "paramStructure": "by-name", "params": [ { "name": "sourceClipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1000000 } }, { "name": "endBeat", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 1000000 } }, { "name": "windowBeats", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 64 } }, { "name": "destinationStartBeat", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1000000 } }, { "name": "populatedPolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "replace", "merge" ], "maxLength": 16384 } }, { "name": "voicing", "required": true, "schema": { "type": "string", "const": "root", "maxLength": 16384 } }, { "name": "octave", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 6 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "detection": { "type": "object", "properties": { "sourceClipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 }, "endBeat": { "type": "number", "exclusiveMinimum": 0 }, "chords": { "type": "array", "maxItems": 256, "items": { "type": "object", "properties": { "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "root": { "type": "string", "enum": [ "C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B" ] }, "quality": { "type": "string", "minLength": 1, "maxLength": 32 }, "name": { "type": "string", "minLength": 1 }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "partial_match", "missing_chord_tones", "extra_pitch_classes" ] } } }, "required": [ "startBeat", "lengthBeats", "root", "quality", "name", "confidence", "warnings" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "no_supported_chords" ] } } }, "required": [ "sourceClipId", "startBeat", "endBeat", "chords", "warnings" ], "additionalProperties": false }, "createdClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chordTrack": { "type": "object", "properties": { "track": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false }, { "type": "null" } ] }, "chords": { "type": "array", "items": { "type": "object", "properties": { "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipBeat": { "type": "number", "minimum": 0 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "name": { "type": "string" } }, "required": [ "clipId", "clipBeat", "startBeat", "lengthBeats", "name" ], "additionalProperties": false } } }, "required": [ "track", "chords" ], "additionalProperties": false } }, "required": [ "detection", "createdClipId", "chordTrack" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chordTrack.sendToTrack", "summary": "Bake an addressed progression to a normal MIDI track", "paramStructure": "by-name", "params": [ { "name": "sourceClipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "targetTrackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1000000 } }, { "name": "occupiedPolicy", "required": true, "schema": { "type": "string", "enum": [ "fail", "replace" ], "maxLength": 16384 } }, { "name": "voicing", "required": true, "schema": { "type": "string", "const": "source", "maxLength": 16384 } }, { "name": "instrumentPolicy", "required": true, "schema": { "type": "string", "enum": [ "preserve_target", "require_existing" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.list", "summary": "List tracks", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "tracks.get", "summary": "Get one track", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "tracks.create", "summary": "Create a track", "paramStructure": "by-name", "params": [ { "name": "name", "required": true, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "type", "required": true, "schema": { "type": "string", "enum": [ "audio", "group", "aux", "chord" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.createFromPreset", "summary": "Create a track from a saved track-chain preset", "paramStructure": "by-name", "params": [ { "name": "presetId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "deviceGraph": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "instrument": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "gainDb": { "type": "number" }, "sidechain": { "type": "object", "properties": { "port": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "portChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "sourceTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "listen": { "type": "boolean" } }, "required": [ "port", "portChannels", "type", "sourceTrackId", "tapPoint", "gainDb", "listen" ], "additionalProperties": false } }, "required": [ "id", "trackId", "rackId", "chainId", "devicePath", "name", "type", "format", "instrument", "bypassed", "gainDb", "sidechain" ], "additionalProperties": false } }, "racks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "chains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "pads": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "required": [ "devices", "racks", "chains", "pads" ], "additionalProperties": false } }, "required": [ "trackId", "deviceGraph" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.applyPreset", "summary": "Apply an opaque chain preset to an existing track", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "presetId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "deviceGraph": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "instrument": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "gainDb": { "type": "number" }, "sidechain": { "type": "object", "properties": { "port": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "portChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "sourceTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "listen": { "type": "boolean" } }, "required": [ "port", "portChannels", "type", "sourceTrackId", "tapPoint", "gainDb", "listen" ], "additionalProperties": false } }, "required": [ "id", "trackId", "rackId", "chainId", "devicePath", "name", "type", "format", "instrument", "bypassed", "gainDb", "sidechain" ], "additionalProperties": false } }, "racks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "chains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "pads": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "required": [ "devices", "racks", "chains", "pads" ], "additionalProperties": false }, "referenceImpact": { "type": "object", "properties": { "preservedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "remappedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "newTarget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "const": "stable_identity_match" } }, "required": [ "referenceKind", "source", "target", "newTarget", "reason" ], "additionalProperties": false } }, "droppedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "rejectedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } } }, "required": [ "preservedReferences", "remappedReferences", "droppedReferences", "rejectedReferences" ], "additionalProperties": false } }, "required": [ "trackId", "deviceGraph", "referenceImpact" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.update", "summary": "Update track mixer, display, or input state", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "volume", "required": false, "schema": { "type": "number", "minimum": 0 } }, { "name": "pan", "required": false, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "muted", "required": false, "schema": { "type": "boolean" } }, { "name": "soloed", "required": false, "schema": { "type": "boolean" } }, { "name": "colourArgb", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, { "name": "recordArmed", "required": false, "schema": { "type": "boolean" } }, { "name": "inputMonitor", "required": false, "schema": { "type": "string", "enum": [ "off", "in", "auto" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "type": { "type": "string", "enum": [ "audio", "group", "aux", "master", "multi_out", "chord", "pad", "separator" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "parentId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "childIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "volume": { "type": "number", "minimum": 0 }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "soloed": { "type": "boolean" }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] }, "frozen": { "type": "boolean" }, "audioInputDevice": { "type": "string" }, "midiInputDevice": { "type": "string" }, "audioOutputDevice": { "type": "string" }, "midiOutputDevice": { "type": "string" } }, "required": [ "id", "type", "name", "colourArgb", "parentId", "childIds", "volume", "pan", "muted", "soloed", "recordArmed", "inputMonitor", "frozen", "audioInputDevice", "midiInputDevice", "audioOutputDevice", "midiOutputDevice" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.delete", "summary": "Delete a track", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.group", "summary": "Group tracks under a new group track", "paramStructure": "by-name", "params": [ { "name": "trackIds", "required": true, "schema": { "type": "array", "minItems": 1, "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "name", "required": true, "schema": { "type": "string", "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "tracks.move", "summary": "Move a track to a one-based position in the track list", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "position", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "routing.endpoints.list", "summary": "List safe audio and MIDI routing endpoints", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "media": { "type": "string", "enum": [ "audio", "midi" ] }, "direction": { "type": "string", "enum": [ "input", "output" ] }, "kind": { "type": "string", "enum": [ "none", "hardware", "track", "master", "all_midi_inputs" ] }, "available": { "type": "boolean" }, "channelCount": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "id", "name", "media", "direction", "kind", "available", "channelCount", "trackId" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "routing.get", "summary": "Get one track's audio and MIDI routing", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "audioInputEndpointId": { "type": "string" }, "midiInputEndpointId": { "type": "string" }, "audioOutputEndpointId": { "type": "string" }, "midiOutputEndpointId": { "type": "string" }, "midiInputChannel": { "type": "integer", "minimum": 0, "maximum": 16 }, "midiOutputChannel": { "type": "integer", "minimum": 0, "maximum": 16 }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] } }, "required": [ "trackId", "audioInputEndpointId", "midiInputEndpointId", "audioOutputEndpointId", "midiOutputEndpointId", "midiInputChannel", "midiOutputChannel", "recordArmed", "inputMonitor" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "routing.set", "summary": "Atomically set track audio and MIDI routes and MIDI channels. Any number of tracks may send their MIDI Out to one track; a channel of 0 is any in, as it is out", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "audioInputEndpointId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "midiInputEndpointId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "audioOutputEndpointId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "midiOutputEndpointId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "midiInputChannel", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 16 } }, { "name": "midiOutputChannel", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 16 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "routing": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "audioInputEndpointId": { "type": "string" }, "midiInputEndpointId": { "type": "string" }, "audioOutputEndpointId": { "type": "string" }, "midiOutputEndpointId": { "type": "string" }, "midiInputChannel": { "type": "integer", "minimum": 0, "maximum": 16 }, "midiOutputChannel": { "type": "integer", "minimum": 0, "maximum": 16 }, "recordArmed": { "type": "boolean" }, "inputMonitor": { "type": "string", "enum": [ "off", "in", "auto" ] } }, "required": [ "trackId", "audioInputEndpointId", "midiInputEndpointId", "audioOutputEndpointId", "midiOutputEndpointId", "midiInputChannel", "midiOutputChannel", "recordArmed", "inputMonitor" ], "additionalProperties": false }, "droppedConnections": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "field": { "type": "string", "enum": [ "audioInputEndpointId", "midiInputEndpointId", "audioOutputEndpointId", "midiOutputEndpointId" ] }, "endpointId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "enum": [ "replaced_by_requested_route" ] } }, "required": [ "trackId", "field", "endpointId", "reason" ], "additionalProperties": false } } }, "required": [ "routing", "droppedConnections" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "sends.list", "summary": "List one track's sends", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sourceTrackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "enabled": { "type": "boolean" }, "position": { "type": "string", "enum": [ "pre_fader", "post_fader" ] } }, "required": [ "id", "sourceTrackId", "destinationEndpointId", "level", "enabled", "position" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "sends.create", "summary": "Create an atomic track send", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "destinationEndpointId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "level", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 1 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "position", "required": false, "schema": { "type": "string", "enum": [ "pre_fader", "post_fader" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "send": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sourceTrackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "enabled": { "type": "boolean" }, "position": { "type": "string", "enum": [ "pre_fader", "post_fader" ] } }, "required": [ "id", "sourceTrackId", "destinationEndpointId", "level", "enabled", "position" ], "additionalProperties": false }, "invalidatedConnections": { "type": "array", "items": { "type": "object", "properties": { "sendId": { "type": "string", "minLength": 1 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "enum": [ "destination_replaced", "send_removed" ] } }, "required": [ "sendId", "destinationEndpointId", "reason" ], "additionalProperties": false } } }, "required": [ "send", "invalidatedConnections" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "sends.update", "summary": "Update an atomic track send", "paramStructure": "by-name", "params": [ { "name": "sendId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "destinationEndpointId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "level", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 1 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "position", "required": false, "schema": { "type": "string", "enum": [ "pre_fader", "post_fader" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "send": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sourceTrackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "level": { "type": "number", "minimum": 0, "maximum": 1 }, "enabled": { "type": "boolean" }, "position": { "type": "string", "enum": [ "pre_fader", "post_fader" ] } }, "required": [ "id", "sourceTrackId", "destinationEndpointId", "level", "enabled", "position" ], "additionalProperties": false }, "invalidatedConnections": { "type": "array", "items": { "type": "object", "properties": { "sendId": { "type": "string", "minLength": 1 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "enum": [ "destination_replaced", "send_removed" ] } }, "required": [ "sendId", "destinationEndpointId", "reason" ], "additionalProperties": false } } }, "required": [ "send", "invalidatedConnections" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "sends.remove", "summary": "Remove an atomic track send", "paramStructure": "by-name", "params": [ { "name": "sendId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "removedSendId": { "type": "string", "minLength": 1 }, "invalidatedConnections": { "type": "array", "items": { "type": "object", "properties": { "sendId": { "type": "string", "minLength": 1 }, "destinationEndpointId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "enum": [ "destination_replaced", "send_removed" ] } }, "required": [ "sendId", "destinationEndpointId", "reason" ], "additionalProperties": false } } }, "required": [ "removedSendId", "invalidatedConnections" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "sidechains.list", "summary": "List device and rack sidechains and their capabilities", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": false, "schema": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "ownerPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "ownerType": { "type": "string", "enum": [ "device", "rack" ] }, "supportedTypes": { "type": "array", "items": { "type": "string", "enum": [ "audio", "midi" ] } }, "audioChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "supportedTapPoints": { "type": "array", "items": { "type": "string", "enum": [ "preFx", "postFader" ] } }, "supportsGain": { "type": "boolean" }, "gainDbMin": { "type": "number" }, "gainDbMax": { "type": "number" }, "supportsListen": { "type": "boolean" }, "supportedChannelMappings": { "type": "array", "items": { "type": "string", "enum": [ "automatic" ] } }, "sourceEndpointId": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "enabled": { "type": "boolean" }, "listen": { "type": "boolean" }, "channelMapping": { "type": "string", "enum": [ "automatic" ] } }, "required": [ "ownerPath", "ownerType", "supportedTypes", "audioChannels", "supportedTapPoints", "supportsGain", "gainDbMin", "gainDbMax", "supportsListen", "supportedChannelMappings", "sourceEndpointId", "type", "tapPoint", "gainDb", "enabled", "listen", "channelMapping" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "sidechains.get", "summary": "Inspect one device or rack sidechain and its capabilities", "paramStructure": "by-name", "params": [ { "name": "ownerPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "ownerPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "ownerType": { "type": "string", "enum": [ "device", "rack" ] }, "supportedTypes": { "type": "array", "items": { "type": "string", "enum": [ "audio", "midi" ] } }, "audioChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "supportedTapPoints": { "type": "array", "items": { "type": "string", "enum": [ "preFx", "postFader" ] } }, "supportsGain": { "type": "boolean" }, "gainDbMin": { "type": "number" }, "gainDbMax": { "type": "number" }, "supportsListen": { "type": "boolean" }, "supportedChannelMappings": { "type": "array", "items": { "type": "string", "enum": [ "automatic" ] } }, "sourceEndpointId": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "enabled": { "type": "boolean" }, "listen": { "type": "boolean" }, "channelMapping": { "type": "string", "enum": [ "automatic" ] } }, "required": [ "ownerPath", "ownerType", "supportedTypes", "audioChannels", "supportedTapPoints", "supportsGain", "gainDbMin", "gainDbMax", "supportsListen", "supportedChannelMappings", "sourceEndpointId", "type", "tapPoint", "gainDb", "enabled", "listen", "channelMapping" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "sidechains.set", "summary": "Atomically configure or clear one device or rack sidechain", "paramStructure": "by-name", "params": [ { "name": "ownerPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "sourceEndpointId", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 16384 }, { "type": "null" } ] } }, { "name": "type", "required": false, "schema": { "type": "string", "enum": [ "audio", "midi" ], "maxLength": 16384 } }, { "name": "tapPoint", "required": false, "schema": { "type": "string", "enum": [ "preFx", "postFader" ], "maxLength": 16384 } }, { "name": "gainDb", "required": false, "schema": { "type": "number", "minimum": -60, "maximum": 24 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "listen", "required": false, "schema": { "type": "boolean" } }, { "name": "channelMapping", "required": false, "schema": { "type": "string", "enum": [ "automatic" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "sidechain": { "type": "object", "properties": { "ownerPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "ownerType": { "type": "string", "enum": [ "device", "rack" ] }, "supportedTypes": { "type": "array", "items": { "type": "string", "enum": [ "audio", "midi" ] } }, "audioChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "supportedTapPoints": { "type": "array", "items": { "type": "string", "enum": [ "preFx", "postFader" ] } }, "supportsGain": { "type": "boolean" }, "gainDbMin": { "type": "number" }, "gainDbMax": { "type": "number" }, "supportsListen": { "type": "boolean" }, "supportedChannelMappings": { "type": "array", "items": { "type": "string", "enum": [ "automatic" ] } }, "sourceEndpointId": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "enabled": { "type": "boolean" }, "listen": { "type": "boolean" }, "channelMapping": { "type": "string", "enum": [ "automatic" ] } }, "required": [ "ownerPath", "ownerType", "supportedTypes", "audioChannels", "supportedTapPoints", "supportsGain", "gainDbMin", "gainDbMax", "supportsListen", "supportedChannelMappings", "sourceEndpointId", "type", "tapPoint", "gainDb", "enabled", "listen", "channelMapping" ], "additionalProperties": false }, "referenceImpact": { "type": "object", "properties": { "preservedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "remappedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "newTarget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "const": "stable_identity_match" } }, "required": [ "referenceKind", "source", "target", "newTarget", "reason" ], "additionalProperties": false } }, "droppedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "rejectedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } } }, "required": [ "preservedReferences", "remappedReferences", "droppedReferences", "rejectedReferences" ], "additionalProperties": false } }, "required": [ "sidechain", "referenceImpact" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.list", "summary": "List clips with optional track and view filters", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "view", "required": false, "schema": { "type": "string", "enum": [ "arrangement", "session" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "clips.get", "summary": "Get one clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "clips.createMidi", "summary": "Create a MIDI clip", "paramStructure": "by-name", "params": [ { "name": "lengthBeats", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0 } }, { "name": "placement", "required": true, "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "view": { "type": "string", "const": "arrangement" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 } }, "required": [ "view", "trackId", "startBeat" ], "additionalProperties": false }, { "type": "object", "properties": { "view": { "type": "string", "const": "session" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "occupiedPolicy": { "type": "string", "enum": [ "fail", "swap", "replace" ] } }, "required": [ "view", "trackId", "sceneId", "occupiedPolicy" ], "additionalProperties": false } ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.loadSample", "summary": "Load an audio file as a clip, as a drop onto a track does", "paramStructure": "by-name", "params": [ { "name": "samplePath", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 } }, { "name": "placement", "required": true, "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "view": { "type": "string", "const": "arrangement" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 } }, "required": [ "view", "trackId", "startBeat" ], "additionalProperties": false }, { "type": "object", "properties": { "view": { "type": "string", "const": "session" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "occupiedPolicy": { "type": "string", "enum": [ "fail", "swap", "replace" ] } }, "required": [ "view", "trackId", "sceneId", "occupiedPolicy" ], "additionalProperties": false } ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.addMidiNote", "summary": "Add a note to a MIDI clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "note", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 127 } }, { "name": "velocity", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 127 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0 } }, { "name": "lengthBeats", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.listMidiEvents", "summary": "List every expressive MIDI event in a clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "clips.addMidiEvents", "summary": "Atomically add MIDI events", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "events", "required": true, "schema": { "type": "array", "maxItems": 4096, "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "note", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "type", "note", "velocity", "beat", "lengthBeats" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "controlChange", "maxLength": 16384 }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "pitchBend", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "channelPressure", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "polyAftertouch", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "note", "value", "beat" ], "additionalProperties": false } ] }, "minItems": 1 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.updateMidiEvents", "summary": "Atomically update MIDI events by id", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "events", "required": true, "schema": { "type": "array", "maxItems": 4096, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange", "maxLength": 16384 }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] }, "minItems": 1 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.replaceMidiEvents", "summary": "Atomically replace every MIDI event in a clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "events", "required": true, "schema": { "type": "array", "maxItems": 4096, "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "note", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "type", "note", "velocity", "beat", "lengthBeats" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "controlChange", "maxLength": 16384 }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "pitchBend", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "channelPressure", "maxLength": 16384 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "polyAftertouch", "maxLength": 16384 }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "type", "note", "value", "beat" ], "additionalProperties": false } ] } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.deleteMidiEvents", "summary": "Atomically delete MIDI events by id", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "eventIds", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 4096, "items": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.delete", "summary": "Delete a clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.move", "summary": "Move a clip to an arrangement position or session slot", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "destination", "required": true, "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "view": { "type": "string", "const": "arrangement" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 } }, "required": [ "view", "trackId", "startBeat" ], "additionalProperties": false }, { "type": "object", "properties": { "view": { "type": "string", "const": "session" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "occupiedPolicy": { "type": "string", "enum": [ "fail", "swap", "replace" ] } }, "required": [ "view", "trackId", "sceneId", "occupiedPolicy" ], "additionalProperties": false } ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.resize", "summary": "Resize a clip from its start or end edge", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "lengthBeats", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0 } }, { "name": "edge", "required": true, "schema": { "type": "string", "enum": [ "start", "end" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.duplicate", "summary": "Duplicate a clip to an arrangement position or session slot", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "destination", "required": true, "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "view": { "type": "string", "const": "arrangement" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "startBeat": { "type": "number", "minimum": 0 } }, "required": [ "view", "trackId", "startBeat" ], "additionalProperties": false }, { "type": "object", "properties": { "view": { "type": "string", "const": "session" }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "occupiedPolicy": { "type": "string", "enum": [ "fail", "swap", "replace" ] } }, "required": [ "view", "trackId", "sceneId", "occupiedPolicy" ], "additionalProperties": false } ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.update", "summary": "Update clip name, enabled state, or groove (played as a time bend)", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "grooveTemplate", "required": false, "schema": { "type": "string", "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.updateAudio", "summary": "Update an audio clip's playback mode, looping, source tempo, stretch, reverse, and fades", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "playback", "required": false, "schema": { "type": "string", "enum": [ "free", "beat" ], "maxLength": 16384 } }, { "name": "looping", "required": false, "schema": { "type": "boolean" } }, { "name": "sourceBpm", "required": false, "schema": { "type": "number", "minimum": 20, "maximum": 999 } }, { "name": "stretch", "required": false, "schema": { "type": "string", "enum": [ "off", "signalsmith", "soundtouch", "soundtouch_hq" ], "maxLength": 16384 } }, { "name": "reversed", "required": false, "schema": { "type": "boolean" } }, { "name": "fadeInSeconds", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 600 } }, { "name": "fadeOutSeconds", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 600 } }, { "name": "fadeInCurve", "required": false, "schema": { "type": "string", "enum": [ "linear", "convex", "concave", "s_curve" ], "maxLength": 16384 } }, { "name": "fadeOutCurve", "required": false, "schema": { "type": "string", "enum": [ "linear", "convex", "concave", "s_curve" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.transpose", "summary": "Transpose every note in a MIDI clip by semitones", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "semitones", "required": true, "schema": { "type": "integer", "minimum": -127, "maximum": 127 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.quantize", "summary": "Quantize a MIDI clip's notes to a beat grid; all notes when noteIndices is absent", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "gridResolution", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "maximum": 16 } }, { "name": "noteIndices", "required": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "mode", "required": false, "schema": { "type": "string", "enum": [ "start", "length", "start_and_length" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "clips.sliceNotes", "summary": "Slice a MIDI clip's notes into equal subdivisions; all notes when noteIndices is absent", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "subdivisions", "required": true, "schema": { "type": "integer", "minimum": 2, "maximum": 64 } }, { "name": "noteIndices", "required": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.list", "summary": "List safe device and rack graph metadata", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "instrument": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "gainDb": { "type": "number" }, "sidechain": { "type": "object", "properties": { "port": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "portChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "sourceTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "listen": { "type": "boolean" } }, "required": [ "port", "portChannels", "type", "sourceTrackId", "tapPoint", "gainDb", "listen" ], "additionalProperties": false } }, "required": [ "id", "trackId", "rackId", "chainId", "devicePath", "name", "type", "format", "instrument", "bypassed", "gainDb", "sidechain" ], "additionalProperties": false } }, "racks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "chains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "pads": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "required": [ "devices", "racks", "chains", "pads" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "pads.list", "summary": "List all 64 slots of a Drum Grid", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "pads.create", "summary": "Create an empty pad chain", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "pads.setDevice", "summary": "Replace a pad voice with a catalogue device", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } }, { "name": "catalogId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "pads.setSample", "summary": "Replace a pad voice with a sampler using a host-local audio file", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } }, { "name": "samplePath", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "pads.clear", "summary": "Clear one pad", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "pads.swap", "summary": "Swap two single-note pads", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padA", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } }, { "name": "padB", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "pads.update", "summary": "Edit pad notes, level, pan, switches, and output bus", "paramStructure": "by-name", "params": [ { "name": "gridPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "padIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 63 } }, { "name": "lowNote", "required": false, "schema": { "type": "integer", "minimum": 24, "maximum": 87 } }, { "name": "highNote", "required": false, "schema": { "type": "integer", "minimum": 24, "maximum": 87 } }, { "name": "rootNote", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 127 } }, { "name": "levelDb", "required": false, "schema": { "type": "number", "minimum": -60, "maximum": 6 } }, { "name": "pan", "required": false, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "muted", "required": false, "schema": { "type": "boolean" } }, { "name": "solo", "required": false, "schema": { "type": "boolean" } }, { "name": "bypassed", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.catalog", "summary": "List devices that can be added, by catalogue id", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "catalogId": { "type": "string" }, "name": { "type": "string" }, "manufacturer": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "instrument": { "type": "boolean" } }, "required": [ "catalogId", "name", "manufacturer", "category", "description", "format", "type", "instrument" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "devicePresets.list", "summary": "List presets for a device by opaque id", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "category": { "type": "string" }, "source": { "type": "string", "enum": [ "magda", "plugin" ] } }, "required": [ "id", "name", "category", "source" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "devices.applyPreset", "summary": "Apply an opaque preset to an existing device", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "presetId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "deviceGraph": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "instrument": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "gainDb": { "type": "number" }, "sidechain": { "type": "object", "properties": { "port": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "portChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "sourceTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "listen": { "type": "boolean" } }, "required": [ "port", "portChannels", "type", "sourceTrackId", "tapPoint", "gainDb", "listen" ], "additionalProperties": false } }, "required": [ "id", "trackId", "rackId", "chainId", "devicePath", "name", "type", "format", "instrument", "bypassed", "gainDb", "sidechain" ], "additionalProperties": false } }, "racks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "chains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "pads": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "required": [ "devices", "racks", "chains", "pads" ], "additionalProperties": false }, "referenceImpact": { "type": "object", "properties": { "preservedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "remappedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "newTarget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "const": "stable_identity_match" } }, "required": [ "referenceKind", "source", "target", "newTarget", "reason" ], "additionalProperties": false } }, "droppedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "rejectedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } } }, "required": [ "preservedReferences", "remappedReferences", "droppedReferences", "rejectedReferences" ], "additionalProperties": false } }, "required": [ "deviceGraph", "referenceImpact" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.replace", "summary": "Atomically replace a device while preserving its chain slot", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "catalogId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "presetId", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "deviceGraph": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "instrument", "effect", "midi", "analysis" ] }, "format": { "type": "string", "enum": [ "vst3", "au", "lv2", "internal" ] }, "instrument": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "gainDb": { "type": "number" }, "sidechain": { "type": "object", "properties": { "port": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "portChannels": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "none", "audio", "midi" ] }, "sourceTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "tapPoint": { "type": "string", "enum": [ "preFx", "postFader" ] }, "gainDb": { "type": "number" }, "listen": { "type": "boolean" } }, "required": [ "port", "portChannels", "type", "sourceTrackId", "tapPoint", "gainDb", "listen" ], "additionalProperties": false } }, "required": [ "id", "trackId", "rackId", "chainId", "devicePath", "name", "type", "format", "instrument", "bypassed", "gainDb", "sidechain" ], "additionalProperties": false } }, "racks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "chains": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "pads": { "type": "array", "items": { "type": "object", "properties": { "gridPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "index": { "type": "integer", "minimum": 0, "maximum": 63 }, "midiNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "populated": { "type": "boolean" }, "chainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "chainPath": { "type": [ "object", "null" ] }, "lowNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "highNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "rootNote": { "type": "integer", "minimum": 0, "maximum": 127 }, "name": { "type": "string" }, "levelDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "channelTrackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "devicePaths": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } }, "required": [ "gridPath", "index", "midiNote", "populated", "chainId", "chainPath", "lowNote", "highNote", "rootNote", "name", "levelDb", "pan", "muted", "solo", "bypassed", "channelTrackId", "devicePaths" ], "additionalProperties": false } } }, "required": [ "devices", "racks", "chains", "pads" ], "additionalProperties": false }, "referenceImpact": { "type": "object", "properties": { "preservedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "remappedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "newTarget": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "const": "stable_identity_match" } }, "required": [ "referenceKind", "source", "target", "newTarget", "reason" ], "additionalProperties": false } }, "droppedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } }, "rejectedReferences": { "type": "array", "items": { "type": "object", "properties": { "referenceKind": { "type": "string", "enum": [ "automation", "macro_link", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "track", "device", "parameter", "automation_lane", "macro", "macro_link", "modulator", "modulator_link", "controller_binding", "sidechain", "routing" ] }, "trackId": { "type": [ "integer", "null" ], "minimum": -2, "maximum": 2147483647 }, "devicePath": { "anyOf": [ { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, { "type": "null" } ] }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "macroId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "modId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "linkIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parameterStableId": { "type": "string" }, "bindingId": { "type": "string" }, "route": { "anyOf": [ { "type": "string", "enum": [ "audio_input", "midi_input", "send", "multi_output", "track_volume", "track_pan", "tempo" ] }, { "type": "null" } ] }, "routeIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, "required": [ "kind", "trackId", "devicePath", "automationLaneId", "macroId", "modId", "linkIndex", "parameterIndex", "parameterStableId", "bindingId", "route", "routeIndex" ], "additionalProperties": false }, "reason": { "type": "string", "enum": [ "policy_preserve", "stable_identity_match", "policy_drop", "policy_reject", "no_proven_remap", "missing_stable_identity", "stable_identity_mismatch" ] } }, "required": [ "referenceKind", "source", "target", "reason" ], "additionalProperties": false } } }, "required": [ "preservedReferences", "remappedReferences", "droppedReferences", "rejectedReferences" ], "additionalProperties": false } }, "required": [ "devicePath", "deviceGraph", "referenceImpact" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.add", "summary": "Add a device from the catalogue to a track's FX chain or a rack chain", "paramStructure": "by-name", "params": [ { "name": "catalogId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parentPath", "required": false, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "index", "required": false, "schema": { "type": "integer", "minimum": -1, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "devicePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, "required": [ "id", "devicePath" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.remove", "summary": "Remove a device", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.setBypassed", "summary": "Set a device's bypass state", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "bypassed", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.setInsert", "summary": "Route an External Insert and set its MIDI CC knobs", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "sendDevice", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "returnDevice", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "midiChannel", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 16 } }, { "name": "ccDevice", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "manualAdjustMs", "required": false, "schema": { "type": "number" } }, { "name": "ccKnobs", "required": false, "schema": { "type": "array", "maxItems": 32, "items": { "type": "integer", "minimum": 0, "maximum": 127 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.move", "summary": "Move a device within its chain", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "toIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.listParameters", "summary": "List a device's parameters, in real units, with customization flags", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "stableId": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "minValue": { "type": "number" }, "maxValue": { "type": "number" }, "defaultValue": { "type": "number" }, "currentValue": { "type": "number" }, "normalizedValue": { "type": "number", "minimum": 0, "maximum": 1 }, "scale": { "type": "string", "enum": [ "linear", "logarithmic", "exponential", "discrete", "boolean", "fader_db" ] }, "choices": { "type": "array", "items": { "type": "string" } }, "visible": { "type": "boolean" }, "miniMixer": { "type": "boolean" }, "aiAgentEnabled": { "type": "boolean" } }, "required": [ "index", "stableId", "name", "unit", "minValue", "maxValue", "defaultValue", "currentValue", "normalizedValue", "scale", "choices", "visible", "miniMixer", "aiAgentEnabled" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "devices.setParameter", "summary": "Set one device parameter, in real units", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "parameterIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "value", "required": true, "schema": { "type": "number" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "stableId": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "minValue": { "type": "number" }, "maxValue": { "type": "number" }, "defaultValue": { "type": "number" }, "currentValue": { "type": "number" }, "normalizedValue": { "type": "number", "minimum": 0, "maximum": 1 }, "scale": { "type": "string", "enum": [ "linear", "logarithmic", "exponential", "discrete", "boolean", "fader_db" ] }, "choices": { "type": "array", "items": { "type": "string" } }, "visible": { "type": "boolean" }, "miniMixer": { "type": "boolean" }, "aiAgentEnabled": { "type": "boolean" } }, "required": [ "index", "stableId", "name", "unit", "minValue", "maxValue", "defaultValue", "currentValue", "normalizedValue", "scale", "choices", "visible", "miniMixer", "aiAgentEnabled" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.setParameterConfig", "summary": "Update a device's saved parameter customization: the visible / mini-mixer / AI-agent selections and the per-plugin AI prompt", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "visibleParameters", "required": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "miniMixerParameters", "required": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "aiAgentParameters", "required": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "aiPrompt", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "parameterOverrides", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "unit": { "type": "string", "maxLength": 16384 }, "scale": { "type": "string", "enum": [ "linear", "logarithmic", "exponential", "discrete", "boolean", "fader_db" ], "maxLength": 16384 }, "minValue": { "type": "number" }, "maxValue": { "type": "number" }, "choices": { "type": "array", "items": { "type": "string", "maxLength": 16384 }, "maxItems": 4096 } }, "required": [ "index" ], "additionalProperties": false }, "maxItems": 4096 } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "stableId": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "minValue": { "type": "number" }, "maxValue": { "type": "number" }, "defaultValue": { "type": "number" }, "currentValue": { "type": "number" }, "normalizedValue": { "type": "number", "minimum": 0, "maximum": 1 }, "scale": { "type": "string", "enum": [ "linear", "logarithmic", "exponential", "discrete", "boolean", "fader_db" ] }, "choices": { "type": "array", "items": { "type": "string" } }, "visible": { "type": "boolean" }, "miniMixer": { "type": "boolean" }, "aiAgentEnabled": { "type": "boolean" } }, "required": [ "index", "stableId", "name", "unit", "minValue", "maxValue", "defaultValue", "currentValue", "normalizedValue", "scale", "choices", "visible", "miniMixer", "aiAgentEnabled" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "devices.openEditor", "summary": "Open a device's plugin editor window", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "mods.list", "summary": "List modulators on a device", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "modId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ] }, "waveform": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ] }, "enabled": { "type": "boolean" }, "rate": { "type": "number" }, "tempoSync": { "type": "boolean" }, "syncDivision": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "oneShot": { "type": "boolean" }, "attackMs": { "type": "number" }, "decayMs": { "type": "number" }, "sustain": { "type": "number" }, "releaseMs": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar", "enabled" ], "additionalProperties": false } } }, "required": [ "modId", "name", "type", "waveform", "enabled", "rate", "tempoSync", "syncDivision", "oneShot", "attackMs", "decayMs", "sustain", "releaseMs", "links" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "mods.create", "summary": "Create a device modulator", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "type", "required": true, "schema": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ], "maxLength": 16384 } }, { "name": "waveform", "required": false, "schema": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ], "maxLength": 16384 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "rate", "required": false, "schema": { "type": "number", "exclusiveMinimum": 0 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "tempoSync", "required": false, "schema": { "type": "boolean" } }, { "name": "syncDivision", "required": false, "schema": { "type": "integer", "enum": [ 1, 2, 3, 4, 6, 8, 12, 16, 24, 32, 33, 48, 66, 132, 200, 264, 400, 528, 800, 1600 ] } }, { "name": "oneShot", "required": false, "schema": { "type": "boolean" } }, { "name": "attackMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } }, { "name": "decayMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } }, { "name": "sustain", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 1 } }, { "name": "releaseMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } }, { "name": "parameterIndex", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "amount", "required": false, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "bipolar", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "modId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ] }, "waveform": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ] }, "enabled": { "type": "boolean" }, "rate": { "type": "number" }, "tempoSync": { "type": "boolean" }, "syncDivision": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "oneShot": { "type": "boolean" }, "attackMs": { "type": "number" }, "decayMs": { "type": "number" }, "sustain": { "type": "number" }, "releaseMs": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar", "enabled" ], "additionalProperties": false } } }, "required": [ "modId", "name", "type", "waveform", "enabled", "rate", "tempoSync", "syncDivision", "oneShot", "attackMs", "decayMs", "sustain", "releaseMs", "links" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "mods.update", "summary": "Update a device modulator", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "modId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "type", "required": false, "schema": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ], "maxLength": 16384 } }, { "name": "waveform", "required": false, "schema": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ], "maxLength": 16384 } }, { "name": "rate", "required": false, "schema": { "type": "number", "exclusiveMinimum": 0 } }, { "name": "enabled", "required": false, "schema": { "type": "boolean" } }, { "name": "tempoSync", "required": false, "schema": { "type": "boolean" } }, { "name": "syncDivision", "required": false, "schema": { "type": "integer", "enum": [ 1, 2, 3, 4, 6, 8, 12, 16, 24, 32, 33, 48, 66, 132, 200, 264, 400, 528, 800, 1600 ] } }, { "name": "oneShot", "required": false, "schema": { "type": "boolean" } }, { "name": "attackMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } }, { "name": "decayMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } }, { "name": "sustain", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 1 } }, { "name": "releaseMs", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 30000 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "modId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ] }, "waveform": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ] }, "enabled": { "type": "boolean" }, "rate": { "type": "number" }, "tempoSync": { "type": "boolean" }, "syncDivision": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "oneShot": { "type": "boolean" }, "attackMs": { "type": "number" }, "decayMs": { "type": "number" }, "sustain": { "type": "number" }, "releaseMs": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar", "enabled" ], "additionalProperties": false } } }, "required": [ "modId", "name", "type", "waveform", "enabled", "rate", "tempoSync", "syncDivision", "oneShot", "attackMs", "decayMs", "sustain", "releaseMs", "links" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "mods.remove", "summary": "Remove a device modulator", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "modId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "mods.link", "summary": "Link a modulator to an AI-enabled device parameter", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "modId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parameterIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "amount", "required": true, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "bipolar", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "modId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "lfo", "envelope", "random", "follower" ] }, "waveform": { "type": "string", "enum": [ "sine", "triangle", "square", "saw", "reverse_saw", "custom" ] }, "enabled": { "type": "boolean" }, "rate": { "type": "number" }, "tempoSync": { "type": "boolean" }, "syncDivision": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "oneShot": { "type": "boolean" }, "attackMs": { "type": "number" }, "decayMs": { "type": "number" }, "sustain": { "type": "number" }, "releaseMs": { "type": "number" }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar", "enabled" ], "additionalProperties": false } } }, "required": [ "modId", "name", "type", "waveform", "enabled", "rate", "tempoSync", "syncDivision", "oneShot", "attackMs", "decayMs", "sustain", "releaseMs", "links" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "mods.unlink", "summary": "Remove a modulator's parameter link", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "modId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parameterIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "macros.list", "summary": "List device macros and their links", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "macroIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar" ], "additionalProperties": false } } }, "required": [ "macroIndex", "name", "value", "links" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "macros.setValue", "summary": "Set a device macro value", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "macroIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "value", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "macroIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar" ], "additionalProperties": false } } }, "required": [ "macroIndex", "name", "value", "links" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "macros.link", "summary": "Link a macro to an AI-enabled device parameter", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "macroIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parameterIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "amount", "required": true, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "bipolar", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "macroIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "links": { "type": "array", "items": { "type": "object", "properties": { "target": { }, "amount": { "type": "number" }, "bipolar": { "type": "boolean" } }, "required": [ "target", "amount", "bipolar" ], "additionalProperties": false } } }, "required": [ "macroIndex", "name", "value", "links" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "macros.unlink", "summary": "Remove a macro's parameter link", "paramStructure": "by-name", "params": [ { "name": "devicePath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "macroIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parameterIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "racks.create", "summary": "Create a rack on a track or inside a rack chain", "paramStructure": "by-name", "params": [ { "name": "name", "required": true, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "parentPath", "required": false, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string", "maxLength": 16384 } }, "required": [ "name" ], "oneOf": [ { "required": [ "trackId" ] }, { "required": [ "parentPath" ] } ], "additionalProperties": false } }, { "name": "racks.remove", "summary": "Remove a rack at any nesting depth", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "rackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "rackPath", "required": false, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, "oneOf": [ { "required": [ "trackId", "rackId" ] }, { "required": [ "rackPath" ] } ], "additionalProperties": false } }, { "name": "racks.setBypassed", "summary": "Set rack bypass", "paramStructure": "by-name", "params": [ { "name": "bypassed", "required": true, "schema": { "type": "boolean" } }, { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "rackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "rackPath", "required": false, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackPath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "bypassed": { "type": "boolean" } }, "required": [ "bypassed" ], "oneOf": [ { "required": [ "trackId", "rackId" ] }, { "required": [ "rackPath" ] } ], "additionalProperties": false } }, { "name": "racks.update", "summary": "Update a rack at any nesting depth", "paramStructure": "by-name", "params": [ { "name": "rackPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "bypassed", "required": false, "schema": { "type": "boolean" } }, { "name": "volumeDb", "required": false, "schema": { "type": "number" } }, { "name": "chainSelector", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 127 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "parentRackId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "parentChainId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "chainSelector": { "type": "number", "minimum": 0, "maximum": 127 }, "chainIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "trackId", "parentRackId", "parentChainId", "nodePath", "name", "bypassed", "volumeDb", "pan", "chainSelector", "chainIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chains.create", "summary": "Create a chain inside a rack at any nesting depth", "paramStructure": "by-name", "params": [ { "name": "rackPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "name", "required": true, "schema": { "type": "string", "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chains.remove", "summary": "Remove a chain from a rack at any nesting depth", "paramStructure": "by-name", "params": [ { "name": "chainPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "chains.update", "summary": "Update a chain at any nesting depth", "paramStructure": "by-name", "params": [ { "name": "chainPath", "required": true, "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "outputIndex", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "muted", "required": false, "schema": { "type": "boolean" } }, { "name": "solo", "required": false, "schema": { "type": "boolean" } }, { "name": "bypassed", "required": false, "schema": { "type": "boolean" } }, { "name": "volumeDb", "required": false, "schema": { "type": "number" } }, { "name": "pan", "required": false, "schema": { "type": "number", "minimum": -1, "maximum": 1 } }, { "name": "zones", "required": false, "schema": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "rackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "nodePath": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false }, "name": { "type": "string" }, "outputIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "muted": { "type": "boolean" }, "solo": { "type": "boolean" }, "bypassed": { "type": "boolean" }, "volumeDb": { "type": "number" }, "pan": { "type": "number", "minimum": -1, "maximum": 1 }, "zones": { "type": "object", "properties": { "keyLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "keyFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityLow": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityHigh": { "type": "integer", "minimum": 1, "maximum": 127 }, "velocityFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocityFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeLow": { "type": "integer", "minimum": 0, "maximum": 127 }, "selectorFadeHigh": { "type": "integer", "minimum": 0, "maximum": 127 }, "roundRobin": { "type": "boolean" } }, "additionalProperties": false, "required": [ "keyLow", "keyHigh", "keyFadeLow", "keyFadeHigh", "velocityLow", "velocityHigh", "velocityFadeLow", "velocityFadeHigh", "selectorLow", "selectorHigh", "selectorFadeLow", "selectorFadeHigh", "roundRobin" ] }, "deviceIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "nestedRackIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "rackId", "nodePath", "name", "outputIndex", "muted", "solo", "bypassed", "volumeDb", "pan", "zones", "deviceIds", "nestedRackIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "selection.get", "summary": "Get the current selection", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "null" }, { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "automationClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "noteClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "noteIndices": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "trackId", "clipId", "clipIds", "automationLaneId", "automationClipId", "noteClipId", "noteIndices" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "selection.set", "summary": "Replace the current track, clip, or note selection", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "anyOf": [ { "type": "null" }, { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } }, { "name": "clipId", "required": true, "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, { "name": "clipIds", "required": true, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } }, { "name": "automationLaneId", "required": true, "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, { "name": "automationClipId", "required": true, "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, { "name": "noteClipId", "required": true, "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 } }, { "name": "noteIndices", "required": true, "schema": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "maxItems": 4096 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "null" }, { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "automationLaneId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "automationClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "noteClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "noteIndices": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "trackId", "clipId", "clipIds", "automationLaneId", "automationClipId", "noteClipId", "noteIndices" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "transport.get", "summary": "Get transport state", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "transport.play", "summary": "Start playback", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false }, { "name": "transport.stop", "summary": "Stop playback", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false }, { "name": "transport.setRecording", "summary": "Set recording state", "paramStructure": "by-name", "params": [ { "name": "recording", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false }, { "name": "transport.setLoopEnabled", "summary": "Set transport loop state", "paramStructure": "by-name", "params": [ { "name": "enabled", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false }, { "name": "transport.seek", "summary": "Seek the transport in beats", "paramStructure": "by-name", "params": [ { "name": "positionBeats", "required": true, "schema": { "type": "number", "minimum": 0 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false }, { "name": "transport.seekRelative", "summary": "Move the transport by beats or bars, clamped at zero", "paramStructure": "by-name", "params": [ { "name": "deltaBeats", "required": false, "schema": { "type": "number" } }, { "name": "deltaBars", "required": false, "schema": { "type": "integer", "minimum": -1000000, "maximum": 1000000 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "playing": { "type": "boolean" }, "recording": { "type": "boolean" }, "loopEnabled": { "type": "boolean" }, "positionBeats": { "type": "number", "minimum": 0 } }, "required": [ "playing", "recording", "loopEnabled", "positionBeats" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "transport", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "deltaBeats": { "type": "number" }, "deltaBars": { "type": "integer", "minimum": -1000000, "maximum": 1000000 } }, "oneOf": [ { "required": [ "deltaBeats" ] }, { "required": [ "deltaBars" ] } ], "additionalProperties": false } }, { "name": "session.get", "summary": "Get scenes, tracks, and every session slot state", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "session.createScene", "summary": "Create a durable session scene", "paramStructure": "by-name", "params": [ { "name": "index", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "colourArgb", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "session.updateScene", "summary": "Atomically update session scene metadata", "paramStructure": "by-name", "params": [ { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "colourArgb", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string", "maxLength": 256 }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "sceneId" ], "anyOf": [ { "required": [ "name" ] }, { "required": [ "colourArgb" ] } ], "additionalProperties": false } }, { "name": "session.moveScene", "summary": "Move a session scene by stable id", "paramStructure": "by-name", "params": [ { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "toIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "session.duplicateScene", "summary": "Duplicate a scene with explicit clip-copy behaviour", "paramStructure": "by-name", "params": [ { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "copyClips", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "session.deleteScene", "summary": "Delete a scene with an explicit populated-slot policy", "paramStructure": "by-name", "params": [ { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "populatedPolicy", "required": true, "schema": { "anyOf": [ { "const": "fail" }, { "const": "deleteClips" }, { "const": "moveClips" } ] } }, { "name": "destinationSceneId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "populatedPolicy": { "const": "fail" } }, "required": [ "sceneId", "populatedPolicy" ], "additionalProperties": false }, { "type": "object", "properties": { "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "populatedPolicy": { "const": "deleteClips" } }, "required": [ "sceneId", "populatedPolicy" ], "additionalProperties": false }, { "type": "object", "properties": { "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "populatedPolicy": { "const": "moveClips" }, "destinationSceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "sceneId", "populatedPolicy", "destinationSceneId" ], "additionalProperties": false } ] } }, { "name": "session.launchClip", "summary": "Launch a session clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.stopClip", "summary": "Stop a session clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.stopTrack", "summary": "Stop the active session clip on a track", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.stopAll", "summary": "Stop all session clips", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.launchScene", "summary": "Launch a session scene", "paramStructure": "by-name", "params": [ { "name": "sceneIndex", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.updateClipSettings", "summary": "Atomically update session clip launch behaviour", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "launchMode", "required": false, "schema": { "type": "string", "enum": [ "trigger", "toggle" ], "maxLength": 16384 } }, { "name": "launchQuantize", "required": false, "schema": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ], "maxLength": 16384 } }, { "name": "followAction", "required": false, "schema": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ], "maxLength": 16384 } }, { "name": "followActionDelayBeats", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 1000000 } }, { "name": "followActionLoopCount", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "audio", "midi" ] }, "view": { "type": "string", "enum": [ "arrangement", "session" ] }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0 }, "enabled": { "type": "boolean" }, "sceneIndex": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "notes": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 0, "maximum": 127 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "note", "velocity", "startBeat", "lengthBeats" ], "additionalProperties": false } }, "midiEvents": { "type": "array", "maxItems": 100000, "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "note" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "velocity": { "type": "integer", "minimum": 1, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "exclusiveMinimum": 0 }, "keyswitch": { "type": "boolean" } }, "required": [ "id", "type", "note", "velocity", "beat", "lengthBeats", "keyswitch" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "controlChange" }, "controller": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "controller", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "pitchBend" }, "value": { "type": "integer", "minimum": 0, "maximum": 16383 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "channelPressure" }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "value", "beat" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "type": { "type": "string", "const": "polyAftertouch" }, "note": { "type": "integer", "minimum": 0, "maximum": 127 }, "value": { "type": "integer", "minimum": 0, "maximum": 127 }, "beat": { "type": "number", "minimum": 0 } }, "required": [ "id", "type", "note", "value", "beat" ], "additionalProperties": false } ] } }, "audio": { "type": [ "object", "null" ], "properties": { "playback": { "type": "string", "enum": [ "free", "beat" ] }, "looping": { "type": "boolean" }, "tempo": { "type": "number", "minimum": 0 }, "tempoFrom": { "type": "string", "enum": [ "none", "fileMetadata", "analysis", "user", "project" ] }, "speedRatio": { "type": "number", "minimum": 0 } }, "required": [ "playback", "looping", "tempo", "tempoFrom", "speedRatio" ], "additionalProperties": false } }, "required": [ "id", "trackId", "type", "view", "name", "colourArgb", "startBeat", "lengthBeats", "enabled", "sceneIndex", "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount", "notes", "midiEvents", "audio" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false, "x-params-schema": { "type": "object", "properties": { "clipId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ], "maxLength": 16384 }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ], "maxLength": 16384 }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ], "maxLength": 16384 }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "clipId" ], "anyOf": [ { "required": [ "launchMode" ] }, { "required": [ "launchQuantize" ] }, { "required": [ "followAction" ] }, { "required": [ "followActionDelayBeats" ] }, { "required": [ "followActionLoopCount" ] } ], "additionalProperties": false } }, { "name": "session.returnToArrangement", "summary": "Return one or every track to arrangement playback", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.recordingCapabilities", "summary": "Inspect Session recording support and stop policy", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "slotRecording": { "type": "boolean" }, "performanceCapture": { "type": "boolean" }, "slotCancellation": { "type": "boolean" }, "performanceCaptureCancellation": { "type": "boolean" }, "slotStopStopsTransport": { "type": "boolean" }, "occupiedSlotPolicies": { "type": "array", "items": { "type": "string", "enum": [ "fail" ] } } }, "required": [ "slotRecording", "performanceCapture", "slotCancellation", "performanceCaptureCancellation", "slotStopStopsTransport", "occupiedSlotPolicies" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "session.armSlotRecording", "summary": "Arm or unarm an empty addressed Session slot", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "armed", "required": true, "schema": { "type": "boolean" } }, { "name": "occupiedPolicy", "required": true, "schema": { "const": "fail" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "scenes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "displayIndex": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "sceneIndex", "displayIndex", "name", "colourArgb" ], "additionalProperties": false } }, "tracks": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "activeClipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "playbackMode": { "type": "string", "enum": [ "arrangement", "session" ] } }, "required": [ "trackId", "activeClipId", "playbackMode" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "sceneIndex": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "clipId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "enum": [ "empty", "stopped", "queued", "playing" ] }, "recordArmed": { "type": "boolean" }, "recording": { "type": "boolean" }, "launchSettings": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "launchMode": { "type": "string", "enum": [ "trigger", "toggle" ] }, "launchQuantize": { "type": "string", "enum": [ "none", "8_bars", "4_bars", "2_bars", "1_bar", "1/2", "1/4", "1/8", "1/16" ] }, "followAction": { "type": "string", "enum": [ "none", "next", "previous", "random", "stop", "again" ] }, "followActionDelayBeats": { "type": "number", "minimum": 0, "maximum": 1000000 }, "followActionLoopCount": { "type": "integer", "minimum": 1, "maximum": 100000 } }, "required": [ "launchMode", "launchQuantize", "followAction", "followActionDelayBeats", "followActionLoopCount" ], "additionalProperties": false } ] } }, "required": [ "trackId", "sceneId", "sceneIndex", "clipId", "state", "recordArmed", "recording", "launchSettings" ], "additionalProperties": false } } }, "required": [ "scenes", "tracks", "slots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.beginSlotRecording", "summary": "Begin a queued slot take as an asynchronous job", "paramStructure": "by-name", "params": [ { "name": "trackId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "sceneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "occupiedPolicy", "required": true, "schema": { "const": "fail" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.stopSlotRecording", "summary": "Stop a slot take and complete its recording job", "paramStructure": "by-name", "params": [ { "name": "jobId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.beginPerformanceCapture", "summary": "Capture launched Session performance into Arrangement as an asynchronous job", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "session.stopPerformanceCapture", "summary": "Stop and commit a Session performance capture", "paramStructure": "by-name", "params": [ { "name": "jobId", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "accepted", "running", "completed", "cancelled", "failed", "unsupported" ] }, "progress": { "type": "number", "minimum": 0, "maximum": 1 }, "cancellable": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "projectBound": { "type": "boolean" }, "revisionPolicy": { "type": "string", "enum": [ "stable_until_completion", "check_at_start_only" ] }, "acceptedRevision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "completionRevision": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "createdAtMs": { "type": "number", "minimum": 0 }, "startedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "finishedAtMs": { "type": [ "number", "null" ], "minimum": 0 }, "result": { "type": [ "object", "null" ] }, "error": { "type": [ "object", "null" ] }, "artifacts": { "type": "array", "maxItems": 64, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "minLength": 1 }, "mediaType": { "type": "string" } }, "required": [ "id", "kind", "mediaType" ], "additionalProperties": false } } }, "required": [ "id", "kind", "state", "progress", "cancellable", "cancelRequested", "projectBound", "revisionPolicy", "acceptedRevision", "completionRevision", "createdAtMs", "startedAtMs", "finishedAtMs", "result", "error", "artifacts" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "session", "x-transport-scoped": false }, { "name": "automation.listLanes", "summary": "List every automation lane in the project", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "absolute", "clip_based" ] }, "name": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "type", "name", "target", "points", "clipIds" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "automation.getLane", "summary": "Get an automation lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "absolute", "clip_based" ] }, "name": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "type", "name", "target", "points", "clipIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "automation.createLane", "summary": "Create an automation lane", "paramStructure": "by-name", "params": [ { "name": "target", "required": true, "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false } }, { "name": "type", "required": true, "schema": { "type": "string", "enum": [ "absolute", "clip_based" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "id" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.addPoint", "summary": "Add a point to an automation lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "beatPosition", "required": true, "schema": { "type": "number", "minimum": 0 } }, { "name": "value", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1 } }, { "name": "curve", "required": true, "schema": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "absolute", "clip_based" ] }, "name": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "type", "name", "target", "points", "clipIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.setPoints", "summary": "Replace every point on an absolute automation lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "points", "required": true, "schema": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "beatPosition", "value", "curve" ], "additionalProperties": false } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "absolute", "clip_based" ] }, "name": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "type", "name", "target", "points", "clipIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.clearLane", "summary": "Remove all points from an automation lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "enum": [ "absolute", "clip_based" ] }, "name": { "type": "string" }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plugin_param", "device_macro", "mod_param", "track_volume", "track_pan", "send_level", "tempo" ] }, "devicePath": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "trackId": { "anyOf": [ { "type": "integer", "const": -2 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] }, "section": { "type": "string", "enum": [ "fx", "post_fx", "mixer_analysis" ] }, "trackLevel": { "type": "boolean" }, "topLevelDeviceId": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 2147483647 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "rack", "chain", "device", "pad_rack", "pad_chain" ] }, "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "type", "id" ], "additionalProperties": false } } }, "required": [ "trackId", "section", "trackLevel", "topLevelDeviceId", "steps" ], "additionalProperties": false } ] }, "parameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modId": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "modParameterIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 }, "sendBusIndex": { "type": "integer", "minimum": -1, "maximum": 2147483647 } }, "required": [ "kind", "devicePath", "parameterIndex", "modId", "modParameterIndex", "sendBusIndex" ], "additionalProperties": false }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } }, "clipIds": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } }, "required": [ "id", "type", "name", "target", "points", "clipIds" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.deleteLane", "summary": "Delete an automation lane and its clips", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.listClips", "summary": "List automation clips, optionally filtered by lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "automation.getClip", "summary": "Get an automation clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "automation.createClip", "summary": "Create a clip on a clip-based automation lane", "paramStructure": "by-name", "params": [ { "name": "laneId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0 } }, { "name": "lengthBeats", "required": true, "schema": { "type": "number", "minimum": 0.1 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.deleteClip", "summary": "Delete an automation clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.moveClip", "summary": "Move an automation clip", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "startBeat", "required": true, "schema": { "type": "number", "minimum": 0 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.resizeClip", "summary": "Resize an automation clip from either edge", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "lengthBeats", "required": true, "schema": { "type": "number", "minimum": 0.1 } }, { "name": "edge", "required": true, "schema": { "type": "string", "enum": [ "start", "end" ], "maxLength": 16384 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.duplicateClip", "summary": "Duplicate an automation clip after its source", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "automation.updateClip", "summary": "Update automation clip metadata, looping, or points", "paramStructure": "by-name", "params": [ { "name": "clipId", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "name", "required": false, "schema": { "type": "string", "maxLength": 16384 } }, { "name": "colourArgb", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, { "name": "looping", "required": false, "schema": { "type": "boolean" } }, { "name": "loopLengthBeats", "required": false, "schema": { "type": "number", "minimum": 0.1 } }, { "name": "points", "required": false, "schema": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "beatPosition", "value", "curve" ], "additionalProperties": false } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "laneId": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string" }, "colourArgb": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "startBeat": { "type": "number", "minimum": 0 }, "lengthBeats": { "type": "number", "minimum": 0.1 }, "looping": { "type": "boolean" }, "loopLengthBeats": { "type": "number", "minimum": 0.1 }, "points": { "type": "array", "maxItems": 100000, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "beatPosition": { "type": "number", "minimum": 0 }, "value": { "type": "number", "minimum": 0, "maximum": 1 }, "curve": { "type": "string", "enum": [ "linear", "bezier", "step", "hard_corner" ] } }, "required": [ "id", "beatPosition", "value", "curve" ], "additionalProperties": false } } }, "required": [ "id", "laneId", "name", "colourArgb", "startBeat", "lengthBeats", "looping", "loopLengthBeats", "points" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "grooves.list", "summary": "List groove template names", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "string" } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "grooves.upsert", "summary": "Create or replace a groove template; latenessProportions is one entry per grid slot, -1..1 of the slot length", "paramStructure": "by-name", "params": [ { "name": "name", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "notesPerBeat", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 16 } }, { "name": "latenessProportions", "required": true, "schema": { "type": "array", "minItems": 1, "items": { "type": "number", "minimum": -1, "maximum": 1 }, "maxItems": 4096 } }, { "name": "parameterized", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "focused.get", "summary": "Get the focused device or rack and its macro page", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "hasFocus": { "type": "boolean" }, "name": { "type": "string" }, "macros": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number" } }, "required": [ "index", "name", "value" ], "additionalProperties": false } } }, "required": [ "hasFocus", "name", "macros" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "focused.setMacro", "summary": "Write a normalized value to a macro on the focused device", "paramStructure": "by-name", "params": [ { "name": "index", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 15 } }, { "name": "value", "required": true, "schema": { "type": "number", "minimum": 0, "maximum": 1 } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "hasFocus": { "type": "boolean" }, "name": { "type": "string" }, "macros": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number" } }, "required": [ "index", "name", "value" ], "additionalProperties": false } } }, "required": [ "hasFocus", "name", "macros" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "focused.cycleDevice", "summary": "Move device focus to the previous or next top-level chain node", "paramStructure": "by-name", "params": [ { "name": "direction", "required": true, "schema": { "type": "integer", "enum": [ -1, 1 ] } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "hasFocus": { "type": "boolean" }, "name": { "type": "string" }, "macros": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "name": { "type": "string" }, "value": { "type": "number" } }, "required": [ "index", "name", "value" ], "additionalProperties": false } } }, "required": [ "hasFocus", "name", "macros" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "edit", "x-transport-scoped": false }, { "name": "midi.listOutputPorts", "summary": "List available MIDI output port names", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "array", "items": { "type": "string" } } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": false }, { "name": "midi.send", "summary": "Send one channel message to a MIDI output, as status-first raw bytes", "paramStructure": "by-name", "params": [ { "name": "port", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "bytes", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 3, "items": { "type": "integer", "minimum": 0, "maximum": 255 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "hardware-midi", "x-transport-scoped": false }, { "name": "midi.sendSysEx", "summary": "Send a SysEx payload to a MIDI output; F0/F7 framing is added", "paramStructure": "by-name", "params": [ { "name": "port", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 16384 } }, { "name": "bytes", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 4096, "items": { "type": "integer", "minimum": 0, "maximum": 127 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "write", "x-required-scope": "hardware-midi", "x-transport-scoped": false }, { "name": "subscriptions.subscribe", "summary": "Start receiving change events for the given topics, with an initial snapshot", "paramStructure": "by-name", "params": [ { "name": "topics", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 11, "items": { "type": "string", "enum": [ "project", "tracks", "clips", "devices", "selection", "transport", "session", "automation", "jobs", "meters", "playhead" ], "maxLength": 16384 } } }, { "name": "snapshot", "required": false, "schema": { "type": "boolean" } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "snapshots": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "type": { "type": "string", "enum": [ "snapshot", "delta", "sample" ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "payload": { } }, "required": [ "topic", "type", "revision", "payload" ], "additionalProperties": false } } }, "required": [ "topics", "revision", "snapshots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": true }, { "name": "subscriptions.unsubscribe", "summary": "Stop receiving change events; no topics means every topic", "paramStructure": "by-name", "params": [ { "name": "topics", "required": false, "schema": { "type": "array", "minItems": 1, "maxItems": 11, "items": { "type": "string", "enum": [ "project", "tracks", "clips", "devices", "selection", "transport", "session", "automation", "jobs", "meters", "playhead" ], "maxLength": 16384 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "topics", "revision" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": true }, { "name": "subscriptions.list", "summary": "List the topics this connection is subscribed to", "paramStructure": "by-name", "params": [], "result": { "name": "result", "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "topics", "revision" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": true }, { "name": "subscriptions.resync", "summary": "Re-send a complete snapshot for the subscribed topics", "paramStructure": "by-name", "params": [ { "name": "topics", "required": false, "schema": { "type": "array", "minItems": 1, "maxItems": 11, "items": { "type": "string", "enum": [ "project", "tracks", "clips", "devices", "selection", "transport", "session", "automation", "jobs", "meters", "playhead" ], "maxLength": 16384 } } } ], "result": { "name": "result", "schema": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "snapshots": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "type": { "type": "string", "enum": [ "snapshot", "delta", "sample" ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "payload": { } }, "required": [ "topic", "type", "revision", "payload" ], "additionalProperties": false } } }, "required": [ "topics", "revision", "snapshots" ], "additionalProperties": false } }, "errors": [ { "$ref": "#/components/errors/validation_failed" }, { "$ref": "#/components/errors/internal_error" }, { "$ref": "#/components/errors/not_found" }, { "$ref": "#/components/errors/conflict" }, { "$ref": "#/components/errors/timeout" }, { "$ref": "#/components/errors/cancelled" }, { "$ref": "#/components/errors/too_many_requests" }, { "$ref": "#/components/errors/permission_denied" } ], "x-access": "read", "x-required-scope": "read", "x-transport-scoped": true } ], "components": { "errors": { "parse_error": { "code": -32700, "message": "Malformed JSON." }, "invalid_request": { "code": -32600, "message": "Invalid JSON-RPC framing or unsupported route.", "data": { "code": "invalid_request" } }, "unknown_operation": { "code": -32601, "message": "Unknown method.", "data": { "code": "unknown_operation" } }, "validation_failed": { "code": -32602, "message": "params did not satisfy the method's input schema.", "data": { "code": "validation_failed" } }, "internal_error": { "code": -32603, "message": "Unexpected server failure.", "data": { "code": "internal_error" } }, "not_found": { "code": -32001, "message": "A referenced project entity does not exist.", "data": { "code": "not_found" } }, "conflict": { "code": -32002, "message": "State or revision conflicts with the request.", "data": { "code": "conflict" } }, "timeout": { "code": -32003, "message": "The request missed its deadline.", "data": { "code": "timeout" } }, "cancelled": { "code": -32004, "message": "Work was cancelled.", "data": { "code": "cancelled" } }, "too_many_requests": { "code": -32005, "message": "Connection request rate or in-flight limit exceeded." }, "permission_denied": { "code": -32006, "message": "The client's grant does not include the method's scope.", "data": { "code": "permission_denied" } } } } }