mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2026-01-12 07:35:55 +01:00
2018-09-03 Fred Gleason <fredg@paravelsystems.com>
* Renamed the 'Add Next' ['PX'] RML to 'Insert Cart' ['PX']. * Added an 'offset' parameter to the 'Insert Cart' ['PX'] RML.
This commit is contained in:
Fred Gleason
@@ -20,7 +20,7 @@
|
||||
## Use automake to process this into a Makefile.in
|
||||
|
||||
if DOCBOOK_AM
|
||||
DOCBOOK_AM_OPT = stylesheets apis manpages opsguide
|
||||
DOCBOOK_AM_OPT = stylesheets apis manpages opsguide rivwebcapi
|
||||
endif
|
||||
|
||||
SUBDIRS = $(DOCBOOK_AM_OPT) examples\
|
||||
|
||||
321
docs/rivwebcapi/Makefile.am
Normal file
321
docs/rivwebcapi/Makefile.am
Normal file
@@ -0,0 +1,321 @@
|
||||
## Makefile.am
|
||||
##
|
||||
## docs/rivwebcapi/Makefile.am for Rivendell C API
|
||||
##
|
||||
## (C) Copyright 2015-2018 Fred Gleason <fredg@paravelsystems.com>
|
||||
##
|
||||
## 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 $@
|
||||
|
||||
%.7: %.xml
|
||||
xsltproc $(DOCBOOK_STYLESHEETS)/manpages/docbook.xsl $<
|
||||
|
||||
all-local: rd_addcart.html\
|
||||
rd_addcart.pdf\
|
||||
rd_addcart.xml\
|
||||
rd_addcut.html\
|
||||
rd_addcut.pdf\
|
||||
rd_addcut.xml\
|
||||
rd_addlog.html\
|
||||
rd_addlog.pdf\
|
||||
rd_addlog.xml\
|
||||
rd_assignschedcode.html\
|
||||
rd_assignschedcode.pdf\
|
||||
rd_assignschedcode.xml\
|
||||
rd_audioinfo.html\
|
||||
rd_audioinfo.pdf\
|
||||
rd_audioinfo.xml\
|
||||
rd_audiostore.html\
|
||||
rd_audiostore.pdf\
|
||||
rd_audiostore.xml\
|
||||
clibsummary.xml\
|
||||
clibsummary.html\
|
||||
clibsummary.pdf\
|
||||
rd_copyaudio.html\
|
||||
rd_copyaudio.pdf\
|
||||
rd_copyaudio.xml\
|
||||
rd_createticket.html\
|
||||
rd_createticket.pdf\
|
||||
rd_createticket.xml\
|
||||
rd_deleteaudio.html\
|
||||
rd_deleteaudio.pdf\
|
||||
rd_deleteaudio.xml\
|
||||
rd_deletelog.html\
|
||||
rd_deletelog.pdf\
|
||||
rd_deletelog.xml\
|
||||
rd_editcart.html\
|
||||
rd_editcart.pdf\
|
||||
rd_editcart.xml\
|
||||
rd_editcut.html\
|
||||
rd_editcut.pdf\
|
||||
rd_editcut.xml\
|
||||
rd_exportpeaks.html\
|
||||
rd_exportpeaks.pdf\
|
||||
rd_exportpeaks.xml\
|
||||
rd_export.html\
|
||||
rd_export.pdf\
|
||||
rd_export.xml\
|
||||
rd_getuseragent.html\
|
||||
rd_getuseragent.pdf\
|
||||
rd_getuseragent.xml\
|
||||
rd_getversion.html\
|
||||
rd_getversion.pdf\
|
||||
rd_getversion.xml\
|
||||
rd_import.html\
|
||||
rd_import.pdf\
|
||||
rd_import.xml\
|
||||
rd_listcartschedcodes.html\
|
||||
rd_listcartschedcodes.pdf\
|
||||
rd_listcartschedcodes.xml\
|
||||
rd_listcarts.html\
|
||||
rd_listcarts.pdf\
|
||||
rd_listcarts.xml\
|
||||
rd_listcart.html\
|
||||
rd_listcart.pdf\
|
||||
rd_listcart.xml\
|
||||
rd_listcuts.html\
|
||||
rd_listcuts.pdf\
|
||||
rd_listcuts.xml\
|
||||
rd_listcut.html\
|
||||
rd_listcut.pdf\
|
||||
rd_listcut.xml\
|
||||
rd_listgroups.html\
|
||||
rd_listgroups.pdf\
|
||||
rd_listgroups.xml\
|
||||
rd_listgroup.html\
|
||||
rd_listgroup.pdf\
|
||||
rd_listgroup.xml\
|
||||
rd_listlogs.html\
|
||||
rd_listlogs.pdf\
|
||||
rd_listlogs.xml\
|
||||
rd_listlog.html\
|
||||
rd_listlog.pdf\
|
||||
rd_listlog.xml\
|
||||
rd_listschedcodes.html\
|
||||
rd_listschedcodes.pdf\
|
||||
rd_listschedcodes.xml\
|
||||
rd_listservices.html\
|
||||
rd_listservices.pdf\
|
||||
rd_listservices.xml\
|
||||
rd_listsystemsettings.html\
|
||||
rd_listsystemsettings.pdf\
|
||||
rd_listsystemsettings.xml\
|
||||
rd_removecart.html\
|
||||
rd_removecart.pdf\
|
||||
rd_removecart.xml\
|
||||
rd_removecut.html\
|
||||
rd_removecut.pdf\
|
||||
rd_removecut.xml\
|
||||
rd_savelog.html\
|
||||
rd_savelog.pdf\
|
||||
rd_savelog.xml\
|
||||
rd_trimaudio.html\
|
||||
rd_trimaudio.pdf\
|
||||
rd_trimaudio.xml\
|
||||
rd_unassignschedcode.html\
|
||||
rd_unassignschedcode.pdf\
|
||||
rd_unassignschedcode.xml
|
||||
|
||||
man_MANS = rd_addcart.7\
|
||||
rd_addcut.7\
|
||||
rd_addlog.7\
|
||||
rd_assignschedcode.7\
|
||||
rd_audioinfo.7\
|
||||
rd_audiostore.7\
|
||||
rd_copyaudio.7\
|
||||
rd_createticket.7\
|
||||
rd_deleteaudio.7\
|
||||
rd_deletelog.7\
|
||||
rd_editcart.7\
|
||||
rd_editcut.7\
|
||||
rd_exportpeaks.7\
|
||||
rd_export.7\
|
||||
rd_getuseragent.7\
|
||||
rd_getversion.7\
|
||||
rd_import.7\
|
||||
rd_listcartschedcodes.7\
|
||||
rd_listcarts.7\
|
||||
rd_listcart.7\
|
||||
rd_listcuts.7\
|
||||
rd_listcut.7\
|
||||
rd_listgroups.7\
|
||||
rd_listgroup.7\
|
||||
rd_listlogs.7\
|
||||
rd_listlog.7\
|
||||
rd_listschedcodes.7\
|
||||
rd_listservices.7\
|
||||
rd_listsystemsettings.7\
|
||||
rd_removecart.7\
|
||||
rd_removecut.7\
|
||||
rd_savelog.7\
|
||||
rd_trimaudio.7\
|
||||
rd_unassignschedcode.7
|
||||
|
||||
EXTRA_DIST = rd_addcart.7\
|
||||
rd_addcart.html\
|
||||
rd_addcart.pdf\
|
||||
rd_addcart.xml\
|
||||
rd_addcut.7\
|
||||
rd_addcut.html\
|
||||
rd_addcut.pdf\
|
||||
rd_addcut.xml\
|
||||
rd_addlog.7\
|
||||
rd_addlog.html\
|
||||
rd_addlog.pdf\
|
||||
rd_addlog.xml\
|
||||
rd_assignschedcode.7\
|
||||
rd_assignschedcode.html\
|
||||
rd_assignschedcode.pdf\
|
||||
rd_assignschedcode.xml\
|
||||
rd_audioinfo.7\
|
||||
rd_audioinfo.html\
|
||||
rd_audioinfo.pdf\
|
||||
rd_audioinfo.xml\
|
||||
rd_audiostore.7\
|
||||
rd_audiostore.html\
|
||||
rd_audiostore.pdf\
|
||||
rd_audiostore.xml\
|
||||
clibsummary.xml\
|
||||
clibsummary.html\
|
||||
clibsummary.pdf\
|
||||
rd_copyaudio.7\
|
||||
rd_copyaudio.html\
|
||||
rd_copyaudio.pdf\
|
||||
rd_copyaudio.xml\
|
||||
rd_createticket.html\
|
||||
rd_createticket.pdf\
|
||||
rd_createticket.xml\
|
||||
rd_deleteaudio.7\
|
||||
rd_deleteaudio.html\
|
||||
rd_deleteaudio.pdf\
|
||||
rd_deleteaudio.xml\
|
||||
rd_deletelog.7\
|
||||
rd_deletelog.html\
|
||||
rd_deletelog.pdf\
|
||||
rd_deletelog.xml\
|
||||
rd_editcart.7\
|
||||
rd_editcart.html\
|
||||
rd_editcart.pdf\
|
||||
rd_editcart.xml\
|
||||
rd_editcut.7\
|
||||
rd_editcut.html\
|
||||
rd_editcut.pdf\
|
||||
rd_editcut.xml\
|
||||
rd_exportpeaks.7\
|
||||
rd_exportpeaks.html\
|
||||
rd_exportpeaks.pdf\
|
||||
rd_exportpeaks.xml\
|
||||
rd_export.7\
|
||||
rd_export.html\
|
||||
rd_export.pdf\
|
||||
rd_export.xml\
|
||||
rd_getuseragent.7\
|
||||
rd_getuseragent.html\
|
||||
rd_getuseragent.pdf\
|
||||
rd_getuseragent.xml\
|
||||
rd_getversion.7\
|
||||
rd_getversion.html\
|
||||
rd_getversion.pdf\
|
||||
rd_getversion.xml\
|
||||
rd_import.7\
|
||||
rd_import.html\
|
||||
rd_import.pdf\
|
||||
rd_import.xml\
|
||||
rd_listcartschedcodes.7\
|
||||
rd_listcartschedcodes.html\
|
||||
rd_listcartschedcodes.pdf\
|
||||
rd_listcartschedcodes.xml\
|
||||
rd_listcarts.7\
|
||||
rd_listcarts.html\
|
||||
rd_listcarts.pdf\
|
||||
rd_listcarts.xml\
|
||||
rd_listcart.7\
|
||||
rd_listcart.html\
|
||||
rd_listcart.pdf\
|
||||
rd_listcart.xml\
|
||||
rd_listcuts.7\
|
||||
rd_listcuts.html\
|
||||
rd_listcuts.pdf\
|
||||
rd_listcuts.xml\
|
||||
rd_listcut.7\
|
||||
rd_listcut.html\
|
||||
rd_listcut.pdf\
|
||||
rd_listcut.xml\
|
||||
rd_listgroups.7\
|
||||
rd_listgroups.html\
|
||||
rd_listgroups.pdf\
|
||||
rd_listgroups.xml\
|
||||
rd_listgroup.7\
|
||||
rd_listgroup.html\
|
||||
rd_listgroup.pdf\
|
||||
rd_listgroup.xml\
|
||||
rd_listlogs.7\
|
||||
rd_listlogs.html\
|
||||
rd_listlogs.pdf\
|
||||
rd_listlogs.xml\
|
||||
rd_listlog.7\
|
||||
rd_listlog.html\
|
||||
rd_listlog.pdf\
|
||||
rd_listlog.xml\
|
||||
rd_listschedcodes.7\
|
||||
rd_listschedcodes.html\
|
||||
rd_listschedcodes.pdf\
|
||||
rd_listschedcodes.xml\
|
||||
rd_listservices.7\
|
||||
rd_listservices.html\
|
||||
rd_listservices.pdf\
|
||||
rd_listservices.xml\
|
||||
rd_listsystemsettings.7\
|
||||
rd_listsystemsettings.html\
|
||||
rd_listsystemsettings.pdf\
|
||||
rd_listsystemsettings.xml\
|
||||
rd_removecart.7\
|
||||
rd_removecart.html\
|
||||
rd_removecart.pdf\
|
||||
rd_removecart.xml\
|
||||
rd_removecut.7\
|
||||
rd_removecut.html\
|
||||
rd_removecut.pdf\
|
||||
rd_removecut.xml\
|
||||
rd_savelog.7\
|
||||
rd_savelog.html\
|
||||
rd_savelog.pdf\
|
||||
rd_savelog.xml\
|
||||
rd_trimaudio.7\
|
||||
rd_trimaudio.html\
|
||||
rd_trimaudio.pdf\
|
||||
rd_trimaudio.xml\
|
||||
rd_unassignschedcode.7\
|
||||
rd_unassignschedcode.html\
|
||||
rd_unassignschedcode.pdf\
|
||||
rd_unassignschedcode.xml
|
||||
|
||||
CLEANFILES = *~
|
||||
MAINTAINERCLEANFILES = *~\
|
||||
*.7\
|
||||
*.html\
|
||||
*.pdf\
|
||||
aclocal.m4\
|
||||
configure\
|
||||
Makefile.in
|
||||
117
docs/rivwebcapi/clibsummary.xml
Normal file
117
docs/rivwebcapi/clibsummary.xml
Normal file
@@ -0,0 +1,117 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<article xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<info>
|
||||
<title>Rivendell C Library API</title>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<para>
|
||||
This is a C Library that can be used to access and query the Rivendell database. These functions
|
||||
allow the programmer to access the Rivendell Web API components directly, and provides
|
||||
almost complete
|
||||
functionality in relation to content in an existing Rivendell system. See function
|
||||
descriptions for further information on using these functions below.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Function Descriptions</title>
|
||||
<para>
|
||||
<command>RD_AudioInfo</command> This function returns
|
||||
information about an entry in the audio store.
|
||||
</para>
|
||||
<para><command>RD_AddCart</command> This function
|
||||
adds a cart to a Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_AddCut</command> This function
|
||||
adds a cut to a Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_AssignSchedCode</command> This function
|
||||
assigns a Scheduler Code to carts in a Rivendell database.
|
||||
</para>
|
||||
<para><command>RD_AudioStore</command> This function
|
||||
returns information about the audio store.
|
||||
</para>
|
||||
<para><command>RD_CopyAudio</command> This function
|
||||
copys PCM/MPEG data from one Cart/Cut to another Cart/Cut.
|
||||
</para>
|
||||
<para><command>RD_CreateTicket</command> This function
|
||||
will create an Authentification ticket in the Rivendell database
|
||||
that can be used in leu of username/password pair.
|
||||
</para>
|
||||
<para><command>RD_DeleteAudio</command> This function
|
||||
deletes PCM/MPEG data from the audio store.
|
||||
</para>
|
||||
<para><command>RD_EditCart</command> This function
|
||||
edits the fields within a cart in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_EditCut</command> This function
|
||||
edit the fields within a cut in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_Export</command> This function
|
||||
exports PCM/MPEG data from the audio store.
|
||||
</para>
|
||||
<para><command>RD_ExportPeaks</command> This function
|
||||
exports Peak Data from the audio store.
|
||||
</para>
|
||||
<para><command>RD_Import</command> This function
|
||||
imports PCM/MPEG data into the audio store.
|
||||
</para>
|
||||
<para><command>RD_ListCart</command> This function
|
||||
lists the fields within a cart in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListCarts</command> This function
|
||||
lists the carts in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListCartSchedCodes</command> This function
|
||||
lists the Scheduler Codes assigned to a cart in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListCut</command> This function
|
||||
lists the fields within a cut in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListCuts</command> This function
|
||||
lists the cuts that exist in a Cart entry.
|
||||
</para>
|
||||
<para><command>RD_ListGroup</command> This function
|
||||
lists the group field entries for a specific group in the Rivendell database.
|
||||
</para>
|
||||
<para><command>RD_ListGroups</command> This function
|
||||
lists the groups within the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListLog</command> This function
|
||||
lists the log lines for a particular log file within the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListLogs</command> This function
|
||||
lists the Log Files within the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListSchedCodes</command> This function
|
||||
lists the Scheduler Codes that currently exist in the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListServices</command> This function
|
||||
lists the Servicess that are stored within the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_ListSystemSettings</command> This function
|
||||
lists the System Settings that are stored within the Rivendell Database.
|
||||
</para>
|
||||
<para><command>RD_RemoveCart</command> This function
|
||||
removes a cart from the Rivendell database.
|
||||
</para>
|
||||
<para><command>RD_RemoveCut</command> This function
|
||||
removes a cut from the Rivendell database.
|
||||
</para>
|
||||
<para><command>RD_TrimAudio</command> This function
|
||||
returns a time pointer to the first and last instance of a particular dB level in a cut.
|
||||
</para>
|
||||
<para><command>RD_UnassignSchedCode</command> This function
|
||||
unassigns a Scheduler Code from a cart in the Rivendell database.
|
||||
</para>
|
||||
</section>
|
||||
</article>
|
||||
354
docs/rivwebcapi/rd_addcart.xml
Normal file
354
docs/rivwebcapi/rd_addcart.xml
Normal file
@@ -0,0 +1,354 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AddCart</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_addcart</refname>
|
||||
<refpurpose>Rivendell Add Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_addcart.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AddCart</function></funcdef>
|
||||
<paramdef> struct rd_cart * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>group[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>type[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AddCart</command> is the function to use
|
||||
to add a cart to an existing Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function adds the cart number to the Rivendell database on hostname. Default values are used when the cart is created.
|
||||
</para>
|
||||
<table xml:id="ex.addcart" frame="all">
|
||||
<title>RD_AddCart function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_cart
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cart structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cart information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
group
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Group Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
type
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Type
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
|
||||
is stored in the provided memory locations. The rd_cart structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cart {
|
||||
unsigned cart_number; /* Cart Number */
|
||||
unsigned cart_type; /* Cart Type */
|
||||
char cart_grp_name[11]; /* Group Name */
|
||||
char cart_title[256]; /* Cart Title */
|
||||
char cart_artist[256]; /* Artist */
|
||||
char cart_album[256]; /* Album */
|
||||
int cart_year; /* Year */
|
||||
char cart_label[65]; /* Label */
|
||||
char cart_client[65]; /* Client */
|
||||
char cart_agency[65]; /* Agency */
|
||||
char cart_publisher[65]; /* Publisher */
|
||||
char cart_composer[65]; /* Composer */
|
||||
char cart_user_defined[256]; /* User Defined */
|
||||
int cart_usage_code; /* Usage Code */
|
||||
int cart_forced_length; /* Forced Length */
|
||||
int cart_average_length; /* AverageLength */
|
||||
int cart_length_deviation; /* Length Deviation */
|
||||
int cart_average_segue_length; /* Average Segue Length */
|
||||
int cart_average_hook_length; /* Average Hook Length */
|
||||
unsigned cart_cut_quantity; /* Cut Quantity */
|
||||
unsigned cart_last_cut_played; /* Last Cut Played */
|
||||
unsigned cart_validity; /* Validity */
|
||||
int cart_enforce_length; /* Enforce Length Flag */
|
||||
int cart_asyncronous; /* Asyncronous Flag */
|
||||
char cart_owner[65]; /* Owner */
|
||||
struct tm cart_metadata_datetime; /* Metadata Datetime */
|
||||
char cart_notes[1024]; /* Notes */
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and are null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The cart_type is 1=Audio,2=Macro. The default is Audio(1).
|
||||
|
||||
The cart_grp_name must be a valid Rivendell DB Group.
|
||||
|
||||
The cart_title is 255 characters Default is [new cart].
|
||||
|
||||
The cart_artist is 255 characters. Default is NULL.
|
||||
|
||||
The cart_album is 255 characters. Default is NULL.
|
||||
|
||||
The cart_year is a date (YYYY). Default is NULL.
|
||||
|
||||
The cart_label is 64 characters. Default is NULL.
|
||||
|
||||
The cart_client is 64 characters. Default is NULL.
|
||||
|
||||
The cart_agency is 64 characters. Default is NULL.
|
||||
|
||||
The cart_publisher is 64 characters. Default is NULL.
|
||||
|
||||
The cart_composer is 64 characters. Default is NULL.
|
||||
|
||||
The cart_user_defined is 255 characters. Default is NULL.
|
||||
|
||||
The cart_usage_code is 0=Feature (Default), 1=Theme Open,
|
||||
2=Theme Close, 3=Theme Open/Close,
|
||||
4=Background, 5=Comm/Promo
|
||||
|
||||
The cart_forced_length is in milliseconds. Default is 0.
|
||||
|
||||
The cart_average_length is in milliseconds. Default is 0.
|
||||
|
||||
The cart_length_deviation is in milliseconds. Default is 0.
|
||||
|
||||
The cart_average_segue_length is in milliseconds. Default is 0.
|
||||
|
||||
The cart_average_hook_length is in milliseconds. Default is 0.
|
||||
|
||||
The cart_cut_quantity is number of cuts. Default is 0.
|
||||
|
||||
The cart_last_cut_played is self explanatory. Default is 0.
|
||||
|
||||
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid (Default)
|
||||
3=EvergreenValid, 4=FutureValid
|
||||
|
||||
The cart_enforce_length is True(1) or False(0). Default is False(0).
|
||||
|
||||
The cart_asyncronous is True(1) or False(0). Default is False(0).
|
||||
|
||||
The cart_owner is 64 characters. Default is NULL.
|
||||
|
||||
The cart_metadata_datetime is in tm struct format. Default is NULL.
|
||||
|
||||
The cart_user_notes is a character array up to 1024 characters. Default is NULL
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cart
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid Parameter for GROUP or TYPE.
|
||||
</para>
|
||||
<para>
|
||||
400 Cart Already Exists.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Group Exists or Cart Out Of Range.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to Create Cart.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
278
docs/rivwebcapi/rd_addcut.xml
Normal file
278
docs/rivwebcapi/rd_addcut.xml
Normal file
@@ -0,0 +1,278 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AddCut</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_addcut</refname>
|
||||
<refpurpose>Rivendell Add Cut C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_addcut.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AddCut</function></funcdef>
|
||||
<paramdef> struct rd_cut * <parameter>cut[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AddCut</command> is the function to use
|
||||
to add a cut to an existing Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function adds a cut to the cart number entered into the Rivendell database on hostname. The cut will be created with default values listed below.
|
||||
</para>
|
||||
<table xml:id="ex.addcut" frame="all">
|
||||
<title>RD_AddCut function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_cut
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cut structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cut information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
|
||||
is stored in the provided memory locations. The rd_cut structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cut {
|
||||
char cut_name[11]; /* Default is: CART###_CUT### */
|
||||
unsigned cut_cart_number; /* Cart Number */
|
||||
unsigned cut_cut_number; /* Next available Cut Number */
|
||||
int cut_evergreen; /* Default is: False */
|
||||
char cut_description[65]; /* Defualt is: Cut ### */
|
||||
char cut_outcue[65]; /* Default is: NULL */
|
||||
char cut_isrc[13]; /* Default is: NULL */
|
||||
char cut_isci[33]; /* Default is: NULL */
|
||||
unsigned cut_length; /* Default is: 0 */
|
||||
struct tm cut_origin_datetime; /* Default is: NULL */
|
||||
struct tm cut_start_datetime; /* Default is: NULL */
|
||||
struct tm cut_end_datetime; /* Default is: NULL */
|
||||
int cut_sun; /* Default is: true */
|
||||
int cut_mon; /* Default is: true */
|
||||
int cut_tue; /* Default is: true */
|
||||
int cut_wed; /* Default is: true */
|
||||
int cut_thu; /* Default is: true */
|
||||
int cut_fri; /* Default is: true */
|
||||
int cut_sat; /* Default is: true */
|
||||
char cut_start_daypart[14]; /* Default is: NULL */
|
||||
char cut_end_daypart[14]; /* Default is: NULL */
|
||||
char cut_origin_name[65]; /* Default is: NULL */
|
||||
unsigned cut_weight; /* Default is: 1 */
|
||||
struct tm cut_last_play_datetime; /* Default is: NULL */
|
||||
unsigned cut_play_counter; /* Default is: 0 */
|
||||
unsigned cut_local_counter; /* Default is: 0 */
|
||||
unsigned cut_validity; /* Default is: 0 */
|
||||
unsigned cut_coding_format; /* Default is: 0 */
|
||||
unsigned cut_sample_rate; /* Default is: 0 */
|
||||
unsigned cut_bit_rate; /* Default is: 0 */
|
||||
unsigned cut_channels; /* Default is: 2 */
|
||||
int cut_play_gain; /* Default is: 0 */
|
||||
int cut_start_point; /* Default is: -1 */
|
||||
int cut_end_point; /* Default is: -1 */
|
||||
int cut_fadeup_point; /* Default is: -1 */
|
||||
int cut_fadedown_point; /* Default is: -1 */
|
||||
int cut_segue_start_point; /* Default is: -1 */
|
||||
int cut_segue_end_point; /* Default is: -1 */
|
||||
int cut_segue_gain; /* Default is: -3000 */
|
||||
int cut_hook_start_point; /* Default is: -1 */
|
||||
int cut_hook_end_point; /* Default is: -1 */
|
||||
int cut_talk_start_point; /* Default is: -1 */
|
||||
int cut_talk_end_point; /* Default is: -1 */
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cut
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Numer.
|
||||
</para>
|
||||
<para>
|
||||
403 Invalid User Authentification.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists or Invalid Permissions.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to Create Cut - No New Cuts.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
208
docs/rivwebcapi/rd_addlog.xml
Normal file
208
docs/rivwebcapi/rd_addlog.xml
Normal file
@@ -0,0 +1,208 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AddLog</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>January 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_addlog</refname>
|
||||
<refpurpose>Rivendell Add Log C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_addlog.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AddLog</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>log_name[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>svc_name[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AddLog</command> is the function to use
|
||||
to add a log to an existing Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function adds the specified log to the Rivendell database on hostname. Default values are used when the log is created.
|
||||
</para>
|
||||
<table xml:id="ex.addlog" frame="all">
|
||||
<title>RD_AddLog function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
log_name
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name to assign to new log
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
svc_name
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name of the Rivendell Service to own the new log
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid/Missing Parameter for LOG_NAME or SVC_NAME.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 User Permission Error or Invalid Service.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to Create Log.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
208
docs/rivwebcapi/rd_assignschedcode.xml
Normal file
208
docs/rivwebcapi/rd_assignschedcode.xml
Normal file
@@ -0,0 +1,208 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AssignSchedCode</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_assignschedcode</refname>
|
||||
<refpurpose>Rivendell Assign Scheduler Code to Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_assignschedcode.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AssignSchedCode</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>code[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AssignSchedCode</command> is the function to use
|
||||
to assign a Scheduler Code to a cart in the Rivendell database.
|
||||
</para>
|
||||
<table xml:id="ex.assignschedcode" frame="all">
|
||||
<title>RD_AssignSchedCode function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
code
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Scheduler Code to Assign
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='permissions'><title>Required User Permissions</title>
|
||||
<para>
|
||||
Modify Carts
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart/Code.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
257
docs/rivwebcapi/rd_audioinfo.xml
Normal file
257
docs/rivwebcapi/rd_audioinfo.xml
Normal file
@@ -0,0 +1,257 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AudioInfo</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_audioinfo</refname>
|
||||
<refpurpose>Rivendell Audio Info C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_audioinfo.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AudioInfo</function></funcdef>
|
||||
<paramdef> struct rd_audioinfo * <parameter>audioinfo[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AudioInfo</command> is the function to use
|
||||
to get information about an entry in the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.audioinfo" frame="all">
|
||||
<title>RD_AudioInfo function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_audioinfo
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_audioinfo structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store specific audioinfo data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_audioinfo structure which
|
||||
is stored in the provided memory locations. The rd_audioinfo structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_audioinfo {
|
||||
unsigned cart_number; /* Cart Number */
|
||||
unsigned cut_number; /* Cut Number */
|
||||
int format;
|
||||
int channels;
|
||||
int samplerate;
|
||||
unsigned frames;
|
||||
unsigned length;
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_audioinfo
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number/Cut Number.
|
||||
</para>
|
||||
<para>
|
||||
400 Unknown Audio Format.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Audio Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
213
docs/rivwebcapi/rd_audiostore.xml
Normal file
213
docs/rivwebcapi/rd_audiostore.xml
Normal file
@@ -0,0 +1,213 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_AudioStore</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_audiostore</refname>
|
||||
<refpurpose>Rivendell Audio Store C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_audiostore.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_AudioStore</function></funcdef>
|
||||
<paramdef> struct rd_audiostore * <parameter>audiostore[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_AudioStore</command> is the function to use
|
||||
to get information about the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.audiostore" frame="all">
|
||||
<title>RD_AudioStore function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_audiostore
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_audiostore structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store specific audiostore data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_audiostore structure which
|
||||
is stored in the provided memory locations. The rd_audiostore structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_audiostore {
|
||||
long unsigned freebytes;
|
||||
long unsigned totalbytes;
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_audioinfo
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Internal Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
236
docs/rivwebcapi/rd_copyaudio.xml
Normal file
236
docs/rivwebcapi/rd_copyaudio.xml
Normal file
@@ -0,0 +1,236 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_CopyAudio</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_copyaudio</refname>
|
||||
<refpurpose>Rivendell Audio Store C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_copyaudio.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_CopyAudio</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>src_cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>src_cutnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>dest_cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>dest_cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_CopyAudio</command> is the function to use
|
||||
to copy PCM/MPEG data from one Source Cart/Cut to a Destination Cart/Cut.
|
||||
</para>
|
||||
<table xml:id="ex.copyaudio" frame="all">
|
||||
<title>RD_CopyAudio function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
src_cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Source Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
src_cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Source Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
dest_cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Destination Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
dest_cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Destination Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
400 Could Not Link Cart/Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
195
docs/rivwebcapi/rd_createticket.xml
Normal file
195
docs/rivwebcapi/rd_createticket.xml
Normal file
@@ -0,0 +1,195 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_CreateTicket</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>March 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_createticket</refname>
|
||||
<refpurpose>Rivendell Create Ticket C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_createticket.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_CreateTicket</function></funcdef>
|
||||
<paramdef> struct rd_ticketinfo * <parameter>ticketinfo[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_CreateTicket</command> is the function to use
|
||||
to create a Authentification Ticket within the Rivendell Database.
|
||||
</para>
|
||||
<table xml:id="ex.audioinfo" frame="all">
|
||||
<title>RD_CreateTicket function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_audioinfo
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_ticketinfo structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store specific ticketinfo data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_ticketinfo structure which
|
||||
is stored in the provided memory locations. The rd_ticketinfo structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_ticketinfo {
|
||||
char ticket[40];
|
||||
struct tm tkt_expiration_datetime;
|
||||
}
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_ticketinfo
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
203
docs/rivwebcapi/rd_deleteaudio.xml
Normal file
203
docs/rivwebcapi/rd_deleteaudio.xml
Normal file
@@ -0,0 +1,203 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_DeleteAudio</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_deleteaudio</refname>
|
||||
<refpurpose>Rivendell Audio Store C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_deleteaudio.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_DeleteAudio</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_DeleteAudio</command> is the function to use
|
||||
to delete PCM/MPEG data from the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.deleteaudio" frame="all">
|
||||
<title>RD_DeleteAudio function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cut or Invalid Permissions.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
193
docs/rivwebcapi/rd_deletelog.xml
Normal file
193
docs/rivwebcapi/rd_deletelog.xml
Normal file
@@ -0,0 +1,193 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_DeleteLog</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>January 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_deletelog</refname>
|
||||
<refpurpose>Rivendell Delete Log C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_deletelog.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_DeleteLog</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>log_name[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_DeleteLog</command> is the function to use
|
||||
to delete a log from an existing Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function deletes the specified log from the Rivendell database on hostname.
|
||||
</para>
|
||||
<table xml:id="ex.deletelog" frame="all">
|
||||
<title>RD_DeleteLog function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
log_name
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name of log to delete
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid/Missing Parameter for LOG_NAME.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 User Permissions Error.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to Delete Log.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
389
docs/rivwebcapi/rd_editcart.xml
Normal file
389
docs/rivwebcapi/rd_editcart.xml
Normal file
@@ -0,0 +1,389 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_EditCart</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_editcart</refname>
|
||||
<refpurpose>Rivendell Edit Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_editcart.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_EditCart</function></funcdef>
|
||||
<paramdef> struct rd_cart * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef> struct edit_cart_values <parameter>edit_cart_values</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_EditCart</command> is the function to use
|
||||
to edit the fields within a cart that already exists in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function edits a pre-existing cart. User must provide the cart number and any fields which they would like to change. The structure edit_cart_values must be used to tell the API which fields will be changed.
|
||||
</para>
|
||||
<table xml:id="ex.editcart" frame="all">
|
||||
<title>RD_EditCart function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_cart
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cart structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cart information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
edit_cart_values
|
||||
</entry>
|
||||
<entry>
|
||||
edit_cart_values structure
|
||||
</entry>
|
||||
<entry>
|
||||
This structure contains the new cart information to update
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
This routine expects an input structure of type edit_cart_values - listed below.
|
||||
Each field has a boolean flag field (starting with use_) which designates whether
|
||||
to update the field's value or not. One (1) = true - Use the value in the field or
|
||||
Zero (0) - Ignore the field.
|
||||
</para>
|
||||
<para>
|
||||
The edit_cart_values structure must be pre-filled with zeroes and has
|
||||
the following format:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct edit_cart_values {
|
||||
char cart_grp_name[11];
|
||||
int use_cart_grp_name;
|
||||
char cart_title[256];
|
||||
int use_cart_title;
|
||||
char cart_artist[256];
|
||||
int use_cart_artist;
|
||||
char cart_album[256];
|
||||
int use_cart_album;
|
||||
int cart_year;
|
||||
int use_cart_year;
|
||||
char cart_label[65];
|
||||
int use_cart_label;
|
||||
char cart_client[65];
|
||||
int use_cart_client;
|
||||
char cart_agency[65];
|
||||
int use_cart_agency;
|
||||
char cart_publisher[65];
|
||||
int use_cart_publisher;
|
||||
char cart_composer[65];
|
||||
int use_cart_composer;
|
||||
char cart_conductor[65];
|
||||
int use_cart_conductor;
|
||||
char cart_user_defined[256];
|
||||
int use_cart_user_defined;
|
||||
int cart_usage_code;
|
||||
int use_cart_usage_code;
|
||||
int cart_forced_length;
|
||||
int use_cart_forced_length;
|
||||
int cart_enforce_length;
|
||||
int use_cart_enforce_length;
|
||||
int cart_asyncronous;
|
||||
int use_cart_asyncronous;
|
||||
char cart_owner[65];
|
||||
int use_cart_owner;
|
||||
char cart_notes[1024];
|
||||
int use_cart_notes;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
|
||||
is stored in the provided memory locations. The rd_cart structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cart {
|
||||
unsigned cart_number; /* Cart Number */
|
||||
unsigned cart_type; /* Cart Type */
|
||||
char cart_grp_name[11]; /* Group Name */
|
||||
char cart_title[256]; /* Cart Title */
|
||||
char cart_artist[256]; /* Artist */
|
||||
char cart_album[256]; /* Album */
|
||||
int cart_year; /* Year */
|
||||
char cart_label[65]; /* Label */
|
||||
char cart_client[65]; /* Client */
|
||||
char cart_agency[65]; /* Agency */
|
||||
char cart_publisher[65]; /* Publisher */
|
||||
char cart_composer[65]; /* Composer */
|
||||
char cart_conductor[65]; /* Conductor */
|
||||
char cart_user_defined[256]; /* User Defined */
|
||||
int cart_usage_code; /* Usage Code */
|
||||
int cart_forced_length; /* Forced Length */
|
||||
int cart_average_length; /* AverageLength */
|
||||
int cart_length_deviation; /* Length Deviation */
|
||||
int cart_average_segue_length; /* Average Segue Length */
|
||||
int cart_average_hook_length; /* Average Hook Length */
|
||||
unsigned cart_cut_quantity; /* Cut Quantity */
|
||||
unsigned cart_last_cut_played; /* Last Cut Played */
|
||||
unsigned cart_validity; /* Validity */
|
||||
int cart_enforce_length; /* Enforce Length Flag */
|
||||
int cart_asyncronous; /* Asyncronous Flag */
|
||||
char cart_owner[65]; /* Owner */
|
||||
char cart_notes[1024]; /* Notes */
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and are null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The cart_type is 1=Audio,2=Macro.
|
||||
|
||||
The cart_grp_name must be a valid Rivendell DB Group.
|
||||
|
||||
The cart_title is 255 characters.
|
||||
|
||||
The cart_artist is 255 characters.
|
||||
|
||||
The cart_album is 255 characters.
|
||||
|
||||
The cart_year is a date (YYYY).
|
||||
|
||||
The cart_label is 64 characters.
|
||||
|
||||
The cart_client is 64 characters.
|
||||
|
||||
The cart_agency is 64 characters.
|
||||
|
||||
The cart_publisher is 64 characters.
|
||||
|
||||
The cart_composer is 64 characters.
|
||||
|
||||
The cart_conductor is 64 characters.
|
||||
|
||||
The cart_user_defined is 255 characters.
|
||||
|
||||
The cart_usage_code is 0=Feature, 1=Theme Open,
|
||||
2=Theme Close, 3=Theme Open/Close,
|
||||
4=Background, 5=Comm/Promo
|
||||
|
||||
The cart_forced_length is in milliseconds.
|
||||
|
||||
The cart_average_length is in milliseconds.
|
||||
|
||||
The cart_length_deviation is in milliseconds.
|
||||
|
||||
The cart_average_segue_length is in milliseconds.
|
||||
|
||||
The cart_average_hook_length is in milliseconds.
|
||||
|
||||
The cart_cut_quantity is number of cuts.
|
||||
|
||||
The cart_last_cut_played is self explanatory.
|
||||
|
||||
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid
|
||||
3=EvergreenValid, 4=FutureValid
|
||||
|
||||
The cart_enforce_length is True(1) or False(0).
|
||||
|
||||
The cart_asyncronous is True(1) or False(0).
|
||||
|
||||
The cart_owner is 64 characters.
|
||||
|
||||
The cart_user_notes is a character array up to 1024 characters.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cart
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid Input Parameter.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Unauthorized or No Such Group / Cart Exists.
|
||||
</para>
|
||||
<para>
|
||||
409 Cart Out Of Range.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to Create Cart.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
393
docs/rivwebcapi/rd_editcut.xml
Normal file
393
docs/rivwebcapi/rd_editcut.xml
Normal file
@@ -0,0 +1,393 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_EditCut</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_editcut</refname>
|
||||
<refpurpose>Rivendell Edit Cut C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_editcut.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_EditCut</function></funcdef>
|
||||
<paramdef> struct rd_cut * <parameter>cut[]</parameter></paramdef>
|
||||
<paramdef> struct edit_cut_values <parameter>edit_cut_values</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_EditCut</command> is the function to use
|
||||
to edit the fields within a cut that already exists in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function edits a pre-existing cut. User must provide the cart number, cut number and any fields which they would like to change. The structure edit_cut_values must be used to tell the API which fields will be changed.
|
||||
</para>
|
||||
<table xml:id="ex.editcart" frame="all">
|
||||
<title>RD_EditCart function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_cut
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cut structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cut information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
edit_cut_values
|
||||
</entry>
|
||||
<entry>
|
||||
edit_cut_values structure
|
||||
</entry>
|
||||
<entry>
|
||||
This structure contains the new cut information to update
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
This routine expects an input structure of type edit_cut_values - listed below.
|
||||
Each field has a boolean flag field (starting with use_) which designates whether
|
||||
to update the field's value or not. One (1) = true - Use the value in the field or
|
||||
Zero (0) - Ignore the field.
|
||||
</para>
|
||||
<para>
|
||||
The edit_cut_values structure must be pre-filled with zeroes and has
|
||||
the following format:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct edit_cut_values {
|
||||
int cut_evergreen;
|
||||
int use_cut_evergreen;
|
||||
char cut_description[65];
|
||||
int use_cut_description;
|
||||
char cut_outcue[65];
|
||||
int use_cut_outcue;
|
||||
char cut_isrc[13];
|
||||
int use_cut_isrc;
|
||||
char cut_isci[33];
|
||||
int use_cut_isci;
|
||||
struct tm cut_start_datetime;
|
||||
int use_cut_start_datetime;
|
||||
struct tm cut_end_datetime;
|
||||
int use_cut_end_datetime;
|
||||
int cut_sun;
|
||||
int use_cut_sun;
|
||||
int cut_mon;
|
||||
int use_cut_mon;
|
||||
int cut_tue;
|
||||
int use_cut_tue;
|
||||
int cut_wed;
|
||||
int use_cut_wed;
|
||||
int cut_thu;
|
||||
int use_cut_thu;
|
||||
int cut_fri;
|
||||
int use_cut_fri;
|
||||
int cut_sat;
|
||||
int use_cut_sat;
|
||||
char cut_start_daypart[14];
|
||||
int use_cut_start_daypart;
|
||||
char cut_end_daypart[14];
|
||||
int use_cut_end_daypart;
|
||||
unsigned cut_weight;
|
||||
int use_cut_weight;
|
||||
unsigned cut_validity;
|
||||
int use_cut_validity;
|
||||
unsigned cut_coding_format;
|
||||
int use_cut_coding_format;
|
||||
unsigned cut_sample_rate;
|
||||
int use_cut_sample_rate;
|
||||
unsigned cut_bit_rate;
|
||||
int use_cut_bit_rate;
|
||||
unsigned cut_channels;
|
||||
int use_cut_channels;
|
||||
int cut_play_gain;
|
||||
int use_cut_play_gain;
|
||||
int cut_start_point;
|
||||
int use_cut_start_point;
|
||||
int cut_end_point;
|
||||
int use_cut_end_point;
|
||||
int cut_fadeup_point;
|
||||
int use_cut_fadeup_point;
|
||||
int cut_fadedown_point;
|
||||
int use_cut_fadedown_point;
|
||||
int cut_segue_start_point;
|
||||
int use_cut_segue_start_point;
|
||||
int cut_segue_end_point;
|
||||
int use_cut_segue_end_point;
|
||||
int cut_segue_gain;
|
||||
int use_cut_segue_gain;
|
||||
int cut_hook_start_point;
|
||||
int use_cut_hook_start_point;
|
||||
int cut_hook_end_point;
|
||||
int use_cut_hook_end_point;
|
||||
int cut_talk_start_point;
|
||||
int use_cut_talk_start_point;
|
||||
int cut_talk_end_point;
|
||||
int use_cut_talk_end_point;
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
|
||||
is stored in the provided memory locations. The rd_cut structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cut {
|
||||
char cut_name[11];
|
||||
unsigned cut_cart_number;
|
||||
unsigned cut_cut_number;
|
||||
int cut_evergreen;
|
||||
char cut_description[65];
|
||||
char cut_outcue[65];
|
||||
char cut_isrc[13];
|
||||
char cut_isci[33];
|
||||
unsigned cut_length;
|
||||
struct tm cut_origin_datetime;
|
||||
struct tm cut_start_datetime;
|
||||
struct tm cut_end_datetime;
|
||||
int cut_sun;
|
||||
int cut_mon;
|
||||
int cut_tue;
|
||||
int cut_wed;
|
||||
int cut_thu;
|
||||
int cut_fri;
|
||||
int cut_sat;
|
||||
char cut_start_daypart[9];
|
||||
char cut_end_daypart[9];
|
||||
char cut_origin_name[65];
|
||||
unsigned cut_weight;
|
||||
struct tm cut_last_play_datetime;
|
||||
unsigned cut_play_counter;
|
||||
unsigned cut_local_counter;
|
||||
unsigned cut_validity;
|
||||
unsigned cut_coding_format;
|
||||
unsigned cut_sample_rate;
|
||||
unsigned cut_bit_rate;
|
||||
unsigned cut_channels;
|
||||
int cut_play_gain;
|
||||
int cut_start_point;
|
||||
int cut_end_point;
|
||||
int cut_fadeup_point;
|
||||
int cut_fadedown_point;
|
||||
int cut_segue_start_point;
|
||||
int cut_segue_end_point;
|
||||
int cut_segue_gain;
|
||||
int cut_hook_start_point;
|
||||
int cut_hook_end_point;
|
||||
int cut_talk_start_point;
|
||||
int cut_talk_end_point;
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and are null-terminated.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cut
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid Parameter(s).
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
403 Edit Audio Forbidden.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
362
docs/rivwebcapi/rd_export.xml
Normal file
362
docs/rivwebcapi/rd_export.xml
Normal file
@@ -0,0 +1,362 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_Export</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_export</refname>
|
||||
<refpurpose>Rivendell Export Audio C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_export.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_Export</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const int <parameter>format</parameter></paramdef>
|
||||
<paramdef>const int <parameter>channels</parameter></paramdef>
|
||||
<paramdef>const int <parameter>sample_rate</parameter></paramdef>
|
||||
<paramdef>const int <parameter>bit_rate</parameter></paramdef>
|
||||
<paramdef>const int <parameter>quality</parameter></paramdef>
|
||||
<paramdef>const int <parameter>start_point</parameter></paramdef>
|
||||
<paramdef>const int <parameter>end_point</parameter></paramdef>
|
||||
<paramdef>const int <parameter>normalization_level</parameter></paramdef>
|
||||
<paramdef>const int <parameter>enable_metadata</parameter></paramdef>
|
||||
<paramdef>const char <parameter>filename[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_Export</command> is the function to use
|
||||
to export PCM/MPEG data from the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.export" frame="all">
|
||||
<title>RD_Export function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
format
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Format
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
channels
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Number of Channels
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
sample_rate
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Sample Rate
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
bit_rate
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Bit Rate
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
quality
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Quality
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
start_point
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Start Point
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
end_point
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
End Point
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
normalization_level
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Normalization Level
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
enable_metadata
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Flag for whether to enable Meta Data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
filename
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
File Name For Audio
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid Input Parameter(s).
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Source Audio Present.
|
||||
</para>
|
||||
<para>
|
||||
404 Unauthorized or No Such Cart / Cut.
|
||||
</para>
|
||||
<para>
|
||||
415 Invalid Settings.
|
||||
</para>
|
||||
<para>
|
||||
500 Conversion Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
227
docs/rivwebcapi/rd_exportpeaks.xml
Normal file
227
docs/rivwebcapi/rd_exportpeaks.xml
Normal file
@@ -0,0 +1,227 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ExportPeaks</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_exportpeaks</refname>
|
||||
<refpurpose>Rivendell ExportPeaks Audio C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_exportpeaks.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ExportPeaks</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>filename[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ExportPeaks</command> is the function to use
|
||||
to export Peak Data from the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.exportpeaks" frame="all">
|
||||
<title>RDExportPeaks function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
filename
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
File Name For Export Peak Data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
400 No Peak Data Available.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 UnAuthorized.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart / Cut.
|
||||
</para>
|
||||
<para>
|
||||
404 No Audio.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
52
docs/rivwebcapi/rd_getuseragent.xml
Normal file
52
docs/rivwebcapi/rd_getuseragent.xml
Normal file
@@ -0,0 +1,52 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_GetUserAgent</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>September 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_getuseragent</refname>
|
||||
<refpurpose>Get User Agent Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>char * <function>RD_GetUserAgent</function></funcdef><void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_GetUserAgent</command> Returns the USER AGENT STRING
|
||||
the Rivendell C API uses by default in the HTTP Header.
|
||||
</para>
|
||||
<para>
|
||||
When successful function will return a character string of the USER AGENT.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
Returns the user agent as a character string.
|
||||
</para>
|
||||
</refsect2>
|
||||
</refentry>
|
||||
53
docs/rivwebcapi/rd_getversion.xml
Normal file
53
docs/rivwebcapi/rd_getversion.xml
Normal file
@@ -0,0 +1,53 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_GetVersion</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>September 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_getversion</refname>
|
||||
<refpurpose>Get Version Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>char * <function>RD_GetVersion</function></funcdef><void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_GetVersion</command> Returns the Rivendell C API
|
||||
Version number as a string.
|
||||
</para>
|
||||
<para>
|
||||
When successful function will return a character string of the Version number
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
Returns the Rivendell-C-API version number as a character string.
|
||||
</para>
|
||||
</refsect2>
|
||||
</refentry>
|
||||
384
docs/rivwebcapi/rd_import.xml
Normal file
384
docs/rivwebcapi/rd_import.xml
Normal file
@@ -0,0 +1,384 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_Import</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_import</refname>
|
||||
<refpurpose>Rivendell Import Audio C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_import.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_Import</function></funcdef>
|
||||
<paramdef>struct rd_cartimport *<parameter>import[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>channels</parameter></paramdef>
|
||||
<paramdef>const int <parameter>normalization_level</parameter></paramdef>
|
||||
<paramdef>const int <parameter>autotrim_level</parameter></paramdef>
|
||||
<paramdef>const int <parameter>use_metadata</parameter></paramdef>
|
||||
<paramdef>const int <parameter>create</parameter></paramdef>
|
||||
<paramdef>const char <parameter>group[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>title[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>filename[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned *<parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_Import</command> is the function to use
|
||||
to import PCM/MPEG data into the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.import" frame="all">
|
||||
<title>RD_Import function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*import
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cartimport structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store import information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
channels
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Number of Channels
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
normalization_level
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Normalization Level
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
autotrim_level
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
AutoTrim Level
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
use_metadata
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Flag for whether to use Meta Data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
create
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Create Cart Flag
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
group
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Group Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory IF Creating Cart
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
title
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Title
|
||||
</entry>
|
||||
<entry>
|
||||
Optional - If present used for Duplicate Cart Check
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
filename
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
File Name For Source Audio
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs)
|
||||
and a rd_cartimport structure which
|
||||
is stored in the provided memory locations. The rd_cartimport structure
|
||||
has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cartimport{
|
||||
int response_code; /* HTTP Response Code */
|
||||
char error_string[256]; /* Error Explanation */
|
||||
unsigned cart_number; /* Destination Cart Number */
|
||||
unsigned cut_number; /* Destination Cut Number */
|
||||
};
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
400 Missing Input Parameter(s).
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Unauthorized, or No Such Cart/Cut/Group,
|
||||
or Duplicate Cart Titles Not Allowed.
|
||||
</para>
|
||||
<para>
|
||||
415 Format Not Supported.
|
||||
</para>
|
||||
<para>
|
||||
415 Conversion Settings/Format Error.
|
||||
</para>
|
||||
<para>
|
||||
500 Conversion Error.
|
||||
</para>
|
||||
<para>
|
||||
509 Format Error On Convert.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
321
docs/rivwebcapi/rd_listcart.xml
Normal file
321
docs/rivwebcapi/rd_listcart.xml
Normal file
@@ -0,0 +1,321 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListCart</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listcart</refname>
|
||||
<refpurpose>Rivendell List Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listcart.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListCart</function></funcdef>
|
||||
<paramdef> struct rd_cart * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListCart</command> is the function to use
|
||||
to list the fields within a cart that already exists in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in a pre-existing cart.
|
||||
</para>
|
||||
<table xml:id="ex.listcart" frame="all">
|
||||
<title>RD_ListCart function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*cart
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cart structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cart information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
|
||||
is stored in the provided memory locations. The rd_cart structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cart {
|
||||
unsigned cart_number; /* Cart Number */
|
||||
unsigned cart_type; /* Cart Type */
|
||||
char cart_grp_name[11]; /* Group Name */
|
||||
char cart_title[256]; /* Cart Title */
|
||||
char cart_artist[256]; /* Artist */
|
||||
char cart_album[256]; /* Album */
|
||||
int cart_year; /* Year */
|
||||
char cart_label[65]; /* Label */
|
||||
char cart_client[65]; /* Client */
|
||||
char cart_agency[65]; /* Agency */
|
||||
char cart_publisher[65]; /* Publisher */
|
||||
char cart_composer[65]; /* Composer */
|
||||
char cart_conductor[65]; /* Conductor */
|
||||
char cart_user_defined[256]; /* User Defined */
|
||||
int cart_usage_code; /* Usage Code */
|
||||
int cart_forced_length; /* Forced Length */
|
||||
int cart_average_length; /* AverageLength */
|
||||
int cart_length_deviation; /* Length Deviation */
|
||||
int cart_average_segue_length; /* Average Segue Length */
|
||||
int cart_average_hook_length; /* Average Hook Length */
|
||||
unsigned cart_cut_quantity; /* Cut Quantity */
|
||||
unsigned cart_last_cut_played; /* Last Cut Played */
|
||||
unsigned cart_validity; /* Validity */
|
||||
int cart_enforce_length; /* Enforce Length Flag */
|
||||
int cart_asyncronous; /* Asyncronous Flag */
|
||||
char cart_owner[65]; /* Owner */
|
||||
struct tm cart_metadata_datetime; /* Metatdata Datetime */
|
||||
char cart_notes[1024]; /* Notes */
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The cart_type is 1=Audio,2=Macro.
|
||||
|
||||
The cart_grp_name must be a valid Rivendell DB Group.
|
||||
|
||||
The cart_title is 255 characters.
|
||||
|
||||
The cart_artist is 255 characters.
|
||||
|
||||
The cart_album is 255 characters.
|
||||
|
||||
The cart_year is a date (YYYY).
|
||||
|
||||
The cart_label is 64 characters.
|
||||
|
||||
The cart_client is 64 characters.
|
||||
|
||||
The cart_agency is 64 characters.
|
||||
|
||||
The cart_publisher is 64 characters.
|
||||
|
||||
The cart_composer is 64 characters.
|
||||
|
||||
The cart_conductor is 64 characters.
|
||||
|
||||
The cart_user_defined is 255 characters.
|
||||
|
||||
The cart_usage_code is 0=Feature, 1=Theme Open,
|
||||
2=Theme Close, 3=Theme Open/Close,
|
||||
4=Background, 5=Comm/Promo
|
||||
|
||||
The cart_forced_length is in milliseconds.
|
||||
|
||||
The cart_average_length is in milliseconds.
|
||||
|
||||
The cart_length_deviation is in milliseconds.
|
||||
|
||||
The cart_average_segue_length is in milliseconds.
|
||||
|
||||
The cart_average_hook_length is in milliseconds.
|
||||
|
||||
The cart_cut_quantity is number of cuts.
|
||||
|
||||
The cart_last_cut_played is self explanatory.
|
||||
|
||||
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid
|
||||
3=EvergreenValid, 4=FutureValid
|
||||
|
||||
The cart_enforce_length is True(1) or False(0).
|
||||
|
||||
The cart_asyncronous is True(1) or False(0).
|
||||
|
||||
The cart_owner is 64 characters.
|
||||
|
||||
The cart_metadata_datetime is a struct tm.
|
||||
|
||||
The cart_user_notes is a character array up to 1024 characters.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cart
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
350
docs/rivwebcapi/rd_listcarts.xml
Normal file
350
docs/rivwebcapi/rd_listcarts.xml
Normal file
@@ -0,0 +1,350 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListCarts</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listcarts</refname>
|
||||
<refpurpose>Rivendell List Carts C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listcarts.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListCarts</function></funcdef>
|
||||
<paramdef> struct rd_cart * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>group_name[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>filter[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>type[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListCarts</command> is the function to use
|
||||
to list the carts that already exists in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in a pre-existing cart.
|
||||
The user can also filter the records by group name, cart type, and/or a
|
||||
user provided search string.
|
||||
</para>
|
||||
<table xml:id="ex.listcart" frame="all">
|
||||
<title>RD_ListCarts function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*cart
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cart structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cart information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
group_name
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Group Name
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
filter
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Filter - searches for specific strings within the following fields: Title, Artist, Client, Agency, Album, Label, Publisher, Composer, Conductor, Song_Id, User_Defined, and Cart Number.
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
type
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Type of Cart records. If set can be Audio, or Macro.
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
|
||||
is stored in the provided memory locations. The rd_cart structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cart {
|
||||
unsigned cart_number; /* Cart Number */
|
||||
unsigned cart_type; /* Cart Type */
|
||||
char cart_grp_name[11]; /* Group Name */
|
||||
char cart_title[256]; /* Cart Title */
|
||||
char cart_artist[256]; /* Artist */
|
||||
char cart_album[256]; /* Album */
|
||||
int cart_year; /* Year */
|
||||
char cart_label[65]; /* Label */
|
||||
char cart_client[65]; /* Client */
|
||||
char cart_agency[65]; /* Agency */
|
||||
char cart_publisher[65]; /* Publisher */
|
||||
char cart_composer[65]; /* Composer */
|
||||
char cart_conductor[65]; /* Conductor */
|
||||
char cart_user_defined[256]; /* User Defined */
|
||||
int cart_usage_code; /* Usage Code */
|
||||
int cart_forced_length; /* Forced Length */
|
||||
int cart_average_length; /* AverageLength */
|
||||
int cart_length_deviation; /* Length Deviation */
|
||||
int cart_average_segue_length; /* Average Segue Length */
|
||||
int cart_average_hook_length; /* Average Hook Length */
|
||||
unsigned cart_cut_quantity; /* Cut Quantity */
|
||||
unsigned cart_last_cut_played; /* Last Cut Played */
|
||||
unsigned cart_validity; /* Validity */
|
||||
int cart_enforce_length; /* Enforce Length Flag */
|
||||
int cart_asyncronous; /* Asyncronous Flag */
|
||||
char cart_owner[65]; /* Owner */
|
||||
struct tm cart_metadata_datetime; /* Metatdata Datetime */
|
||||
char cart_notes[1024]; /* Notes */
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The cart_type is 1=Audio,2=Macro.
|
||||
|
||||
The cart_grp_name must be a valid Rivendell DB Group.
|
||||
|
||||
The cart_title is 255 characters.
|
||||
|
||||
The cart_artist is 255 characters.
|
||||
|
||||
The cart_album is 255 characters.
|
||||
|
||||
The cart_year is a date (YYYY).
|
||||
|
||||
The cart_label is 64 characters.
|
||||
|
||||
The cart_client is 64 characters.
|
||||
|
||||
The cart_agency is 64 characters.
|
||||
|
||||
The cart_publisher is 64 characters.
|
||||
|
||||
The cart_composer is 64 characters.
|
||||
|
||||
The cart_conductor is 64 characters.
|
||||
|
||||
The cart_user_defined is 255 characters.
|
||||
|
||||
The cart_usage_code is 0=Feature, 1=Theme Open,
|
||||
2=Theme Close, 3=Theme Open/Close,
|
||||
4=Background, 5=Comm/Promo
|
||||
|
||||
The cart_forced_length is in milliseconds.
|
||||
|
||||
The cart_average_length is in milliseconds.
|
||||
|
||||
The cart_length_deviation is in milliseconds.
|
||||
|
||||
The cart_average_segue_length is in milliseconds.
|
||||
|
||||
The cart_average_hook_length is in milliseconds.
|
||||
|
||||
The cart_cut_quantity is number of cuts.
|
||||
|
||||
The cart_last_cut_played is self explanatory.
|
||||
|
||||
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid
|
||||
3=EvergreenValid, 4=FutureValid
|
||||
|
||||
The cart_enforce_length is True(1) or False(0).
|
||||
|
||||
The cart_asyncronous is True(1) or False(0).
|
||||
|
||||
The cart_owner is 64 characters.
|
||||
|
||||
The cart_metadata_datetime is a struct tm.
|
||||
|
||||
The cart_user_notes is a character array up to 1024 characters.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cart
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Group Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
235
docs/rivwebcapi/rd_listcartschedcodes.xml
Normal file
235
docs/rivwebcapi/rd_listcartschedcodes.xml
Normal file
@@ -0,0 +1,235 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListCartSchedCodes</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listcartschedcodes</refname>
|
||||
<refpurpose>Rivendell List Cart Scheduler Codes C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listcartschedcodes.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListCartSchedCodes</function></funcdef>
|
||||
<paramdef> struct rd_schedcodes * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListCartSchedCodes</command> is the function to use
|
||||
to list the Scheduler Codes that are currently assigned to a cart in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the scheduler codes in a pre-existing cart.
|
||||
</para>
|
||||
<table xml:id="ex.listcartschedcodes" frame="all">
|
||||
<title>RD_ListCartSchedCodes function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*schedcodes
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_schedcodes structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store scheduler code information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_schedcodes structure which
|
||||
is stored in the provided memory locations. The rd_schedcodes structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_schedcodes {
|
||||
char code[11];
|
||||
char description[255];
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
</programlisting>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_schedcodes
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists or Unauthorized.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
294
docs/rivwebcapi/rd_listcut.xml
Normal file
294
docs/rivwebcapi/rd_listcut.xml
Normal file
@@ -0,0 +1,294 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListCut</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listcut</refname>
|
||||
<refpurpose>Rivendell List Cut C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listcut.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListCut</function></funcdef>
|
||||
<paramdef> struct rd_cut * <parameter>cut[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListCut</command> is the function to use
|
||||
to list the fields within a cut that already exists in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in a pre-existing cut.
|
||||
</para>
|
||||
<table xml:id="ex.listcut" frame="all">
|
||||
<title>RD_ListCut function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*cut
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cut structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cut information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
|
||||
is stored in the provided memory locations. The rd_cut structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cut {
|
||||
char cut_name[11];
|
||||
unsigned cut_cart_number;
|
||||
unsigned cut_cut_number;
|
||||
int cut_evergreen;
|
||||
char cut_description[65];
|
||||
char cut_outcue[65];
|
||||
char cut_isrc[13];
|
||||
char cut_isci[33];
|
||||
unsigned cut_length;
|
||||
struct tm cut_origin_datetime;
|
||||
struct tm cut_start_datetime;
|
||||
struct tm cut_end_datetime;
|
||||
int cut_sun;
|
||||
int cut_mon;
|
||||
int cut_tue;
|
||||
int cut_wed;
|
||||
int cut_thu;
|
||||
int cut_fri;
|
||||
int cut_sat;
|
||||
char cut_start_daypart[9];
|
||||
char cut_end_daypart[9];
|
||||
char cut_origin_name[65];
|
||||
char cut_origin_login_name[256];
|
||||
char cut_source_hostname[256];
|
||||
unsigned cut_weight;
|
||||
struct tm cut_last_play_datetime;
|
||||
unsigned cut_play_counter;
|
||||
unsigned cut_local_counter;
|
||||
unsigned cut_validity;
|
||||
unsigned cut_coding_format;
|
||||
unsigned cut_sample_rate;
|
||||
unsigned cut_bit_rate;
|
||||
unsigned cut_channels;
|
||||
int cut_play_gain;
|
||||
int cut_start_point;
|
||||
int cut_end_point;
|
||||
int cut_fadeup_point;
|
||||
int cut_fadedown_point;
|
||||
int cut_segue_start_point;
|
||||
int cut_segue_end_point;
|
||||
int cut_segue_gain;
|
||||
int cut_hook_start_point;
|
||||
int cut_hook_end_point;
|
||||
int cut_talk_start_point;
|
||||
int cut_talk_end_point;
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cut
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart/Cut Number.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart/Cut Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
280
docs/rivwebcapi/rd_listcuts.xml
Normal file
280
docs/rivwebcapi/rd_listcuts.xml
Normal file
@@ -0,0 +1,280 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListCuts</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listcuts</refname>
|
||||
<refpurpose>Rivendell List Cuts C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listcuts.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListCuts</function></funcdef>
|
||||
<paramdef> struct rd_cut * <parameter>cuts[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListCuts</command> is the function to use
|
||||
to list the cuts that exist in a Rivendell Database Cart entry.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in the pre-existing cut(s).
|
||||
</para>
|
||||
<table xml:id="ex.listcuts" frame="all">
|
||||
<title>RD_ListCuts function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*cuts
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_cut structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store cut information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
|
||||
is stored in the provided memory locations. The rd_cut structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_cut {
|
||||
char cut_name[11];
|
||||
unsigned cut_cart_number;
|
||||
unsigned cut_cut_number;
|
||||
int cut_evergreen;
|
||||
char cut_description[65];
|
||||
char cut_outcue[65];
|
||||
char cut_isrc[13];
|
||||
char cut_isci[33];
|
||||
unsigned cut_length;
|
||||
struct tm cut_origin_datetime;
|
||||
struct tm cut_start_datetime;
|
||||
struct tm cut_end_datetime;
|
||||
int cut_sun;
|
||||
int cut_mon;
|
||||
int cut_tue;
|
||||
int cut_wed;
|
||||
int cut_thu;
|
||||
int cut_fri;
|
||||
int cut_sat;
|
||||
char cut_start_daypart[14];
|
||||
char cut_end_daypart[14];
|
||||
char cut_origin_name[65];
|
||||
char cut_origin_login_name[256];
|
||||
char cut_source_hostname[256];
|
||||
unsigned cut_weight;
|
||||
struct tm cut_last_play_datetime;
|
||||
unsigned cut_play_counter;
|
||||
unsigned cut_local_counter;
|
||||
unsigned cut_validity;
|
||||
unsigned cut_coding_format;
|
||||
unsigned cut_sample_rate;
|
||||
unsigned cut_bit_rate;
|
||||
unsigned cut_channels;
|
||||
int cut_play_gain;
|
||||
int cut_start_point;
|
||||
int cut_end_point;
|
||||
int cut_fadeup_point;
|
||||
int cut_fadedown_point;
|
||||
int cut_segue_start_point;
|
||||
int cut_segue_end_point;
|
||||
int cut_segue_gain;
|
||||
int cut_hook_start_point;
|
||||
int cut_hook_end_point;
|
||||
int cut_talk_start_point;
|
||||
int cut_talk_end_point;
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_cut
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart/Cut Number.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
251
docs/rivwebcapi/rd_listgroup.xml
Normal file
251
docs/rivwebcapi/rd_listgroup.xml
Normal file
@@ -0,0 +1,251 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListGroup</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listgroup</refname>
|
||||
<refpurpose>Rivendell List Group C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listgroup.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListGroup</function></funcdef>
|
||||
<paramdef> struct rd_group * <parameter>group[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>groupname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListGroup</command> is the function to use
|
||||
to list the fields that are stored for a particular group within the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in a pre-existing Group.
|
||||
</para>
|
||||
<table xml:id="ex.listgroup" frame="all">
|
||||
<title>RD_ListGroup function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*group
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_group structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store group information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
groupname
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Group Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_group structure which
|
||||
is stored in the provided memory locations. The rd_group structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_group {
|
||||
char grp_name[11]; /* Group Name */
|
||||
char grp_desc[255]; /* Description */
|
||||
unsigned grp_default_cart_type; /* Default cart type */
|
||||
unsigned grp_lo_limit; /* Group starting Cart Number */
|
||||
unsigned grp_hi_limit; /* Group Ending Cart Number */
|
||||
int grp_shelf_life;
|
||||
char grp_default_title[255];
|
||||
int grp_enforce_range;
|
||||
int grp_report_tfc;
|
||||
int grp_report_mus;
|
||||
int grp_now_next;
|
||||
char grp_color[8];
|
||||
char grp_reserved[457];
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The Default cart_type is 1=Audio,2=Macro.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_group
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Group Name.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Group Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
231
docs/rivwebcapi/rd_listgroups.xml
Normal file
231
docs/rivwebcapi/rd_listgroups.xml
Normal file
@@ -0,0 +1,231 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListGroups</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listgroups</refname>
|
||||
<refpurpose>Rivendell List Groups C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listgroups.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListGroups</function></funcdef>
|
||||
<paramdef> struct rd_group * <parameter>group[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>groupname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListGroups</command> is the function to use
|
||||
to list the fields that are stored for a particular group within the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the fields in all pre-existing Groups.
|
||||
</para>
|
||||
<table xml:id="ex.listgroup" frame="all">
|
||||
<title>RD_ListGroups function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*group
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_group structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store group information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and rd_group structure(s) which
|
||||
is stored in the provided memory locations. The rd_group structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_group {
|
||||
char grp_name[11]; /* Group Name */
|
||||
char grp_desc[255]; /* Description */
|
||||
unsigned grp_default_cart_type; /* Default cart type */
|
||||
unsigned grp_lo_limit; /* Group starting Cart Number */
|
||||
unsigned grp_hi_limit; /* Group Ending Cart Number */
|
||||
int grp_shelf_life;
|
||||
char grp_default_title[255];
|
||||
int grp_enforce_range;
|
||||
int grp_report_tfc;
|
||||
int grp_report_mus;
|
||||
int grp_now_next;
|
||||
char grp_color[8];
|
||||
char grp_reserved[457];
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
The cart number is a unsigned integer.
|
||||
|
||||
The Default cart_type is 1=Audio,2=Macro.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_group
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
397
docs/rivwebcapi/rd_listlog.xml
Normal file
397
docs/rivwebcapi/rd_listlog.xml
Normal file
@@ -0,0 +1,397 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListLog</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listlog</refname>
|
||||
<refpurpose>Rivendell List Log C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listlog.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListLog</function></funcdef>
|
||||
<paramdef> struct rd_logline * <parameter>logline[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>logname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListLog</command> is the function to use
|
||||
to list the log lines that are stored for a particular log file within the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the lines in a pre-existing Log File.
|
||||
</para>
|
||||
<table xml:id="ex.listlog" frame="all">
|
||||
<title>RD_ListLog function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*logline[]
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_logline structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store logline information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
logname
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
LogFile Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and rd_logline structure which
|
||||
is stored in the provided memory locations. The rd_logline structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_logline {
|
||||
int logline_line;
|
||||
int logline_id;
|
||||
int logline_type;
|
||||
int logline_cart_type;
|
||||
unsigned logline_cart_number;
|
||||
unsigned logline_cut_number;
|
||||
char logline_group_name[11];
|
||||
char logline_group_color[10];
|
||||
char logline_title[256];
|
||||
char logline_artist[256];
|
||||
char logline_album[256];
|
||||
int logline_year;
|
||||
char logline_label[65];
|
||||
char logline_client[65];
|
||||
char logline_agency[65];
|
||||
char logline_publisher[65];
|
||||
char logline_composer[65];
|
||||
char logline_conductor[65];
|
||||
char logline_user_defined[256];
|
||||
int logline_usage_code;
|
||||
int logline_enforce_length;
|
||||
char logline_forced_length[10];
|
||||
int logline_evergreen;
|
||||
int logline_source;
|
||||
int logline_time_type;
|
||||
char logline_starttime[13];
|
||||
int logline_transition_type;
|
||||
int logline_cut_quantity;
|
||||
int logline_last_cut_played;
|
||||
char logline_marker_comment[256];
|
||||
char logline_marker_label[65];
|
||||
char logline_origin_user[256];
|
||||
struct tm logline_origin_datetime;
|
||||
int logline_start_point_cart;
|
||||
int logline_start_point_log;
|
||||
int logline_end_point_cart;
|
||||
int logline_end_point_log;
|
||||
int logline_segue_start_point_cart;
|
||||
int logline_segue_start_point_log;
|
||||
int logline_segue_end_point_cart;
|
||||
int logline_segue_end_point_log;
|
||||
int logline_segue_gain;
|
||||
int logline_fadeup_point_cart;
|
||||
int logline_fadeup_point_log;
|
||||
int logline_fadeup_gain;
|
||||
int logline_fadedown_point_cart;
|
||||
int logline_fadedown_point_log;
|
||||
int logline_duckup_gain;
|
||||
int logline_duckdown_gain;
|
||||
int logline_talk_start_point;
|
||||
int logline_talk_end_point;
|
||||
int logline_hook_mode;
|
||||
int logline_hook_start_point;
|
||||
int logline_hook_end_point;
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
logline_line is a integer which represents the line number in the log.
|
||||
|
||||
logline_id is an integer which represents the line id (generated by rdlogedit).
|
||||
|
||||
logline_type is an integer 0=Cart, 1=Marker, 2=Macro, 3=OpenBracket,
|
||||
4=CloseBracket, 5=Chain, 6=Track, 7=MusicLink, 8=TrafficLink,
|
||||
9=UnknownType.
|
||||
|
||||
logline_cart_type is an integer 1=Audio, 2=Macro.
|
||||
|
||||
logline_cart_number is an unsigned integer.
|
||||
|
||||
logline_cut_number is an unsigned integer.
|
||||
|
||||
logline_group_name is a character arrray.
|
||||
|
||||
logline_group_color is a character arrray. No value set is #000000.
|
||||
|
||||
logline_title is a character arrray.
|
||||
|
||||
logline_artist is a character arrray.
|
||||
|
||||
logline_album is a character arrray.
|
||||
|
||||
logline_year is the 4 digit year.
|
||||
|
||||
logline_label is a character arrray.
|
||||
|
||||
logline_client is a character arrray.
|
||||
|
||||
logline_agency is a character arrray.
|
||||
|
||||
logline_publisher is a character arrray.
|
||||
|
||||
logline_composer is a character arrray.
|
||||
|
||||
logline_conductor is a character arrray.
|
||||
|
||||
logline_user_defined is a character arrray.
|
||||
|
||||
logline_usage_code is an integer 0=UsageFeature, 1=UsageOpen, 2=UsageClose,
|
||||
3=UsageTheme, 4=UsageBackground, 5=UsagePromo, 6=UsageLast.
|
||||
|
||||
logline_enforce_length is a Boolean 0 = False, 1 = True.
|
||||
|
||||
logline_forced_length is the Length (Format HH:MM:SS.milliseconds).
|
||||
|
||||
logline_evergreen is a Boolean 0 = False, 1 = True.
|
||||
|
||||
logline_source is an integer 0=Manual, 1=Traffic, 2=Music,
|
||||
3=Template, 4=Tracker
|
||||
|
||||
logline_time_type is an integer 0 = Relative, 1=Hard, 255 = NoTime.
|
||||
|
||||
logline_starttime is start Time (Format HH:MM:SS.milliseconds).
|
||||
|
||||
logline_transition_type is an integer 0=Play, 1=Segue, 2=Stop, 255=NoTrans.
|
||||
|
||||
logline_cut_quantity is an integer.
|
||||
|
||||
logline_last_cut_played is an integer.
|
||||
|
||||
logline_marker_comment is a character array.
|
||||
|
||||
logline_marker_label is a character array.
|
||||
|
||||
logline_origin_user is a character array.
|
||||
|
||||
logline_origin_datetime is a struct tm.
|
||||
|
||||
logline_start_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_start_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_end_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_end_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_segue_start_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_segue_start_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_segue_end_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_segue_end_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_segue_gain is an integer. No Value = -3000.
|
||||
|
||||
logline_fadeup_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_fadeup_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_fadeup_gain is an integer.
|
||||
|
||||
logline_fadedown_point_cart is a integer. No Value = -1.
|
||||
|
||||
logline_fadedown_point_log is a integer. No Value = -1.
|
||||
|
||||
logline_duckup_gain is a integer.
|
||||
|
||||
logline_duckdown_gain is a integer.
|
||||
|
||||
logline_talk_start_point is a integer. No Value = -1.
|
||||
|
||||
logline_talk_end_point is a integer. No Value = -1.
|
||||
|
||||
logline_hook_mode is a integer. No Value = -1.
|
||||
|
||||
logline_hook_start_point is a integer. No Value = -1.
|
||||
|
||||
logline_hook_end_point is a integer. No Value = -1.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_logline
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Log File Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
306
docs/rivwebcapi/rd_listlogs.xml
Normal file
306
docs/rivwebcapi/rd_listlogs.xml
Normal file
@@ -0,0 +1,306 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListLogs</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listlogs</refname>
|
||||
<refpurpose>Rivendell List Logs C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listlogs.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListLogs</function></funcdef>
|
||||
<paramdef> struct rd_logline * <parameter>logline[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>logname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>servicename[]</parameter></paramdef>
|
||||
<paramdef>const int <parameter>trackable</parameter></paramdef>
|
||||
<paramdef>const char <parameter>filter[]</parameter></paramdef>
|
||||
<paramdef>const int <parameter>recent</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListLogs</command> is the function to use
|
||||
to list the log files that are stored within the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the names of the Log Files in the system.
|
||||
</para>
|
||||
<table xml:id="ex.listlogs" frame="all">
|
||||
<title>RD_ListLogs function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*logline[]
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_logline structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store logline information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
servicename
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Service Name
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
logname
|
||||
</entry>
|
||||
<entry>
|
||||
character array
|
||||
</entry>
|
||||
<entry>
|
||||
Log Name
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
trackable
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Limit returns to logs that contain voicetrack(s). 0=No, 1=Yes (Default).
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
filter
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Limit returns to logs that contain the specified string
|
||||
in their Name, Description or Service fields.
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
recent
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Return only the 14 most recently modified logs.
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and rd_log structure which
|
||||
is stored in the provided memory locations. The rd_log structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_log {
|
||||
char log_name[11];
|
||||
char log_service[11];
|
||||
char log_description[65];
|
||||
char log_origin_username[256];
|
||||
struct tm log_origin_datetime;
|
||||
struct tm log_purge_date;
|
||||
struct tm log_link_datetime;
|
||||
struct tm log_modified_datetime;
|
||||
int log_autorefresh;
|
||||
char log_startdate[30];
|
||||
char log_enddate[30];
|
||||
int log_scheduled_tracks;
|
||||
int log_completed_tracks;
|
||||
int log_music_links;
|
||||
int log_music_linked;
|
||||
int log_traffic_links;
|
||||
int log_traffic_linked;
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_log
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
220
docs/rivwebcapi/rd_listschedcodes.xml
Normal file
220
docs/rivwebcapi/rd_listschedcodes.xml
Normal file
@@ -0,0 +1,220 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListSchedCodes</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listschedcodes</refname>
|
||||
<refpurpose>Rivendell List Scheduler Codes C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listschedcodes.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListSchedCodes</function></funcdef>
|
||||
<paramdef> struct rd_schedcodes * <parameter>cart[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListSchedCodes</command> is the function to use
|
||||
to list the Scheduler Codes that currently exist in the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the scheduler codes.
|
||||
</para>
|
||||
<table xml:id="ex.listschedcodes" frame="all">
|
||||
<title>RD_ListSchedCodes function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*schedcodes
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_schedcodes structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store scheduler code information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_schedcodes structure which
|
||||
is stored in the provided memory locations. The rd_schedcodes structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_schedcodes {
|
||||
char code[11];
|
||||
char description[255];
|
||||
};
|
||||
|
||||
All character arrays above are the sizes listed and must be null-terminated.
|
||||
|
||||
</programlisting>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_schedcodes
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart Exists or Unauthorized.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
228
docs/rivwebcapi/rd_listservices.xml
Normal file
228
docs/rivwebcapi/rd_listservices.xml
Normal file
@@ -0,0 +1,228 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListServices</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listservices</refname>
|
||||
<refpurpose>Rivendell List Services C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listservices.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListServices</function></funcdef>
|
||||
<paramdef> struct rd_logline * <parameter>logline[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const int <parameter>trackable</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListServices</command> is the function to use
|
||||
to list services that are stored within the Rivendell Database.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the names of the Services in the system.
|
||||
</para>
|
||||
<table xml:id="ex.listservices" frame="all">
|
||||
<title>RD_ListServices function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*services[]
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_service structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store service information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
trackable
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Limit returns to services that have a valid voicetracking configuration. 0=No(Default), 1=Yes.
|
||||
</entry>
|
||||
<entry>
|
||||
Optional
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and rd_service structure which
|
||||
is stored in the provided memory locations. The rd_service structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_service {
|
||||
char service_name [11];
|
||||
char service_description[256];
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_log
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
216
docs/rivwebcapi/rd_listsystemsettings.xml
Normal file
216
docs/rivwebcapi/rd_listsystemsettings.xml
Normal file
@@ -0,0 +1,216 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_ListSystemSetting</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_listsystemsettings</refname>
|
||||
<refpurpose>Rivendell System Settings C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_listsystemsettings.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_ListSystemSettings</function></funcdef>
|
||||
<paramdef> struct rd_system_settings * <parameter>system_settings[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_ListSystemSettings</command> is the function to use
|
||||
to get information about the audio store.
|
||||
</para>
|
||||
<table xml:id="ex.audiostore" frame="all">
|
||||
<title>RD_ListSystemSettings function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*rd_system_settings
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_system_settings structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store specific system settings data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_system_settings structure which
|
||||
is stored in the provided memory locations. The rd_system_settings structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_system_settings {
|
||||
unsigned sample_rate;
|
||||
int dup_cart_titles;
|
||||
unsigned max_post_length;
|
||||
char isci_xreference_path[256];
|
||||
char temp_cart_group[11];
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_system_settings
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Internal Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
191
docs/rivwebcapi/rd_removecart.xml
Normal file
191
docs/rivwebcapi/rd_removecart.xml
Normal file
@@ -0,0 +1,191 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_RemoveCart</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_removecart</refname>
|
||||
<refpurpose>Rivendell Remove Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_removecart.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_RemoveCart</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_RemoveCart</command> is the function to use
|
||||
to remove a cart from the Rivendell database.
|
||||
</para>
|
||||
<table xml:id="ex.removecart" frame="all">
|
||||
<title>RD_RemoveCart function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Unauthorized or No Such Cart.
|
||||
</para>
|
||||
<para>
|
||||
500 Unable to delete Cart.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
203
docs/rivwebcapi/rd_removecut.xml
Normal file
203
docs/rivwebcapi/rd_removecut.xml
Normal file
@@ -0,0 +1,203 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_RemoveCut</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_removecut</refname>
|
||||
<refpurpose>Rivendell Remove Cut C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_removecut.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_RemoveCut</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_RemoveCut</command> is the function to use
|
||||
to remove a cut from the Rivendell database.
|
||||
</para>
|
||||
<table xml:id="ex.removecut" frame="all">
|
||||
<title>RD_RemoveCut function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number / Cut Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Unauthorized or No Such Cart/Cut.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
299
docs/rivwebcapi/rd_savelog.xml
Normal file
299
docs/rivwebcapi/rd_savelog.xml
Normal file
@@ -0,0 +1,299 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_SaveLog</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>February 2017</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_savelog</refname>
|
||||
<refpurpose>Rivendell Save Log C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_savelog.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_SaveLog</function></funcdef>
|
||||
<paramdef>struct save_loghdr_values <parameter>*hdrvals</parameter></paramdef>
|
||||
<paramdef>struct save_logline_values <parameter>*linevals</parameter></paramdef>
|
||||
<paramdef>unsigned <parameter>linevals_quan</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>log_name[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_SaveLog</command> is the function to use
|
||||
to save log information (both headers and lines) to an existing Rivendell
|
||||
Database.
|
||||
</para>
|
||||
<para>
|
||||
This function saves the specified log to the Rivendell database on
|
||||
hostname.
|
||||
</para>
|
||||
<table xml:id="ex.savelog" frame="all">
|
||||
<title>RD_SaveLog function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hdrvals
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to save_loghdr_values structure
|
||||
</entry>
|
||||
<entry>
|
||||
Log header data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
linevals
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to save_logline_values structure
|
||||
</entry>
|
||||
<entry>
|
||||
Log lines data
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
linevals_quan
|
||||
</entry>
|
||||
<entry>
|
||||
Unsigned Integer
|
||||
</entry>
|
||||
<entry>
|
||||
Number of lines in the linevals argument
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
log_name
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name to assign to new log
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
<para>
|
||||
Header data for the log is sent in a 'save_loghdr_values' struct, as
|
||||
follows:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct save_loghdr_values {
|
||||
char loghdr_service[11];
|
||||
char loghdr_description[65];
|
||||
int loghdr_autorefresh;
|
||||
struct tm loghdr_purge_date;
|
||||
struct tm loghdr_start_date;
|
||||
struct tm loghdr_end_date;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
Each line in the log is sent in a 'save_logline_values' struct, as
|
||||
follows:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct save_logline_values {
|
||||
int logline_id;
|
||||
int logline_type;
|
||||
int logline_source;
|
||||
unsigned logline_cart_number;
|
||||
int logline_starttime;
|
||||
int logline_gracetime;
|
||||
int logline_time_type;
|
||||
int logline_transition_type;
|
||||
int logline_start_point_log;
|
||||
int logline_end_point_log;
|
||||
int logline_segue_start_point_log;
|
||||
int logline_segue_end_point_log;
|
||||
int logline_fadeup_point_log;
|
||||
int logline_fadedown_point_log;
|
||||
int logline_duckup_gain;
|
||||
int logline_duckdown_gain;
|
||||
char logline_marker_comment[256];
|
||||
char logline_marker_label[65];
|
||||
char logline_origin_user[256];
|
||||
struct tm logline_origin_datetime;
|
||||
int logline_event_length;
|
||||
char logline_link_event_name[65];
|
||||
struct tm logline_link_starttime;
|
||||
int logline_link_length;
|
||||
int logline_link_start_slop;
|
||||
int logline_link_end_slop;
|
||||
int logline_link_id;
|
||||
int logline_link_embedded;
|
||||
struct tm logline_ext_starttime;
|
||||
int logline_ext_length;
|
||||
char logline_ext_cart_name[33];
|
||||
char logline_ext_data[33];
|
||||
char logline_ext_event_id[33];
|
||||
char logline_ext_annc_type[9];
|
||||
};
|
||||
</programlisting>
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Invalid/Missing Parameter.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 User Permission Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Service or Log Does Not Exist.
|
||||
</para>
|
||||
<para>
|
||||
500 Server error.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
267
docs/rivwebcapi/rd_trimaudio.xml
Normal file
267
docs/rivwebcapi/rd_trimaudio.xml
Normal file
@@ -0,0 +1,267 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_TrimAudio</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_trimaudio</refname>
|
||||
<refpurpose>Rivendell Trim Audio C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_trimaudio.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_TrimAudio</function></funcdef>
|
||||
<paramdef> struct rd_trimaudio * <parameter>trimaudio[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cutnumber</parameter></paramdef>
|
||||
<paramdef>const int <parameter>trimlevel</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
<paramdef>unsigned * <parameter>numrecs</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_TrimAudio</command> is the function to use
|
||||
to get the time pointer to the first and last instance of a particular level in a cut.
|
||||
</para>
|
||||
<para>
|
||||
This function lists the first and last instance of a db level in a cut.
|
||||
</para>
|
||||
<table xml:id="ex.trimaudio" frame="all">
|
||||
<title>RD_TrimAudio function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
*cuts
|
||||
</entry>
|
||||
<entry>
|
||||
Pointer to rd_trimaudio structure
|
||||
</entry>
|
||||
<entry>
|
||||
Memory location to store trimaudio information
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cutnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cut Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
trimlevel
|
||||
</entry>
|
||||
<entry>
|
||||
integer
|
||||
</entry>
|
||||
<entry>
|
||||
Trim Level in 1/100 dB
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
*numrecs
|
||||
</entry>
|
||||
<entry>
|
||||
pointer to integer
|
||||
</entry>
|
||||
<entry>
|
||||
memory location for number of records returned
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>
|
||||
When successful function will return the number of records sent (numrecs) and a rd_trimaudio structure which
|
||||
is stored in the provided memory locations. The rd_trimaudio structure has the following fields:
|
||||
</para>
|
||||
<programlisting>
|
||||
struct rd_trimaudio {
|
||||
unsigned cart_number;
|
||||
unsigned cut_number;
|
||||
int trimlevel;
|
||||
int starttrimpoint;
|
||||
int endtrimpoint;
|
||||
};
|
||||
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned. Using the provided parameters an rd_trimaudio
|
||||
structure is returned and the number of records is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart/Cut Number, Trim Level or Peak Data.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 Invalid Permissions or No Cart / Audio Exists.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
208
docs/rivwebcapi/rd_unassignschedcode.xml
Normal file
208
docs/rivwebcapi/rd_unassignschedcode.xml
Normal file
@@ -0,0 +1,208 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
||||
<!--
|
||||
Header
|
||||
-->
|
||||
<refmeta>
|
||||
<refentrytitle>RD_UnassignSchedCode</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class='source'>October 2015</refmiscinfo>
|
||||
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>rd_unassignschedcode</refname>
|
||||
<refpurpose>Rivendell Unassign Scheduler Code from Cart C Library Function</refpurpose>
|
||||
</refnamediv>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Todd</firstname>
|
||||
<surname>Baker</surname>
|
||||
<email>bakert@rfa.org</email>
|
||||
</personname>
|
||||
<contrib>Rivendell C Library Author</contrib>
|
||||
</author>
|
||||
</info>
|
||||
|
||||
<!--
|
||||
Body
|
||||
-->
|
||||
<refsynopsisdiv id='synopsis'>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <rivendell/rd_unassignschedcode.h></funcsynopsisinfo>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>RD_UnassignSchedCode</function></funcdef>
|
||||
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>username[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
|
||||
<paramdef>const unsigned <parameter>cartnumber</parameter></paramdef>
|
||||
<paramdef>const char <parameter>code[]</parameter></paramdef>
|
||||
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1 id='description'><title>Description</title>
|
||||
<para>
|
||||
<command>RD_UnassignSchedCode</command> is the function to use
|
||||
to unassign a Scheduler Code from a cart in the Rivendell database.
|
||||
</para>
|
||||
<table xml:id="ex.unassignschedcode" frame="all">
|
||||
<title>RD_UnassignSchedCode function call fields</title>
|
||||
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
||||
<colspec colname="FIELD NAME" />
|
||||
<colspec colname="FIELD TYPE" />
|
||||
<colspec colname="MEANING" />
|
||||
<colspec colname="REMARKS" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>
|
||||
FIELD NAME
|
||||
</entry>
|
||||
<entry>
|
||||
FIELD TYPE
|
||||
</entry>
|
||||
<entry>
|
||||
MEANING
|
||||
</entry>
|
||||
<entry>
|
||||
REMARKS
|
||||
</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>
|
||||
hostname
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Name Of Rivendell DB Host
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
username
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Name
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
passwd
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell User Password
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO Ticket Provided
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Rivendell Authentification Ticket
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory When NO User/Password Pair Provided.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
cartnumber
|
||||
</entry>
|
||||
<entry>
|
||||
unsigned integer
|
||||
</entry>
|
||||
<entry>
|
||||
Cart Number
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
code
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
Scheduler Code to Unassign
|
||||
</entry>
|
||||
<entry>
|
||||
Mandatory
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>
|
||||
user_agent
|
||||
</entry>
|
||||
<entry>
|
||||
Character Array
|
||||
</entry>
|
||||
<entry>
|
||||
User Agent Value put into HTTP request
|
||||
</entry>
|
||||
<entry>
|
||||
Optional (default is Rivendell-C-API/x.x.x)
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
</refsect1>
|
||||
<refsect2 id='permissions'><title>Required User Permissions</title>
|
||||
<para>
|
||||
Modify Carts
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect2 id='returns'><title>RETURN VALUE</title>
|
||||
<para>
|
||||
On success, zero is returned.
|
||||
</para>
|
||||
<para>
|
||||
If a server error occurs a -1 is returned.
|
||||
If a client error occurs a specific error number is returned.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect3 id='errors'><title>ERRORS</title>
|
||||
<para>
|
||||
400 Missing Cart Number Error.
|
||||
</para>
|
||||
<para>
|
||||
403 User Authentification Error.
|
||||
</para>
|
||||
<para>
|
||||
404 No Such Cart / Scheduler Code.
|
||||
</para>
|
||||
<para>
|
||||
nnn Unknown Error Occurred.
|
||||
</para>
|
||||
</refsect3>
|
||||
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user