Cloud Electronics VTX-WM1 - Manual (Page 17)

VTX-WM1 Installation Guide v1.2 17
Appendix B
API Overview
The VTX-WM1 may be used in conjunction with third party equipment to monitor the status of
the amplifier and each of it’s channels. Information can be retrieved from the monitor card and
interpreted at the third-party control equipment. To achieve this, the control equipment must be
capable of sending HTTP POST requests with URL encoded fields in the body and receiving and
interpreting XML responses from the server.
The VTX-WM1 is a monitoring solution only, it is not possible to control or manipulate audio
signals using this module. Data provided by the module is representative of the amplifier state, but
is not real-time; this module cannot be used for live-sound monitoring applications. The module
can serve to one client device at a given time.
This documentation is provided as an overview, not the complete API specification. Check our
website
www.cloud.co.uk or contact us for more complete specification of this API.
Interaction basics
Example POST request body
obj-type=unit&unit-id=0&req=update&doc-format=xml
All enquiries are made to the same target destination: /hwtest.htm
Requests are URL-encoded, HTTP Posts.
The VTX-WM1 responds based on two main fields in the request body:
1. req
This specifies the type of request to be made; update fetches up-to-date information from the
VTX-WM1, commit pushes new values to the VTX-WM1.
2. obj-type
This specifies the data type for the request (site, unit or channel)
Where unit or channel sensitive information is being requested, the unit-id field must be specified.
For channels, the chnum field may be used to specify a specific channel [1-4], otherwise a list of all
channels on the unit is returned.