mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-12-01 22:30:13 +01:00
2022-11-03 Fred Gleason <fredg@paravelsystems.com>
* Removed vestigal code for RDCatch control via TCP connection. Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
@@ -33,8 +33,6 @@
|
||||
|
||||
all-local: cae.html\
|
||||
cae.pdf\
|
||||
catchd.html\
|
||||
catchd.pdf\
|
||||
fonts.html\
|
||||
fonts.rdcastmanager.list_carts.png\
|
||||
fonts.pdf\
|
||||
@@ -54,9 +52,6 @@ all-local: cae.html\
|
||||
EXTRA_DIST = cae.html\
|
||||
cae.pdf\
|
||||
cae.xml\
|
||||
catchd.html\
|
||||
catchd.pdf\
|
||||
catchd.xml\
|
||||
fonts.html\
|
||||
fonts.pdf\
|
||||
fonts.xml\
|
||||
|
||||
@@ -1,137 +0,0 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<article xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<info>
|
||||
<title>Rivendell RDCatch Monitor Protocol</title>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Fred</firstname>
|
||||
<surname>Gleason</surname>
|
||||
<email>fredg@paravelsystems.com</email>
|
||||
</personname>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<sect1 xml:id="overview">
|
||||
<title>Overview</title>
|
||||
<para>
|
||||
This defines the IP protocol used for communication between different
|
||||
modules of Rivendell and the
|
||||
<command>rdcatchd</command><manvolnum>8</manvolnum> daemon.
|
||||
</para>
|
||||
<para>
|
||||
Connection to ripcd is by means of a TCP SOCK_STREAM connection to TCP
|
||||
port <userinput>6006</userinput>. The format of a message is as follows:
|
||||
</para>
|
||||
<para>
|
||||
<replaceable>cmd-code</replaceable> [<replaceable>arg</replaceable>] [<replaceable>...</replaceable>]!
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<replaceable>cmd-code</replaceable>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
A two letter command code, describing the generic action to be
|
||||
performed
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<replaceable>arg</replaceable>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Zero or more arguments, delimited by spaces or, if the last
|
||||
argument, by ! (see below)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
!
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The ASCII character 33, indicating the end of the command sequence.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="sect.unprivileged_commands">
|
||||
<title>Unprivileged Commands</title>
|
||||
<para>
|
||||
No authentication is required to execute these.
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="sect.privileged_commands">
|
||||
<title>Privileged Commands</title>
|
||||
<para>
|
||||
A connection must be authenticated before these can be executed.
|
||||
</para>
|
||||
|
||||
<sect2 xml:id="sect.privileged_commands.enable_metering">
|
||||
<title>Enable Metering</title>
|
||||
<para>
|
||||
Enable/Disable Audio Metering
|
||||
</para>
|
||||
<para>
|
||||
<userinput>RM <replaceable>state</replaceable>!</userinput>
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><replaceable>state</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<computeroutput>1</computeroutput> = Enabled,
|
||||
<computeroutput>0</computeroutput> = Disabled.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>
|
||||
When metering is active, meter data packets will be periodically sent,
|
||||
as follows:
|
||||
</para>
|
||||
<para>
|
||||
<computeroutput>RM <replaceable>deck</replaceable>
|
||||
<replaceable>chan</replaceable>
|
||||
<replaceable>level</replaceable>!</computeroutput>
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><replaceable>deck</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Deck number
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><replaceable>chan</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Channel, <computeroutput>0</computeroutput> = Left,
|
||||
<computeroutput>1</computeroutput> = Right
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><replaceable>level</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Left audio level, in 1/100 of dbFS
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</sect2>
|
||||
|
||||
|
||||
</sect1>
|
||||
|
||||
</article>
|
||||
Reference in New Issue
Block a user