# Documentation

The API reference for `mx_remote`. Start at the [project README](https://github.com/opdenkamp/mx-remote#readme) for installation and a quick start.

| Page | Covers |
| --- | --- |
| [Configuration](configuration.md) | Opening a connection and keeping it in step with the mesh. |
| [Devices and bays](devices-and-bays.md) | Naming, hiding, EDID and the device registry. |
| [Routing](routing.md) | Selecting video and audio sources for an output. |
| [Callbacks](callbacks.md) | Reacting to state changes rather than polling for them. |
| [Audio](audio.md) | Volume, mute and remote-control passthrough. |
| [OneIP and V2IP](oneip.md) | Streaming endpoints, stream sources and statistics. |
| [Multiviewer](multiviewer.md) | Layout, sources and output configuration. |
| [Diagnostics](diagnostics.md) | Network status, the mxr console app and capture replay. |