diff --git a/ChangeLog b/ChangeLog index c8f531b2..6599f606 100644 --- a/ChangeLog +++ b/ChangeLog @@ -15011,3 +15011,7 @@ scheduler codes in a case-insensitve manner. * Modified the return of the 'EditCut' web method to provide a full record in 'web/rdxport/carts.cpp'. +2016-03-24 Fred Gleason + * Ported 'docs/cae.sxw' to DocBook-XML5 in 'docs/docbook/cae.xml'. + * Ported 'docs/web_api.odt' to DocBook-XML5 in + 'docs/dockbook/web_api.xml'. diff --git a/INSTALL b/INSTALL index 4b203217..0f916673 100644 --- a/INSTALL +++ b/INSTALL @@ -98,6 +98,27 @@ TwoLAME - MPEG Layer 2 Encoder Library. Needed for MPEG Layer 2 exporting and capture. Available at http://www.twolame.org/. +DOCUMENTATION +------------- +The larger pieces of the Rivendell documentation are written in XML-DocBook5. +Pre-generated docs are included in the source tarball, so special tools will +not normally be required to view or install them. However, if you need to +rebuild them (either because you've modified the DocBook sources or are +installing from the primary GitHub repository), then you will need the +following: + +XML-DocBook5 Stylesheets. Available at +http://sourceforge.net/projects/docbook/. You will also need to create a +$DOCBOOK_STYLESHEETS variable in your environment that points to the top +of the stylesheet tree. More information can be found at +http://www.docbook.org/tdg5/en/html/appa.html#s.stylesheetinstall. On +RHEL-ish systems, they are also available in the 'docbook5-style-xsl' +package. + +xsltproc. Command line XSLT processor. Available at +http://xmlsoft.org/XSLT/xsltproc2.html + + INSTALLATION There are three major steps to getting a Rivendell system up and running. They are: diff --git a/Makefile.am b/Makefile.am index 4fc4bf09..d9001aec 100644 --- a/Makefile.am +++ b/Makefile.am @@ -31,6 +31,7 @@ endif if ALSA_RD_AM ALSACONFIG_RD_OPT = rdalsaconfig endif + SUBDIRS = icons\ helpers\ lib\ diff --git a/configure.ac b/configure.ac index 8a730114..ea9878f8 100644 --- a/configure.ac +++ b/configure.ac @@ -66,6 +66,8 @@ AC_ARG_ENABLE(jack,[ --disable-jack disable JACK sound support], [JACK_DISABLED=yes],[]) AC_ARG_ENABLE(alsa,[ --disable-alsa disable direct ALSA sound support], [ALSA_DISABLED=yes],[]) +AC_ARG_ENABLE(docbook,[ --disable-docbook disable building of documentation],[DOCBOOK_DISABLED=yes],[]) + AC_ARG_ENABLE(gpio,[ --disable-gpio disable General Purpose Input/Output GPIO support], [GPIO_DISABLED=yes],[]) AC_ARG_ENABLE(pam,[ --disable-pam disable Rivendell PAM pam_rd.so support], @@ -223,6 +225,14 @@ if test -z $MP4V2_DISABLED ; then fi fi +# +# Build DocBook Items? +# +if test -z $DOCBOOK_DISABLED ; then + USING_DOCBOOK=yes +fi +AM_CONDITIONAL([DOCBOOK_AM], [test "$USING_DOCBOOK" = yes]) + # # Set Hard Library Dependencies # @@ -466,6 +476,7 @@ AC_CONFIG_FILES([rivendell.spec \ web/tests/Makefile \ conf/Makefile \ docs/Makefile \ + docs/docbook/Makefile \ docs/examples/Makefile \ docs/man/Makefile \ docs/tables/Makefile \ diff --git a/docs/Makefile.am b/docs/Makefile.am index 5f569dd3..78956eae 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -2,7 +2,7 @@ ## ## docs/automake.am for Rivendell ## -## (C) Copyright 2002-2006 Fred Gleason +## (C) Copyright 2002-2016 Fred Gleason ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License version 2 as @@ -19,14 +19,17 @@ ## ## Use automake to process this into a Makefile.in -SUBDIRS = examples\ +if DOCBOOK_AM + DOCBOOK_AM_OPT = docbook +endif + +SUBDIRS = $(DOCBOOK_AM_OPT) examples\ man\ tables EXTRA_DIST = ALSA.txt\ ando_interface.odt\ asound.conf-sample\ - cae.sxw\ catchd.txt\ colors\ copy_split_format.odt\ @@ -49,7 +52,6 @@ EXTRA_DIST = ALSA.txt\ SAGE_ENDEC.txt\ scheduler_formats.ods\ SWITCHERS.txt\ - web_api.odt\ WIN32.txt\ WINGS_FILTER.txt diff --git a/docs/cae.sxw b/docs/cae.sxw deleted file mode 100644 index b32c034a..00000000 Binary files a/docs/cae.sxw and /dev/null differ diff --git a/docs/docbook/Makefile.am b/docs/docbook/Makefile.am new file mode 100644 index 00000000..7281d8c8 --- /dev/null +++ b/docs/docbook/Makefile.am @@ -0,0 +1,54 @@ +## automake.am +## +## docs/docbook/automake.am for Rivendell +## +## (C) Copyright 2015 Fred Gleason +## +## This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License version 2 as +## published by the Free Software Foundation. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public +## License along with this program; if not, write to the Free Software +## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +## +## Use automake to process this into a Makefile.in + +## +## Build Dependencies +## +%.html: %.xml + xsltproc -o $@ $(DOCBOOK_STYLESHEETS)/xhtml/docbook.xsl $< +%.pdf: %.xml + xsltproc $(DOCBOOK_STYLESHEETS)/fo/docbook.xsl $< | fop - -pdf $@ +%.1: %.xml + xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $< +%.8: %.xml + xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $< + +all-local: cae.html\ + cae.pdf\ + web_api.html\ + web_api.pdf + +EXTRA_DIST = cae.html\ + cae.pdf\ + cae.xml\ + web_api.html\ + web_api.pdf\ + web_api.xml + +CLEANFILES = *~ +MAINTAINERCLEANFILES = *~\ + *.1\ + *.8\ + *.html\ + *.pdf\ + aclocal.m4\ + configure\ + Makefile.in diff --git a/docs/docbook/cae.xml b/docs/docbook/cae.xml new file mode 100644 index 00000000..f26ee313 --- /dev/null +++ b/docs/docbook/cae.xml @@ -0,0 +1,1755 @@ + +
+ + Rivendell Core Audio Control Protocol + 0.9.1 + + + Fred + Gleason + fredg@paravelsystems.com + + + + + + Overview + + Formats used for audio storage are Broadcast Wave Format (BWF), as + specified in + EBU Tech Pub 3285 + with annexes. + + + Commands to the Core Audio Engine are passed by means of a + TCP SOCK_STREAM connection to TCP port 5005 on the host server. + + + Commands have the following general syntax: + + + cmd-code [arg] [...]! + + + + + cmd-code + + + + A two letter command code, describing the generic action to be + performed + + + + + + arg + + + + Zero or more arguments, delimited by spaces or, if the last + argument, by ! (see below) + + + + + + ! + + + + The ASCII character 33, indicating the end of the command sequence. + + + + + + Unless otherwise specified, the engine will echo back the command with a + + or - before the !, to indicate the success or failure of the command + execution. + + + + + Connection Management + + <command>Password</command> + + Pass a password to the server for authentication. + + + PW + password! + + + + + password + + + A password to be supplied before granting the client access. + + + + + Returns: PW +! to indicate success, + PW -! to indicate failure + + + + <command>Drop Connection</command> + + Drop the TCP connection and end the session. + + + DC! + + + + + + Playback Operations + + <command>Load Playback</command> + + Prepare an audio interface to play an audio file. + + + LP card-num + name! + + + + + card-num + + + The number of the audio adapter to use. + + + + + name + + + The base name of an existing file in the audio storage filesystem. + + + + + Returns: LP + card-num + name + stream-num + conn-handle! + + + + + stream-num + + + + The stream number selected to be used, or a -1 in case of error. + This is relative to the audio adapter selected. + + + + + + conn-handle + + + + The connection handle. This will be used to refer to the playback + event in all subsequent calls to CAE. + + + + + + + + <command>Unload Playback</command> + + Free an audio playback interface. + + + UP conn-handle! + + + + + conn-handle + + + + The connection handle of the playback event, from the + Load Playback call. + + + + + + + + <command>Play Position</command> + + Position the playback pointer. + + + PP conn-handle + position! + + + + + conn-handle + + + + The connection handle of the playback event, from the + Load Playback call. + + + + + + position + + + + Position in file, in milliseconds. + + + + + + + + <command>Play</command> + + Play the loaded file from the current position. + + + PY conn-handle + length + speed + pitch-flag! + + + + + conn-handle + + + + The connection handle of the playback event, from the + Load Playback call. + + + + + + length + + + + Playback length in milliseconds, relative to the current start + position. + + + + + + speed + + + + Playback speed in thousandths of a percent. 100000 = normal speed. + + + + + + pitch-flag + + + + Controls whether audio pitch changes with speed or not. 0 = no, + 1 = yes. + + + + + + + + <command>Stop Playback</command> + + Stop playback of the specified playback interface. + + + SP conn-handle! + + + + + conn-handle + + + + The connection handle of the playback event, from the + Load Playback call. + + + + + + + + <command>Timescaling Support</command> + + Query CAE if card-num supports timescaling. + + + TS card-num! + + + + + card-num + + + + The number of the audio adapter to query. + + + + + + Returns: TS + card-num + +|-! + + + + + + Record Operations + + <command>Load Recording</command> + + Prepare an audio interface to capture an audio file. + + + LR + card-num + port-num + coding + channels + samp-rate + bit-rate + name! + + + + + card-num + + + + The number of the audio adapter to query. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + coding + + + + 0 = PCM16, 1 = MPEG Layer 1, 2 = MPEG Layer 2, 4 = PCM24 + + + + + + channels + + + + 1 = Mono, 2 = Stereo + + + + + + samp-rate + + + + Sample Rate in samples/sec. 32000, 44100 or 48000 supported. + + + + + + bit-rate + + + + MPEG Bit Rate. For PCM, this should be zero. + + + + + + name + + + + The base name of a file in the audio storage filesystem. If the + file already exists, it will be overwritten, otherwise it will be + created. + + + + + + + + <command>Unload Recording</command> + + Free an audio capture interface. + + + UR card-num + stream-num! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + Returns: UR + card-num + stream-num + len! + + + + + len + + + + Length of recording, in mS. + + + + + + + + <command>Record</command> + + Record a loaded file. + + + RD card-num + stream-num + length + threshold! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + length + + + + Length of time to record in milliseconds. If zero, record until + told to stop. + + + + + + threshold + + + + Threshold of audio detected at which to start recording, in + 1/100 dBFs. If '0', start immediately. + + + + + + Returns: When recording actually begins, a Record Start (RS) + confirmation will be echoed back. If record time expires a Stop Record + (SR) confirmation will be echoed back. + + + + + <command>Record Start</command> (Receive Only) + + Receive-only signal to indicate recording has actually + started (as with a VOX event, where actual recording may begin some + time after the interface is placed into record). + + + RS card-num + stream-num! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + + + + Mixer Operations + + <command>Set Input Volume</command> + + Set the volume of an input stream. + + + IV card-num + stream-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Set Output Volume</command> + + Set the volume of an output stream. + + + OV card-num + stream-num + port-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Fade Output Volume</command> + + Transition the volume of an output stream over time. + + + FV card-num + stream-num + port-num + level + length! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + length + + + + The length of the transition, in milliseconds. + + + + + + + + <command>Set Input Level</command> + + Set the gain level of an input port. + + + IL card-num + port-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Set Output Level</command> + + Set the gain level of an output port. + + + OL card-num + port-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Set Input Mode</command> + + Set the mode of an input stream. + + + IM card-num + stream-num + mode! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + mode + + + + The mode, as follows: + + + + 0 + + + + Normal + + + + + + 1 + + + + Swap left and right channels + + + + + + 2 + + + + Left audio on both channels + + + + + + 3 + + + + Right audio on both channels + + + + + + + + + + + + <command>Set Output Mode</command> + + Set the mode of an output stream. + + + OM card-num + stream-num + mode! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + mode + + + + The mode, as follows: + + + + 0 + + + + Normal + + + + + + 1 + + + + Swap left and right channels + + + + + + 2 + + + + Left audio on both channels + + + + + + 3 + + + + Right audio on both channels + + + + + + + + + + + + <command>Set Input Vox Level</command> + + Set the VOX threshold level of an input stream. + + + IX card-num + stream-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The stream number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Set Input Type</command> + + Set the signal type of an input port. + + + IT card-num + port-num + type! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + type + + + + The mode, as follows: + + + + 0 + + + + Analog + + + + + + 1 + + + + AES3 Digital + + + + + + + + + + + + <command>Get Input Status</command> + + Request the status of an input port. + + + IS card-num + port-num! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number to use. This is relative to the audio adapter + selected. + + + + + + Returns: IS + card-num + port-num + status! + + + + + status + + + + The status, as follows: + + + + 0 + + + + OK + + + + + + 1 + + + + No Sync + + + + + + + + + + + + <command>Set Audio Passthrough Level</command> + + Set the gain of an audio passthrough path. + + + AL card-num + input-num + output-num + level! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + input-num + + + + The input number to use. This is relative to the audio adapter + selected. + + + + + + output-num + + + + The output number to use. This is relative to the audio adapter + selected. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Set Clock Source</command> + + Set source of an audio adapter's sample clock. Relevant only for + cards that feature AES3 inputs. + + + CS card-num + input-num! + + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + input-num + + + + The input number to use. This is relative to the audio adapter + selected. + + + + + + + + + External Operations + + <command>Open RTP Capture Channel</command> + + Open an RTP channel for audio capture. + + + CO card-num + port-num + udp-port + samp-rate + channels! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + udp-port + + + + The port number on the remote system to which to send RTP packets. + + + + + + samp-rate + + + + The requested sample rate. + + + + + + channels + + + + The requested number of channels. + + + + + + Returns: CO + card-num + port-num + udp-port + samp-rate + chans + pkt-size! + + + + + pkt-size + + + + The number of bytes to send per UDP packet. + + + + + + The actual sample rate and number of channels may be different from + those requested; clients must be prepared to detect and deal with this + possibility! + + + + + + JACK Operations + + <command>Connect Ports</command> + + Connect a JACK input port to an output port. If the connection was + successfully added, returns: + + + JC output-name + input-name! + + + + + output-name + + + + The name of the JACK output port, in format CLIENTNAME:PORTNAME. + + + + + + input-name + + + + The name of the JACK input port, in format CLIENTNAME:PORTNAME. + + + + + + + + <command>Disconnect Ports</command> + + Disconnect a JACK input port from an output port. If the connection was + successfully removed, returns: + + + JD output-name + input-name! + + + + + output-name + + + + The name of the JACK output port, in format CLIENTNAME:PORTNAME. + + + + + + input-name + + + + The name of the JACK input port, in format CLIENTNAME:PORTNAME. + + + + + + + + + Meter Commands + + <command>Meter Enable</command> + + Set UDP port to whcih to send meter update messages. + + + ME + udp-port! + + + + + udp-port + + + + UDP port number. + + + + + + + + + Meter Status Updates + + The following messages are sent by CAE to indicate current status and + audio levels. They are sent to the UDP port requested by the Meter + Enable ['ME'] command. + + + <command>Port Meter Levels</command> + + Send current meter level of output stream + + + ML + type + card-num + port-num + left-lvl + right-lvl! + + + + + type + + + + Type of meter. + + + + + I + + + + Input + + + + + + O + + + + Output + + + + + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number on the audio adapter. + + + + + + left-lvl + + + + Left channel level, in 100ths of dBFS. + + + + + + right-lvl + + + + Right channel level, in 100ths of dBFS. + + + + + + + + <command>Output Stream Meter Levels</command> + + Send current meter level of output stream + + + MO + card-num + port-num + left-lvl + right-lvl! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number on the audio adapter. + + + + + + left-lvl + + + + Left channel level, in 100ths of dBFS. + + + + + + right-lvl + + + + Right channel level, in 100ths of dBFS. + + + + + + + + <command>Output Stream Position</command> + + Output play position. + + + MP + card-num + stream-num + pos! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + stream-num + + + + The stream number on the audio adapter. + + + + + + pos + + + + The play position in mS. + + + + + + + + <command>Output Stream Status</command> + + The current output stream transport status. + + + MS + card-num + port-num + stream-num + status! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The port number on the audio adapter. + + + + + + stream-num + + + + The stream number on the audio adapter. + + + + + + status + + + + Current transport status. + + + + 0 + + + Stopped + + + + + 1 + + + Playing + + + + + + + + + + +
diff --git a/docs/docbook/web_api.xml b/docs/docbook/web_api.xml new file mode 100644 index 00000000..1a17006b --- /dev/null +++ b/docs/docbook/web_api.xml @@ -0,0 +1,3105 @@ + +
+ + Rivendell Web Interface API + + + Fred + Gleason + fredg@paravelsystems.com + + + + + + Data Types + + Data Types + + + + + + + TYPE + + + DESCRIPTION + + + + + + + DateTime + + + + xs:dateTime format string: + YYYY-MM-DDTHH:MM:SSZ|+HH:MM|-HH:MM + + + If no timezone information is specified, all values will be + assumed to be in the local timezone of the processing system. + + + + + + Date + + + + xs:date format string: + YYYY-MM-DDZ|+HH:MM|-HH:MM + + + If no timezone information is specified, all values will be + assumed to be in the local timezone of the processing system. + + + + + + Time + + + + xs:time format string: + HH:MM:SSZ|+HH:MM|-HH:MM + + + If no timezone information is specified, all values will be + assumed to be in the local timezone of the processing system. + + + + + + String + + + Text data, encoded + + + + +
+ + + + Result Reporting + + Commands that return an error or do not return specialized data types + (e.g. audio data for the Export command) will return an XML document + describing the result of the command, in the following format: + + + +<RDWebResult> + <ResponseCode>resp_code</ResponseCode> + <ErrorString>resp_string</ErrorString> + <AudioConvertError>conv_error_code</AudioConvertError> +</RDWebResult> + + + + + + resp_code + + + + The HTTP result code, as defined in RFC2616 + + + + + + resp_string + + + + A text string describing the result, suitable for displaying in a UI + + + + + + conv_error_code + + + + An extended error code from the audio converter routines. These values + are defined in the RDAudioConvert::ErrorCode enumeration + in lib/rdaudioconvert.h. This parameter is optional. + + + + + + + + AddCart + Add a new cart + + Command Code: RDXPORT_COMMAND_ADDCART + + + Required User Permissions: Create Carts + + + A 403 error will be returned if the requested cart number is + not within the configured range for the specified group and + 'Enforce Cart Range' is set in RDAdmin->ManageGroups. + + + AddCart Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 12 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + GROUP_NAME + + + Name of Group + + + Mandatory + + + + + TYPE + + + Cart type + + + Valid values are "audio" or "macro" + + + + + CART_NUMBER + + + Number of Cart + + + Optional, default is to use next available cart number for + specified group + + + + +
+ + + + AddCut + Add a new cut to an existing cart + + Command Code: RDXPORT_COMMAND_ADDCUT + + + Required User Permissions: Edit Audio + + + A 404 error will be returned if the + requested cart number is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + AddCut Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 10 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + +
+ + + + AssignSchedCode + Assign a scheduler code to an existing cart + + Command Code: RDXPORT_COMMAND_ASSIGNSCHEDCODE + + + Required User Permissions: Modify Carts + + + A 404 error will be returned if the + specified cart number is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + AssignSchedCode Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 25 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CODE + + + Scheduler Code to assign + + + Mandatory + + + + +
+ + + + AudioInfo + Get information about an entry in the audio store + + Command Code: RDXPORT_COMMAND_AUDIOINFO + + + Required User Permissions: none + + + AudioInfo Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 19 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + +
+ + + + AudioStore + Get information about the audio store + + Command Code: RDXPORT_COMMAND_AUDIOSTORE + + + Required User Permissions: none + + + AudioStore Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 23 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + +
+ + + + DeleteAudio + Delete PCM/MPEG data from the audio store + + Command Code: RDXPORT_COMMAND_DELETEAUDIO + + + Required User Permissions: Delete Carts + + + DeleteAudio Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 3 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + +
+ + + + EditCart + + Write metadata changes for an existing cart into the + database + + + Command Code: RDXPORT_COMMAND_EDITCART + + + Required User Permissions: Modify Carts + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms, or + if it is attempted to assign the cart to such a group. + + + A 409 error will be returned if the + requested cart's number falls outside the valid range for the requested + GROUP_NAME. + + + If the tags for an 'optional' field are omitted, then the respective + parameter on the target cart will be left unchanged. + + + EditCart Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 14 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + INCLUDE_CUTS + + + Include cut data in return, 0 = no, 1 = yes + + + Optional, default is 0 + + + + + GROUP_NAME + + + Set Rivendell group + + + Optional + + + + + TITLE + + + Set Title + + + Optional + + + + + ARTIST + + + Set Artist + + + Optional + + + + + ALBUM + + + Set Album + + + Optional + + + + + YEAR + + + Set Year + + + Optional + + + + + LABEL + + + Set Record Label + + + Optional + + + + + CLIENT + + + Set Client + + + Optional + + + + + AGENCY + + + Set Agency + + + Optional + + + + + PUBLISHER + + + Set Publisher + + + Optional + + + + + COMPOSER + + + Set Composer + + + Optional + + + + + USER_DEFINED + + + Set User Defined + + + Optional + + + + + USER_CODE + + + Set User Code + + + Optional + + + + + ENFORCE_LENGTH + + + Set Enforce Length State + + + Optional, Numeric, 0 = No, 1 = Yes + + + + + FORCED_LENGTH + + + Set Forced Length + + + Optional, in milliseconds + + + + + ASYNCHRONOUS + + + Set Asynchronous + + + Optional, Numeric, 0 = No, 1 = Yes + + + + + OWNER + + + Set Owner + + + Optional + + + + + NOTES + + + Set Notes Text + + + Optional + + + + +
+ + + + EditCut + + Write metadata changes for an existing cut into the database + + + Command Code: RDXPORT_COMMAND_EDITCUT + + + Required User Permissions: Edit Audio + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms. + + If the tags for an 'optional' field are omitted, then the respective + parameter on the target cart will be left unchanged. + + + + EditCut Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 15 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + + EVERGREEN + + + Set the Evergreen Falg, valid values are 0 = no, 1 = yes + + + Optional + + + + + DESCRIPTION + + + Set Description + + + Optional + + + + + OUTCUE + + + Set Outcue + + + Optional + + + + + ISRC + + + Set International Standard Recording Code + + + Optional + + + + + ISCI + + + Set Internatinal Standardized Commercial Identifier + + + Optional + + + + + START_DATETIME + + + Set Start Date/Time + + + Optional, RFC-822 format + + + + + END_DATETIME + + + Set End Date/Time + + + Optional, RFC-822 format + + + + + MON + + + Set Monday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + TUE + + + Set Tuesday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + WED + + + Set Wedensday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + THU + + + Set Thursday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + FRI + + + Set Friday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + SAT + + + Set Saturday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + SUN + + + Set Sunday daypart flag + + + Optional, 0 = no, 1 = yes + + + + + START_DAYPART + + + Set Start daypart time + + + Optional, RFC-822 format + + + + + END_DAYPART + + + Set End daypart time + + + Optional, RFC-822 format + + + + + WEIGHT + + + Set rotation weight + + + Optional, numeric + + + + + START_POINT + + + Set Start Marker position + + + Optional, mS from absolute start of audio data + + + + + END_POINT + + + Set End Marker position + + + Optional, mS from absolute start of audio data + + + + + FADEUP_POINT + + + Set Fadeup Marker position + + + Optional, mS from absolute start of audio data + + + + + FADEDOWN_POINT + + + Set Fadedown Marker position + + + Optional, mS from absolute start of audio data + + + + + SEGUE_START_POINT + + + Set Segue Start Marker position + + + Optional, mS from absolute start of audio data + + + + + SEGUE_END_POINT + + + Set Segue End Marker position + + + Optional, mS from absolute start of audio data + + + + + HOOK_START_POINT + + + Set Hook Start Marker position + + + Optional, mS from absolute start of audio data + + + + + HOOK_END_POINT + + + Set Hook End Marker position + + + Optional, mS from absolute start of audio data + + + + + TALK_START_POINT + + + Set Talk Start Marker position + + + Optional, mS from absolute start of audio data + + + + + TALK_END_POINT + + + Set Talk End Marker position + + + Optional, mS from absolute start of audio data + + + + +
+ + + + Export + Export audio data from the audio store + + Command Code: RDXPORT_COMMAND_EXPORT + + + Required User Permissions: none + + + Export Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 1 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + + FORMAT + + + Encoding format of exported data + + + Mandatory, 0 = PCM16 WAV, 2 = MPEG L2 native, 3 = MPEG L3 native, + 4 = FLAC, 5 = OggVorbis, 6 = MPEG L2 WAV, 7 = PCM24 WAV + + + + + CHANNELS + + + Number of audio channels + + + Mandatory + + + + + SAMPLE_RATE + + + Sample rate + + + Mandatory, in samples/sec + + + + + BIT_RATE + + + Bit rate + + + Mandatory, set to '0' for PCM or VBR + + + + + QUALITY + + + Quality Level + + + Mandatory, used only by OggVorbis, set to '0' for others + + + + + START_POINT + + + Start point of audio export + + + Mandatory, mS from absolute start of stored audio + + + + + END_POINT + + + End point of audio export + + + Mandatory, mS from absolute start of stored audio + + + + + NORMALIZATION_LEVEL + + + Normalization leve, in dBFS + + + Mandatory, 0 = No normalization + + + + + ENABLE_METADATA + + + Include metadata in export + + + Mandatory, 0 = no, 1 = yes + + + + +
+ + + + ExportPeaks + Export audio peak data from the audio store + + Command Code: RDXPORT_COMMAND_EXPORT + + + Required User Permissions: none + + + A 404 error will be returned if the + requested cart is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + ExportPeaks Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 16 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + +
+ + + + Import + Import audio data into the audio store + + Command Code: RDXPORT_COMMAND_IMPORT + + + Required User Permissions: Edit Audio + + + A 404 error will be returned if the + requested cart is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + NOTE: The method must be called with 'multipart/form-data' encoding. + + + Import Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 2 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + + CHANNELS + + + Number of audio channels + + + Mandatory + + + + + NORMALIZATION_LEVEL + + + Normalization level, in dBFS + + + Mandatory, 0 = no normalization + + + + + AUTOTRIM_LEVEL + + + Autotrim level, in dBFS + + + Mandatory, 0 = no autotrim + + + + + USE_METADATA + + + Apply source metadata to cart + + + Mandatory, 0 = No, 1 = Yes + + + + + FILENAME + + + Binary file data + + + Mandatory + + + + +
+ + + + ListCart + Return information about a specified cart + + Command Code: RDXPORT_COMMAND_LISTCART + + + Required User Permissions: none + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms. + + + ListCart Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 7 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + INCLUDE_CUTS + + + Include cut information in return + + + Optional, 0 = no, 1 = yes, default is 1 + + + + +
+ + + + ListCarts + Return information about a set of carts + + Command Code: RDXPORT_COMMAND_LISTCARTS + + + Required User Permissions: none + + + Only those carts that belong to groups authorized for the specified + Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms will be returned. + + + ListCarts Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 6 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + GROUP_NAME + + + Limit returns to members of specified group + + + Optional, default is to search all available carts + + + + + INCLUDE_CUTS + + + Include cut information in return + + + Optional, 0 = no, 1 = yes, default is 1 + + + + + FILTER + + + Limit returns to carts containing specified space-separated + keyword(s) + + + Optional, default is to apply no filtering + + + + + TYPE + + + Limit returns to carts of the specified type + + + Optional, valid values are 'audio' or 'macro' + + + + +
+ + + + ListCartSchedCodes + Return information about all scheduler codes assigned to a cart + + Command Code: RDXPORT_COMMAND_LISTCARTSCHEDCODES + + + Required User Permissions: none + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms. + + + ListCartSchedCodes Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 27 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + +
+ + + + ListCut + Return information about a specified cut + + Command Code: RDXPORT_COMMAND_LISTCUT + + + Required User Permissions: none + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms. + + + ListCut Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 8 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of Cut + + + Mandatory + + + + +
+ + + + ListCuts + Return information about all cuts belonging to a cart + + Command Code: RDXPORT_COMMAND_LISTCUTS + + + Required User Permissions: none + + + A 404 error will be returned if the + requested cart belongs to a group that is not authorized for the + specified Rivendell user in RDAdmin->ManageUsers->AssignGroupPerms. + + + ListCuts Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 9 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + +
+ + + + ListGroup + Return information about a specified group + + Command Code: RDXPORT_COMMAND_LISTGROUP + + + Required User Permissions: none + + + A 404 error will be returned if the + requested group is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + ListGroup Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 5 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + GROUP_NAME + + + Name of group + + + Mandatory + + + + +
+ + + + ListGroups + Return information about all available groups + + Command Code: RDXPORT_COMMAND_LISTGROUPS + + + Required User Permissions: none + + + The set of returned groups will be tailored according to what the + specified Rivendell user is authorized to see in + RDAdmin->ManageUsers->AssignGroupPerms. + + + ListGroups Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 4 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + +
+ + + + ListLog + Return a listing of the specified log + + Command Code: RDXPORT_COMMAND_LISTLOG + + + Required User Permissions: none + + + ListLog Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 22 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + NAME + + + The name of the log + + + Mandatory + + + + +
+ + + + ListLogs + Return information about all available logs + + Command Code: RDXPORT_COMMAND_LISTLOGS + + + Required User Permissions: none + + + ListLogs Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 20 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + SERVICE_NAME + + + Limits returns to logs that are owned by specified service + + + Optional. Default is to return all logs. + + + + + TRACKABLE + + + Limits returns to logs that contain one or more voicetrack slots + + + Optional, valid values 0=no, 1=yes. Default is to return all logs + + + + +
+ + + + ListSchedulerCodes + Return information about all available scheduler codes + + Command Code: RDXPORT_COMMAND_LISTSCHEDCODES + + + Required User Permissions: none + + + ListSchedCodes Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 24 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + +
+ + + + ListServices + Return information about all available services + + Command Code: RDXPORT_COMMAND_LISTSERVICES + + + Required User Permissions: none + + + ListServices Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 21 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + TRACKABLE + + + Limits returns to services that have a valid voicetracking + configuration + + + Optional, valid values 0=no, 1=yes. Default is to return all + services + + + + +
+ + + + RemoveCart + Remove a cart from the Library + + Command Code: RDXPORT_COMMAND_REMOVECART + + + Required User Permissions: Delete Cart + + + RemoveCart Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 13 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of cart + + + Mandatory + + + + +
+ + + + RemoveCut + Remove an existing cut from a cart + + Command Code: RDXPORT_COMMAND_REMOVECUT + + + Required User Permissions: Edit Audio + + + RemoveCut Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 11 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of cut + + + Mandatory + + + + +
+ + + + TrimAudio + + Return a time pointer to the first or last instance of a particular + level in a cut. + + + Command Code: RDXPORT_COMMAND_TRIMAUDIO + + + Required User Permissions: Edit Audio + + + A 404 error will be returned if the + requested cart is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + TrimAudio Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 17 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of cart + + + Mandatory + + + + + CUT_NUMBER + + + Number of cut + + + Mandatory + + + + + TRIM_LEVEL + + + Level in 1/100 dB, relative to Rivendell reference level (-16 dBFS) + + + Mandatory + + + + +
+ + + + UnassignSchedCode + Unassign a scheduler code from an existing cart + + Command Code: RDXPORT_COMMAND_UNASSIGNSCHEDCODE + + + Required User Permissions: Modify Carts + + + A 404 error will be returned if the + specified cart number is not authorized for the specified Rivendell user in + RDAdmin->ManageUsers->AssignGroupPerms. + + + UnassignSchedCode Call Fields + + + + + + + + FIELD NAME + + + MEANING + + + REMARKS + + + + + + + COMMAND + + + 26 + + + Mandatory + + + + + LOGIN_NAME + + + Rivendell User Name + + + Mandatory + + + + + PASSWORD + + + Login Password + + + Mandatory + + + + + CART_NUMBER + + + Number of Cart + + + Mandatory + + + + + CODE + + + Scheduler Code to assign + + + Mandatory + + + + +
+ + +
diff --git a/docs/web_api.odt b/docs/web_api.odt deleted file mode 100644 index 23bf8e21..00000000 Binary files a/docs/web_api.odt and /dev/null differ diff --git a/rivendell.spec.in b/rivendell.spec.in index ae2ce103..f538625a 100644 --- a/rivendell.spec.in +++ b/rivendell.spec.in @@ -297,7 +297,6 @@ rm -rf $RPM_BUILD_ROOT %doc conf/rd.conf-sample %doc conf/my.cnf-master %doc conf/my.cnf-standby -%doc docs/cae.sxw %doc docs/catchd.txt %doc docs/colors %doc docs/GPIO.txt @@ -308,6 +307,8 @@ rm -rf $RPM_BUILD_ROOT %doc docs/pam_rd.txt %doc docs/rml.sxw %doc docs/MESSAGE_BOX.txt +%doc docs/docbook/cae.pdf +%doc docs/docbook/web_api.pdf %doc docs/tables/audio_perms.txt %doc docs/tables/audio_ports.txt %doc docs/tables/cart.txt @@ -333,7 +334,6 @@ rm -rf $RPM_BUILD_ROOT %doc docs/tables/users.txt %doc docs/tables/version.txt %doc docs/asound.conf-sample -%doc docs/web_api.odt %doc conf/rlm_serial.conf %doc conf/rlm_udp.conf %doc conf/rlm_twitter.conf