Sound Control Protocol for ew D1

SSC Developer‘s guide for evolution wireless D1 | 15/56
General SSC Address Schema
TX: { "out1": { "xlr1": { "mute": true },
"xlr23": { "gain": 3 }},
"out2": { "xlr1": { "gain": 42 }}}
RX: { "osc": { "error": [ {
"out1": { "xlr23": [ 404, { "desc": "not found" }]},
"out2": { "xlr1": [ 307, { "desc": "not just now" }]}
}]},
"out1": { "xlr1": { "mute": true }}}
If the request message violates the JSON syntax, the complete message cannot reliably be parsed
and MUST NOT be partially parsed or executed, so that the SSC Server MUST send an error response
(400, "not understood") relating to the complete message, not to any method address. This error
result message would look like this:
TX: { "out1": { "xlr23": { "ga schnr blabl
RX: { "osc": { "error": [ [ 400, { "desc": "not understood" }] ]}}
Error method results for successful method executions MUST NOT be sent without being explicitly
requested by the client, by querying "/osc/error". Example:
TX: { "out1": { "xlr1": { "gain": 17 }},
"osc": { "error": null }}
RX: { "osc": { "error": [
{ "out1": { "xlr1": { "gain":
[ 202, { "desc": "adapted" }] }}} ] },
"out1": { "xlr1": { "gain": 15 }}
}
The error code is a three digit integer, defined in the style of SMTP, FTP or HTTP error codes.
The first digit of the error code defines the class of response. The last two digits do not have any
categorization role.
There are 5 values for the first digit:
• 1xx - Informational response - Request received, continuing process.
• 2xx - Success - The action was successfully received, understood, and accepted.
• 3xx - Incomplete - Further action must be taken in order to complete the request.
• 4xx - Client Error - The request contained bad syntax or cannot be fulfilled.
• 5xx - Server Error - The server failed to fulfill an apparently valid request.
A simple SSC Client would only have to look at the first digit of the error code in order to determine
what how to deal with the Method Reply.
1xx – Informational response
interim status for time-consuming methods.
100 continue
102 processing
2xx – Success
200 OK
201 Created
202 Adapted
210 Partial Success
3xx – Incomplete
310 subscription terminates
4xx – Client Error
400 message not understood
401 authorisation needed