From ea9f0d7674e9b24f52f8636c3c00b839482f3f26 Mon Sep 17 00:00:00 2001 From: Fred Gleason Date: Fri, 20 May 2022 14:05:27 -0400 Subject: [PATCH] 2022-05-20 Fred Gleason * Updated the 'Rivendell Macro Language' chapter of the Operations Guide. Signed-off-by: Fred Gleason --- ChangeLog | 3 + docs/opsguide/rml.xml | 147 +++++++++++++++++++++++++++++++++--------- 2 files changed, 118 insertions(+), 32 deletions(-) diff --git a/ChangeLog b/ChangeLog index feea5648..b4fe51a3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23116,3 +23116,6 @@ 2022-05-20 Fred Gleason * Fixed up remaining image dimension parameters in the 'Configuring Rivendell with RDAdmin' chapter of the Operations Guide. +2022-05-20 Fred Gleason + * Updated the 'Rivendell Macro Language' chapter of the Operations + Guide. diff --git a/docs/opsguide/rml.xml b/docs/opsguide/rml.xml index 56b58134..22fe1c3b 100644 --- a/docs/opsguide/rml.xml +++ b/docs/opsguide/rml.xml @@ -1,4 +1,4 @@ - + Rivendell Macro Langauge Overview @@ -62,7 +62,7 @@ delivered to UDP ports 5858 or 5859 on said system, using the SOCK_DGRAM connectionless protocol. Commands delivered to port 5858 may receive a reply back to the originating IP address at UDP socket 5860 to indicated - command success/failure, while commanders delivered to 5859 will be + command success/failure, while commands delivered to 5859 will be processed, but no reply made. @@ -169,6 +169,40 @@ + + JACK Port Names + + Some commands (e.g. the Connect Jack Ports [JC] RML) require JACK port + name arguments. Such port names have the following form: + + + jack-client-name:jack-endpoint-name + + + For example, to connect the first Rivendell audio output to the first + available system playback ports, the following RML could be used: + + + JC system:playback_1 rivendell_0:playout_0L! + JC system:playback_2 rivendell_0:playout_0R! + + + In this example, system and + rivendell_0 are + jack-client-names, while + playback_1, playback_2, + playout_0L and playout_0R + are jack-endpoint-names. + + + Note that two RML commands are required + for this specific example. This is because JACK has no notion of + stereo pairs, hence the "left" and "right" Rivendell + playout ports have to be independently connected to the specific system + playback ports. + + + Log Machines @@ -181,14 +215,56 @@ The log machine argument in the context - of Rivendell macros must be an integer ranging from Zero (0) to - Three (3). 0 represents - all log machines, - 1 represents the Main - Log, 2 represents - Aux Log 1, and - 3 represents Aux Log - 2. + of Rivendell macros must be an integer falling within one of the + following values: + + + 0 + + + All non-virtual log machines --i.e. the + Main Log, + Aux 1 Log and + Aux 2 Log log machines. + + + + + 1 + + + Main Log + + + + + 2 + + + Aux 1 Log + + + + + 3 + + + Aux 2 Log + + + + + + 101 through 120 + + + + Virtual Log 101 through + Virtual Log 120 + + + + For example, the macro PL 1 0! starts @@ -284,7 +360,7 @@ Output a string of binary codes represented by hexcode .. on - serial port portnum! + serial port portnum. @@ -350,16 +426,15 @@ CC - dest - [:udpport] + dest[:udpport] rml! - Send the RML command rml to - dest.dest may be - either a Rivendell host name or an IP address. A UDP port value may be - optionally specified as udpport (default - value 5859). + Execute the RML command rml on host + dest, where dest + may be either a Rivendell host name or an IP address. A UDP port value + may be optionally specified as udpport + (default value 5859). @@ -387,7 +462,8 @@ Attempt to connect JACK input port input - to output. + to output. See + for an example. @@ -529,7 +605,7 @@ - Disconnect all JACK input port connections. + Disconnect all JACK audio port connections. JZ! @@ -567,7 +643,7 @@ Set the duck level of button at column, - row> of panel + row of panel panel. Panel: S1...S50 or U1...U50; @@ -612,7 +688,7 @@ Breakaway mode. If a breakaway is currently executing, it will immediately be aborted and a new one started. Passing a '0' for len will cause any currently executing - breakaway immediately to be aborted and input audio restored. + breakaway to be aborted immediately and input audio restored. @@ -1048,7 +1124,7 @@ startline is -2, the log will be started at the first event if that event does not have a 'stop' transition. Default startline=-1. If no - log> is specified, the machine's current log + log is specified, the machine's current log is unloaded. @@ -1225,7 +1301,7 @@ Set the next event for log machine mach to - line line>. + line line. @@ -1541,7 +1617,7 @@ Output data on serial port portnum. data can consist of arbitrary binary data as well as textual characters (see - Binary Data above). + above). @@ -1596,8 +1672,9 @@ string! - Display string> in color - color in the message widget. + Display string in color + color in the message widget. For the list + of available colors, see . @@ -1797,7 +1874,7 @@ string! - Display string> in the message widget. + Display string in the message widget. @@ -1844,6 +1921,10 @@ + + See for the possible values + of mach. + @@ -1915,7 +1996,8 @@ - Push an RDAirPlay Start button (1-7, numbered from the top). + Push an RDAirPlay Start button (numbered starting from 1 at the top + and counting downwards). PB @@ -1950,9 +2032,9 @@ [skip]! - Start log machine mach> if stopped, or start + Start log machine mach if stopped, or start next event if already running. If specified, start the playout on - machine port mport>. If + machine port mport. If skip is supplied, equal to '1' and the log machine is in Manual or Live Assist mode, then any intervening meta-events in log between the current 'next' event and the next cart @@ -2393,7 +2475,8 @@ Send data in a UDP packet to port udpport at ipaddr. data can consist of arbitrary binary data as - well as textual characters (see Binary Data above). + well as textual characters (see + for details).