Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-11-26 15:20:29 +01:00
Code Issues Projects Releases Wiki Activity

2020-09-23 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Added 'RD_PostPodcast()', 'RDRemovePodcast()' and
	'RD_SavePodcast()' calls to the rivwebcapi API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
2020-09-24 13:42:57 -04:00
parent 86ec0e8c53
commit 59d70ff1e7
19 changed files with 1987 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/rivwebcapi/Makefile.am
View File

@@ -130,6 +130,9 @@ all-local: rd_addcart.html\
rd_postimage.html\
rd_postimage.pdf\
rd_postimage.xml\
rd_postpodcast.html\
rd_postpodcast.pdf\
rd_postpodcast.xml\
rd_postrss.html\
rd_postrss.pdf\
rd_postrss.xml\
@@ -142,6 +145,9 @@ all-local: rd_addcart.html\
rd_removeimage.html\
rd_removeimage.pdf\
rd_removeimage.xml\
rd_removepodcast.html\
rd_removepodcast.pdf\
rd_removepodcast.xml\
rd_removerss.html\
rd_removerss.pdf\
rd_removerss.xml\
@@ -149,6 +155,9 @@ all-local: rd_addcart.html\
rd_savelog.html\
rd_savelog.pdf\
rd_savelog.xml\
rd_savepodcast.html\
rd_savepodcast.pdf\
rd_savepodcast.xml\
rd_trimaudio.html\
rd_trimaudio.pdf\
rd_trimaudio.xml\
@@ -188,12 +197,15 @@ man_MANS = rd_addcart.7\
rd_listservices.7\
rd_listsystemsettings.7\
rd_postimage.7\
rd_postpodcast.7\
rd_postrss.7\
rd_removecart.7\
rd_removecut.7\
rd_removeimage.7\
rd_removepodcast.7\
rd_removerss.7\
rd_savelog.7\
rd_savepodcast.7\
rd_trimaudio.7\
rd_unassignschedcode.7
@@ -328,6 +340,10 @@ EXTRA_DIST = rd_addcart.7\
rd_postimage.html\
rd_postimage.pdf\
rd_postimage.xml\
rd_postpodcast.7\
rd_postpodcast.html\
rd_postpodcast.pdf\
rd_postpodcast.xml\
rd_postrss.7\
rd_postrss.html\
rd_postrss.pdf\
@@ -344,6 +360,10 @@ EXTRA_DIST = rd_addcart.7\
rd_removeimage.html\
rd_removeimage.pdf\
rd_removeimage.xml\
rd_removepodcast.7\
rd_removepodcast.html\
rd_removepodcast.pdf\
rd_removepodcast.xml\
rd_removerss.7\
rd_removerss.html\
rd_removerss.pdf\
@@ -352,6 +372,10 @@ EXTRA_DIST = rd_addcart.7\
rd_savelog.html\
rd_savelog.pdf\
rd_savelog.xml\
rd_savepodcast.7\
rd_savepodcast.html\
rd_savepodcast.pdf\
rd_savepodcast.xml\
rd_trimaudio.7\
rd_trimaudio.html\
rd_trimaudio.pdf\

188
docs/rivwebcapi/rd_postpodcast.xml Normal file
View File

@@ -0,0 +1,188 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>RD_PostPodcast</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo class='source'>September 2020</refmiscinfo>
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rd_postpodcast</refname>
<refpurpose>Rivendell Post RSS item audio Library Function</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Rivendell C Library Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;rivwebcapi/rd_postpodcast.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>RD_PostPodcast</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>cast_id</parameter></paramdef>
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>RD_PostPodcast</command> is the function to use
to post RSS audio from the audio store to the remote RSS repository.
</para>
<table xml:id="ex.postpodcast" frame="all">
<title>RD_PostPodcast 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>
cast_id
</entry>
<entry>
unsigned integer
</entry>
<entry>
Podcast ID
</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 Cast ID
</para>
<para>
403 User Authentification Error.
</para>
<para>
404 Unauthorized or No Such Podcast
</para>
<para>
nnn Unknown Error Occurred.
</para>
</refsect3>
</refentry>

188
docs/rivwebcapi/rd_removepodcast.xml Normal file
View File

@@ -0,0 +1,188 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>RD_RemovePodcast</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo class='source'>September 2020</refmiscinfo>
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rd_removepodcast</refname>
<refpurpose>Rivendell Remove RSS item audio C Library Function</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Rivendell C Library Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;rivwebcapi/rd_removepodcast.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>RD_RemovePodcast</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>cast_id</parameter></paramdef>
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>RD_RemovePodcast</command> is the function to use
to remove RSS item audio from the remote RSS repository.
</para>
<table xml:id="ex.removepodcast" frame="all">
<title>RD_RemovePodcast 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>
cast_id
</entry>
<entry>
unsigned integer
</entry>
<entry>
Podcast ID
</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 Podcast ID
</para>
<para>
403 User Authentification Error.
</para>
<para>
404 Unauthorized or No Such Podcast
</para>
<para>
nnn Unknown Error Occurred.
</para>
</refsect3>
</refentry>

2
docs/rivwebcapi/rd_removerss.xml
View File

@@ -48,7 +48,7 @@
<command>RD_RemoveRss</command> is the function to use
to remove the RSS XML from the remote RSS repository.
</para>
<table xml:id="ex.postrss" frame="all">
<table xml:id="ex.removerss" frame="all">
<title>RD_RemoveRss function call fields</title>
<tgroup cols="4" align="left" colsep="1" rowsep="1">
<colspec colname="FIELD NAME" />

205
docs/rivwebcapi/rd_savepodcast.xml Normal file
View File

@@ -0,0 +1,205 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>RD_SavePodcast</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo class='source'>October 2020</refmiscinfo>
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rd_savepodcast</refname>
<refpurpose>Rivendell Save Podcast C Library Function</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Rivendell C Library Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;rivwebcapi/rd_savepodcast.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>RD_SavePodcast</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>cast_id</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_SavePodcast</command> is the function to use
to copy finished RSS item audio to the Rivendell audio store.
</para>
<table xml:id="ex.savepodcast" frame="all">
<title>RD_SavePodcast 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>
cast_id
</entry>
<entry>
unsigned integer
</entry>
<entry>
ID of podcast item
</entry>
<entry>
Mandatory
</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>
</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 Podcast ID
</para>
<para>
400 Missing filename
</para>
<para>
403 User Authentification Error.
</para>
<para>
404 Unauthorized or no such podcast
</para>
<para>
nnn Unknown Error Occurred.
</para>
</refsect3>
</refentry>