changeset 38:4965e7a462b4

Configuration response, & some doc notes
author Chris Cannam
date Thu, 17 Mar 2016 11:01:43 +0000
parents 0f7b1f4c52ad
children 22c33bd017ba
files examples/configurationresponse.json schema/configurationresponse.json schema/loadresponse.json
diffstat 3 files changed, 17 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/examples/configurationresponse.json	Thu Mar 17 11:01:43 2016 +0000
@@ -0,0 +1,1 @@
+{"outputList": [{"basic": {"description": "Percussive note onset locations", "identifier": "onsets", "name": "Onsets"}, "binCount": 0, "binNames": [], "hasDuration": false, "sampleRate": 44100, "sampleType": "VariableSampleRate", "unit": ""}, {"basic": {"description": "Broadband energy rise detection function", "identifier": "detectionfunction", "name": "Detection Function"}, "binCount": 1, "binNames": [""], "hasDuration": false, "quantizeStep": 1, "sampleRate": 44100, "sampleType": "OneSamplePerStep", "unit": ""}]}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/schema/configurationresponse.json	Thu Mar 17 11:01:43 2016 +0000
@@ -0,0 +1,15 @@
+{
+    "id": "http://vamp-plugins.org/json/schema/configurationresponse#",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "schema for a serialised response to a request to configure a Vamp plugin; normally served as the response field of an object matching the plain response schema",
+    "type": "object",
+    "properties": {
+	"outputList": {
+	    "type": "array",
+	    "items": { "$ref": "http://vamp-plugins.org/json/schema/outputdescriptor#" }
+	}
+    },
+    "required": [ "outputList" ],
+    "additionalProperties": false
+}
+
--- a/schema/loadresponse.json	Wed Mar 16 16:58:25 2016 +0000
+++ b/schema/loadresponse.json	Thu Mar 17 11:01:43 2016 +0000
@@ -1,7 +1,7 @@
 {
     "id": "http://vamp-plugins.org/json/schema/loadresponse#",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "schema for a serialised response to a load request for a Vamp Plugin",
+    "description": "schema for a serialised response to a load request for a Vamp Plugin; normally served as the response field of an object matching the plain response schema",
     "type": "object",
     "properties": {
 	"pluginHandle": {