AG
Process an RML only if the On-Air flag is ON.
AG
rml!
Execute RML rml only if the On-Air flag on
the local machine is ON.
AL
Append a log to a cuurently loaded log.
AL
mach
logname!
Append the log named logname to the log
currently loaded in log machine mach.
BO
Output a string of binary codes.
BO
portnum
hexcode
..!
Output a string of binary codes represented by
hexcode .. on
serial port portnum.
SC
Clear a serial trap.
SC
portnum
cart
string!
SC
portnum
cart!
SC
portnum!
Clear a serial trap. The three argument form will clear all traps on
port that reference
cart and string.
The two argument form will clear all traps on
port that reference
cart, while the one argument form will
clear all traps on port.
CC
Send RML to a remote host.
CC
dest[:udpport]
rml!
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).
JC
Connect a JACK input port to an output port.
JC
output
input!
Attempt to connect JACK input port input
to output. See
Section 14.7, “JACK Port Names” for an example.
CL
Set the label on a control surface.
CL
matrix
surface
chan
label!
On matrix matrix, set the input
chan module label of control surface
surface to label.
CP
Copy cut audio and metadata.
CP
srccart
srccut
dstcart
dstcut!
Copy the audio and metadata from cut number
srccut in cart
srccart to cut number
dstcut in cart
dstcart. The destination cart/cut must
already exist.
CE
Place a cut event at the current location of an active RDCatch recording.
CE
decknum
eventnum!
Place a cut event with event number
eventnum at the current position of the
active recording in RDCatch Deck
decknum.
JD
Disconnect a JACK input port from an output port.
JD
output
input!
Attempt to disconnect JACK input port input
from output.
JZ
Disconnect all JACK audio port connections.
JZ!
Attempt to disconnect all JACK port connections.
PD
Set the duck level of a SoundPanel button in RDAirPlay.
PD
panel
col
row
level
fade
[mport]!
Set the duck level of button at column,
row of panel
panel.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
If col and/or row
is 0: duck all buttons in
col or row.
If playing, the audio fades to level
(in db) in fade msecs.
If specified, only stop carts playing on panel port
mport. The duck level will be set to 0 after
the playback is finished, or the button is stopped or reset.
DX
Execute a breakaway.
DX
slotlen!
Execute a breakaway of length len (in mS)
using the autofill carts configured for the service currently loaded
in the slot slot. The slot must be in
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 to be aborted immediately and input audio restored.
EX
Execute a macro cart.
EX
cartnum!
Execute macro cart cartnum on the local host.
FS
Execute a switcher salvo.
FS
matrix
salvo!
Fire salvo number salvo on matrix
matrix.
GE
Enable/disable a GPI line.
GE
matrix
type
gpinum-spec
state!
Enable or disable the GPI line(s) of type type
indicated by gpinum on matrix
matrix. Possible types are:
IO
The gpinum-spec can be an integer value
to indicate a single GPI line or a range specification to indicate
multiple lines. A range specification has the following format:
[first-value]:[last-value]
All values in a range specification are inclusive. Some examples:
Table 14.1. Range Specification Examples
| 1:10 | Lines 1 through 10, inclusive |
| 5:10 | Lines 5 through 10, inclusive |
| 7:7 | Line 7 |
| :10 | Lines 1 through 10, inclusive |
| 1: | Lines 1 onward, inclusive |
| : | All lines in the specified matrix |
stop parameter in a slice is
last_value+1.
step parameter.
GE
Enable/disable a GPI line.
GE
matrix
gpinum-spec
state!
Enable or disable the GPI line(s) indicated by
gpinum-spec on matrix
matrix.
The gpinum-spec can be an integer value
to indicate a single GPI line or a range specification to indicate
multiple lines. See
Table 14.1, “Range Specification Examples” above
for examples of range specifications.
GI
Set action in response to a GPIO event.
GI
matrix
type
gpinum
state
cart!
Execute the macro cart cart upon transition
of the GPIO of type type and line
gpinum on matrix
matrix to state.
Possible types are:
IO
GI
Set action in response to a GPIO event.
GI
matrix
gpinum
state
cart!
Execute the macro cart cart upon transition
of the GPIO of line gpinum on matrix
matrix to state.
GO
Set the state of a GPIO line.
GO
matrix
type
gponum
state
length!
Command GPIO line gponum of type
type on matrix
matrix> to state
for length> mS. A length of
0 indicates to hold the state indefinitely.
Possible types are:
IO
Possible states are:
01-1
GO
Set the state of a GPIO line.
GO
matrix
gponum
state
length!
Command GPIO line gponum on matrix
matrix> to state
for length> mS. A length of
0 indicates to hold the state indefinitely.
PX
Insert a cart in a log.
PX
mach
cart
[offset
[PLAY|SEGUE|STOP]]!
Insert cart cart after the currently playing
or next event plus offset (default '0')
lines on log machine mach. The
transition may also be optionally specified.
SI
Insert a serial trap to detect a character sequence.
SI
portnum
cart
string!
Insert a serial trap to execute the macro cart
cart upon receipt of
string on serial port
port.
PC
Set the label of a SoundPanel button in RDAirPlay.
PC
panel
col
row
label
color!
Set the button at col,
row of panel panel
to have a text label of label and a
background color of color.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
LL
Load a log into RDAirPlay.
LL
mach
[logname]
[startline]!
Load the log logname in log machine
mach. After loading, start the log at line
startline if it is >=0. If
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
is unloaded.
LM
Load a webpage into RDAirPlay's Message Area.
LM
url!
Display the web page specified by url in the
message widget.
PE
Load a cart into a SoundPanel button in RDAirPlay.
PE
panel
col
row
cart!
Load cart cart into the button at
col,row of panel
panel.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
DL
Load an RDCartSlots slot.
This command has two syntaxes, depending upon the mode of the slot.
Cart Deck Mode syntax:
DL
slot
cart!
Load the cart cart into the
slot slot. Passing a '0' for
cart will cause the slot to be unloaded.
This command will be ignored if the slot is currently playing.
Breakaway Mode syntax:
DL
slot
svcname!
Set the slot slot to use service
svcname. Omitting the
svcname argument will cause the slot to be
unloaded. This command will be ignored if the slot is currently
executing a breakaway.
LO
Change the active Rivendell user context.
LO
user
password!
Set the current Rivendell user to user.
If no arguments are supplied, log out the station --i.e. revert to the
default user.
MT
Timer for running macro carts.
MT
timernum
timeout
cart!
Set the macro timer timernum to execute macro
cart cart in
timeout milliseconds. Setting
timeout to 0 disables
the timer. Sixteen macro timers (numbered 1-16) are available on each
Rivendell host.
MN
Load changes to a currently loaded log in RDAirPlay.
RL
mach
line!
Set the next event for log machine mach to
line line.
MB
Display a popup message box on a host display.
MB
display
severity
msg!
Display the text msg in a popup window on X
display display, with an icon to indicate
severity. Valid values of
severity are:
123
When using the 'Message Box' ['MB'] RML,
it may be necessary to configure the X server to allow local
connections from other processes. One way to
do this is to execute the following command as the local Rivendell user:
xhost +local:
For more information, see the xhost(1) man page.
PU
Pause a SoundPanel button in RDAirPlay.
PU
panel
col
row
[mport]!
Pause the button at col,
row of panel panel.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
If col and/or row
is 0: pause all playing buttons in
col or row.
If specified, start the playout on panel port
mport.
Enable Button Pausing checkbox must be
ticked on the
Configure RDAirPlay dialog
in rdadmin(1).
PP
Load a cart into a SoundPanel button in RDAirPlay.
PP
panel
col
row
[mport]
[0|1]!
Play the button at col,
row of panel panel.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
If col and/or row
is 0: Start the first loaded button that is not
active. If specified, start the playout on panel port
mport. The started panel will stay active when
finished, if the 5th argument is 1.
DP
Play an RDCartSlots slot.
DP
slot!
Play the cart currently loaded in the slot
slot. The slot must be in Cart Deck mode. This command will be
ignored if the slot is unloaded or already playing.
RL
Load changes to a currently loaded log in RDAirPlay.
RL
mach!
Refresh the log currently loaded in log machine
mach.
RN
Run a shell command.
RN
cmd!
Run the shell command cmd.
The command is actually executed as:
/bin/sh -c
cmd
using the user and group specified by the "RnRmlOwner=" and "RnRmlGroup=" directives in the "[Identity]" section of rd.conf(5).
PW
Select right-hand widget in RDAirPlay.
PW
mach!
Select right-hand widget to log-machine mach
or 0 for sound panel or
4 for voice tracker.
SO
Output a string on a serial port.
SO
portnum
data!
Output data on serial port
portnum. data can
consist of arbitrary binary data as well as textual characters (see
Section 14.6, “Binary Data” above).
SY
Reload the configuration for a serial port.
SY
portnum!
Reload the configuration for serial port
portnum. Normally, this should only be
issued by RDAdmin following a configuration change.
LC
Display a color message in the label widget on RDAirPlay.
LC
color
string!
Display string in color
color in the message widget. For the list
of available colors, see Section 14.5, “Specifying Color”.
SN
Set the default Now & Next cart.
SN
now|next
mach
cart!
Set the default Now & Next cart for log
mach to cart.
SD
Set a console display.
SD
matrix
display
line
col
attr
label!
On matrix matrix, set the console display
display to label,
starting at position line,
col and using message attributes
attr.
The message attributes value is constructed as follows:
Display Mode:
Video Attribute:
Text Color:
MD
Set duck level for an RDAirPlay log machine.
MD
mach
level
fade
[mport]!
Set the duck level of mach, or
0 for all log machines. If playing, the audio
fades to level (in db) in
fade msecs. If specified, only affect carts
playing on machine port mport.
Loading or clearing a log will set the duck level back to 0.
LB
Display a message in the label widget on RDAirPlay.
LB
string!
Display string in the message widget.
PM
Set the mode of an RDAirPlay log machine.
PM
mode
[mach]!
Set log machine mach to mode
mode. If mode is not given or the Mode
Control Style is set to 'Unified', then all log machines are set to
mode. Valid values for
mode are:
See Section 14.8, “Log Machines” for the possible values
of mach.
SP
Pause for specified time.
SP
msecs!
Wait for msecs milliseconds.
PL
Start a log at a specified line.
PL
mach
line!
Start log machine mach at line
line if stopped, otherwise do nothing.
PB
Push an RDAirPlay Start button (numbered starting from 1 at the top and counting downwards).
PB
button!
Push button button.
PN
Start the next event in a log.
PN
mach
[mport]
[skip]!
Start log machine mach if stopped, or start
next event if already running. If specified, start the playout on
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
will be skipped over.
RS
Start an RDCatch Recording
RS
decknum
cartnum
cutnum
maxlen!
Start recording to cut cutnum of cart
cartnum, using RDCatch record deck
decknum for a maximum time of
maxlen mS. The record parameters used
(format, sample rate, channels, etc) will be those configured for the
selected deck in RDAdmin->ManageHosts->RDCatch. The selected cart and
cut must already exist. Any audio previously residing in the selected
cart and cut will be overwritten.
PS
Stop a log in RDAirPlay.
PS
mach|0
[fade]
[mport]!
Stop log machine mach, or
0 for all log machines. If specified, only stop
carts playing on machine port mport. If
specified, fade out fade msecs.
PT
Stop a SoundPanel button in RDAirPlay.
PT
panel
col
row
[mport]
[0|1]
fade!
Stop the button at col,
row of panel panel.
Panel: S1...S50 or
U1...U50;
C for panel means
currently selected panel.
If col and/or row
is 0: stop all playing buttons in
col or row.
If specified, stop the playout on panel port
mport, applying a fade of duration
fade milliseconds. If the 5th argument is
1, the button will enter the paused state after
the fade completes.
Enable Button Pausing checkbox must be
ticked on the
Configure RDAirPlay dialog
in rdadmin(1).
RR
Stop an RDCatch Recording
RR
decknum!
Stop any active recording on RDCatch deck decknum.
DS
Stop an RDCartSlots slot.
DS
slot!
Stop the cart currently loaded in the slot
slot. The slot must be in Cart Deck mode. This command will be
ignored if the slot is unloaded or already playing.
SA
Add an input to an output.
SA
matrix
input
output!
Command switch matrix number matrix to add
input number input to output number
output. Unlike SWITCH TAKE,
this command leaves any other previously assigned inputs unchanged.
SG
Add an input to an output while specifyng the crosspoint gain.
SG
matrix
input
output
gain!
Command switch matrix number matrix to add
input number input to output number
output at gain gain.
The gain is specified in 1/10 of a dB, with 0 = unity gain.
Unlike SWITCH TAKE, this command leaves any other
previously assigned inputs unchanged.
SX
Set crosspoint gain.
SX
matrix
input
output
level!
Command switch matrix number matrix to adjust
the gain of the crosspoint connecting input
input to output
output to level dB.
SL
Set input gain.
SL
matrix
input
level!
Command switch matrix number matrix to adjust
the gain of input number input to
level dB.
SZ
Reload the configuration for a switch matrix.
SZ
matrix!
Reload the configuration for switch matrix
matrix. Normally, this should only be
issued by RDAdmin following a configuration change.
SR
Remove an input from an output.
SR
matrix
input
output!
Command switch matrix number matrix to remove
input number input from output number
output. Unlike SWITCH TAKE,
this command leaves any other previously assigned inputs unchanged.
ST
Exclusively route an input to an output.
ST
matrix
input
output!
Command switch matrix number matrix to take
input number input to output number
output. "Take" in this context implies
removing any previously assigned inputs from the referenced output.
TA
Set the state of the On Air flag.
TA 0|1!
Set the On-Air flag to ON [1] or OFF
[0].
UO
Send data to a UDP port.
UO
ipaddr
udpport
data!
Send data in a UDP packet to port
udpport at ipaddr.
data can consist of arbitrary binary data as
well as textual characters (see Section 14.6, “Binary Data”
for details).