From: Alexandre Prokoudine Date: Tue, 13 Sep 2022 23:01:43 +0000 (+0300) Subject: Add initial documentation for the WebSockets Server X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?p=ardour-manual;a=commitdiff_plain;h=e045fa2549231d3cf02d558500f879269add8c62 Add initial documentation for the WebSockets Server --- diff --git a/include/control-surfaces-websockets-server.html b/include/control-surfaces-websockets-server.html new file mode 100644 index 0000000..df76b4c --- /dev/null +++ b/include/control-surfaces-websockets-server.html @@ -0,0 +1,182 @@ +

+ The WebSockets Server is an experimental control surface that allows + controlling a running Ardour session via a web browser on any computer + in the same local network. +

+ +

+ The connection between the WebSockets server and a running instance of Ardour + is two-way: any changes made in the web-based surface are immediately + available in Ardour, and vice versa. +

+ +

+ The experimental status means that this control surface is not + feature-complete and might have bugs. +

+ +

+ Supported features are currently limited to: +

+ + + +

Enabling and Accessing the WebSockets Server

+ +

+ To enable the WebSockets Server surface, open the Preferences dialog + and go to the Control Surfaces page. Click on the Web Sockets + Server (Experimental) to enable it. This will immediately run the server + and make it available on port 3818. You can verify that it's running by + opening a web browser on the same computer and visiting + http://localhost:3818/. You should see + the home page that looks like this: +

+ +
+ WebSockets Server main page +
+ WebSockets Server main page +
+
+ +

+ To access the server from any device in the same network you need to know the + broadcast IP address of the computer running Ardour. Here is how to do that + on supported operating systems. +

+ +

+ Windows 10: +

+ +
    +
  1. Open the Settings application.
    2. +
  2. Go to the Network & internet from the menu on the left, then click Properties along the top.
    3. +
  3. Select the type of network connection (WiFi or Ethernet)
    4. +
  4. Click Network in the center.
    5. +
  5. In the newly opened page, the local IPv4 address be displayed.
    6. +
+ +

…or…

+ +
    +
  1. Open the Start menu and type cmd. This will to open the + command prompt.
    2. +
  2. Type ipconfig and press Enter.
    3. +
  3. In the output, look for IPv4 address.
    4. +
+ +

+ macOS: +

+ +
    +
  1. Open the System Preferences dialog.
    2. +
  2. Select Network, then choose connection type (typically WiFi, + Ethernet, or USB).
    3. +
  3. The IP address will be displayed on the newly opened page under the + connection status.
    4. +
+ +

+ Linux: +

+ +
    +
  1. Open a terminal program.
    2. +
  2. Run this command: $ ip -4 address.
    3. +
  3. The output will list several network devices. You want the one that has + "BROADCAST" rather than "LOOPBACK" in the description.
    4. +
+ +

+ Once you know the address, you can open the control surface web app + in a browser by visiting the IP address with appended port number. + E.g. if the IP address of the computer running Ardour is 192.168.1.68, + the entire URL will be http://192.168.1.68:3818/. +

+ +

Using the WebSockets Server control surface

+ +

+ Various features available in the control surface are spread across three + pages: Mixer, Transport, and Protocol.

+ +

Mixer

+ +

+ This is where you can view VU meters for each track and the master bus, as + well as make a number of adjustments: +

+ + + +
+ Mixer view in WebSockets Server +
+ Mixer view in WebSockets Server +
+
+ +

+ The control surface only supports changing settings for LV2 plugins presently. + LADSPA, VST2/VST3, and AU plugins will not be listed. When an LV2 plugin has + been loaded into a mixer channel, a button with "f" caption appears on top of + the mixer channel. Clicking it opens this kind of an overlay: +

+ +
+ Plugins view in WebSockets Server +
+ Plugins view in WebSockets Server +
+
+ +

Transport

+ +

+ The Transport view displays the timecode of the current playhead + position and allows toggling playback. +

+ +
+ Transport view in WebSockets Server +
+ Transport view in WebSockets Server +
+
+ +

+ The Record toggle is currently non-functional. +

+ +

Protocol

+ +

+ This page is targeted at developers willing to enhance the WebSockets Server + control surface. It displays the data passed between Ardour and the web + browser. +

+ +
+ Protocol view in WebSockets Server +
+ Protocol view in WebSockets Server +
+
diff --git a/master-doc.txt b/master-doc.txt index 687d829..d8d18a8 100644 --- a/master-doc.txt +++ b/master-doc.txt @@ -1964,7 +1964,15 @@ part: chapter title: Utilities include: bundled-plugins-utilities.html link: bundled-plugins-utilities -uri: plugins-uitilties +uri: plugins-utilities +part: chapter +--- + +--- +title: Inline Scopes +include: bundled-plugins-inline-scopes.html +link: bundled-plugins-inline-scopes +uri: plugins-inline-scopes part: chapter --- @@ -2236,6 +2244,15 @@ uri: using-control-surfaces/Ableton_Push2 part: chapter --- +--- +title: Using the WebSockets Server +menu_title: WebSockets Server +include: control-surfaces-websockets-server.html +link: control-surfaces-websockets-server.html +uri: using-control-surfaces/websockets-server +part: chapter +--- + --- title: Troubleshooting part: part diff --git a/source/images/websockets-main.png b/source/images/websockets-main.png new file mode 100644 index 0000000..9d12f74 Binary files /dev/null and b/source/images/websockets-main.png differ diff --git a/source/images/websockets-mixer.png b/source/images/websockets-mixer.png new file mode 100644 index 0000000..5dcb351 Binary files /dev/null and b/source/images/websockets-mixer.png differ diff --git a/source/images/websockets-plugins.png b/source/images/websockets-plugins.png new file mode 100644 index 0000000..44e29a1 Binary files /dev/null and b/source/images/websockets-plugins.png differ diff --git a/source/images/websockets-protocol.png b/source/images/websockets-protocol.png new file mode 100644 index 0000000..b702c63 Binary files /dev/null and b/source/images/websockets-protocol.png differ diff --git a/source/images/websockets-transport.png b/source/images/websockets-transport.png new file mode 100644 index 0000000..31f06d9 Binary files /dev/null and b/source/images/websockets-transport.png differ