Skip to main content

Module wire

Module wire 

Expand description

The protocol between the library’s render::plugin::PluginRenderer and the plug-in host process, sound-to-patch-host.

The renderer writes one Request per line to the host’s standard input. The host answers each with one Reply line on standard output, after REPLY_PREFIX. A plug-in may print to standard output too, so a line without the prefix is plug-in output and is never parsed. Binary state travels as base64; audio travels as a WAV file at a path the renderer names.

Structs§

WireControl
A controller change at a time of the clip.
WireNote
A note on the wire. The host checks it as super::RenderNote::new does.

Enums§

Reply
A reply from the host.
Request
A request to the host.
WireControlKind
A controller change on the wire.

Constants§

PROTOCOL_VERSION
The version of this protocol. The renderer refuses a host with another version, such as the host of another release.
REPLY_PREFIX
The start of every reply line.

Functions§

parse_reply
Reads a reply line. Returns None for a line without the prefix, which is plug-in output.
reply_line
Writes a reply as one line, prefix included.