QML protocols
Custom QML transports let a script communicate with an API that cannot be represented by a standard device. The complete runtime reference now lives under Reference → Languages:
-
QML transport API:
Protocolsfactories, socket callbacks, framing, encoding, HTTP, OAuth, OSC and MIDI. -
QML device API: root types, parameter trees,
Deviceoperations and device-specific callbacks.
Use a Mapper device for custom sockets and persistent mappings. Use the HTTP, WebSocket or Serial device when its tree-oriented API matches your hardware or service. These roots have their own callback contracts; do not copy raw socket callbacks into them.
Transport selection
Start with the transport factory table, then the socket lifecycle and worked examples. Backend availability depends on the platform and build.
Framing and encoding are different
TCP and serial need explicit message-boundary handling. Use the framing and encoding reference to match the other endpoint. The Serial device root has its own framing names.
HTTP requests
For arbitrary methods, headers, JSON bodies and response status codes, see Protocols.http. For parameter-driven requests with local tree updates, see the separate HTTP device API.
OAuth
The OAuth reference documents the build requirements, authorization-code flow, callback shape and trusted-response caveat. Register your own service application and keep tokens out of shared scores.
OSC and MIDI payloads
See OSC packet parsing and MIDI / UMP enumeration and ports. An OSC parser does not open a socket; a MIDI port must exist before it can be opened.
Troubleshooting and scope
Validate QML first, then diagnose addresses, permissions, framing and encoding independently using the transport troubleshooting guide. Begin with loopback and avoid exposing listeners to untrusted networks. For an operator’s browser controlling score rather than a client/device integration, see Remote Control.