Operation Panel Server Specification

In this document, information necessary to create custom operation panel page is explained.

Document Encoding
Use UTF-8.
<meta http-equiv="Content-type" content="text/html; charset=utf-8">

Special Path
Normally, path is specified with [ Server Folder ] as root.
There are exceptions for special purpose.
/.osceq Returns alterable parameters and their current value.
It is a set of pairs of [ OSC address ] and [ current value ].
A format is same as HTML form [ application/x-www-form-urlencoded ] used when submit a set of pairs of [ Control Name ] and [ Value ].
That is, concatenation of pairs of
by [ & ].
It can be parsed with JavaScript like this:
var	pairs = responseText.split('&');

for (var i = 0; i < pairs.length; ++i)
	var	pair = pairs[i].split('=');
	var	name = decodeURIComponent(pair[0]);
	var	value = decodeURIComponent(pair[1]);

/.upload Returns file list of the [ Upload Folder ].
It is a set of pairs of [ File Name ] and [ relative URL from SynVisum Setting File ].
[ relative URL from SynVisum Setting File ] is used as a value for image input parameters.
It can be parsed in same way described above.
/.monitor Returns still image of SynVisum video output.
(a this time, PNG format)
Although the server indicates in HTTP response header it should not be cached, workaround may be necessary, for example, requesting [ /.monitor?0 ] and [ /.monitor?1 ] alternately.

POST action
/.Osceq Alters parameters.
Same as [ /.osceq ] explained above.
Number of pairs is arbitrary.

When a file is uploaded, [ multipart/form-data ] format is used.
In this case, [ control value ] is file content, and the server sets [ relative URL from SynVisum setting file ] to image input parameter.

To trigger a scene, use a control name (OSC address) of [ /scene ] and a value of [ scene number (integer greater than or equal to 0 ].
  • Control name of [ cmd ] and value of [ delupload ]
    Deletes all files in the [ Upload Folder ].