Version 0.1.3 ;)

API.html

@@ -32,7 +32,7 @@
 
 <div class="center">
 <h1>RESTFULAPI-Plugin for VDR</h1><br />
-<b>Version 0.1.1</b><br />
+<b>Version 0.1.3</b><br />
 Copyright &copy; 2011 yavdr-Team, Michael Eiler<br /><br />
 Organization/Community: <a href="mailto:[email protected]">[email protected]</a><br />
 Developer: <a href="mailto:[email protected]">[email protected]</a> or <a href="mailto:[email protected]">[email protected]</a><br />
@@ -47,6 +47,7 @@ <h1>Table Of Contents</h1>
 <li><a href="#Preface">Preface</a>
 <li><a href="#Requirements">Requirements</a>
 <li><a href="#Configuration">Configuration</a>
+<li><a href="#Audio">Audio</a>
 <li><a href="#Channels">Channels</a>
 <ul><li><a href="#ChannelGroups">Groups</a>
     <li><a href="#ChannelImages">Images / Channel-Logos</a></ul>
@@ -57,8 +58,11 @@ <h1>Table Of Contents</h1>
 <li><a href="#Osd">Osd</a>
 <li><a href="#Recordings">Recordings</a>
 <ul><li><a href="#RecordingCut">Cut</a>
+	<li><a href="#RecordingDelete">Delete</a>
     <li><a href="#RecordingsMarks">Marks</a>
-	<li><a href="#RecordingPlay">Play</a></ul>
+	<li><a href="#RecordingMove">Move</a>
+	<li><a href="#RecordingPlay">Play</a>
+	<li><a href="#RecordingRewind">Rewind</a></ul>
 <li><a href="#Remote">Remote</a>
 <li><a href="#Timers">Timers</a>
 <ul><li><a href="#ReadingTimers">Reading/Deleting Timers</a>
@@ -138,6 +142,66 @@ <h1 class="center"><a name="Configuration">Configuration</a></h1>
 <br />
 <br />
 
+<hr />
+<h1 class="center"><a name="Audio">Audio</a></h1>
+<hr />
+<br />
+
+This service retrieves audio commands, sends them to VDR and returns the result:<br />
+<br />
+Methods: <b>POST, GET</b> (for simple requests) <br />
+<br />
+<b>Syntax:</b><br />
+<br />
+<div class="code"><code>
+GET  http://127.0.0.1:8002/audio.&lt;format&gt;<br />
+POST http://&lt;ip&gt;:&lt;port&gt;/audio.&lt;format&gt;<br />
+</code></div>
+<br /><br />
+<b>Description of the Body Parameters (POST only):</b>
+<br />
+
+<ul>
+<li>&lt;format&gt; - The requested format: json, xml or html.
+<li>&lt;volume&gt;
+<ul>
+<li>volume=180 // 180 absolute
+<li>volume=020 // +20
+<li>volume=-20 // -20
+</ul>
+<li>&lt;mute&gt; - 0 (mute), 1 (unmute) or 2(toggle).
+<li>&lt;track&gt; - track number.
+<li>&lt;channel&gt; - 0 (mono left), 1 (mono right) or 2(stereo).
+</ul>
+
+<br />
+<br />
+
+<b>Example Result:</b>
+<br />
+
+<div class="code"><code>
+GET  http://127.0.0.1:8002/audio.xml<br />
+POST http://127.0.0.1:8002/audio.xml<br />
+volume=230&amp;track=33<br /><br />
+&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;<br />
+&lt;audio xmlns="http://www.domain.org/restfulapi/2011/channels-xml"&gt;<br />
+&nbsp;&lt;volume>230&lt;/volume&gt;<br />
+&nbsp;&lt;mute&gt;0&lt;/mute&gt;<br />
+&nbsp;&lt;tracks count="3"&gt;<br />
+&nbsp;&nbsp;&lt;track type="1" description="französisch"/&gt;<br />
+&nbsp;&nbsp;&lt;track type="2" description="ohne Audiodeskription"/&gt;<br />
+&nbsp;&nbsp;&lt;track type="33" description="Dolby Digital 5.1"/&gt;<br />
+&nbsp;&lt;/tracks&gt;<br />
+&nbsp;&lt;type&gt;33&lt;/type&gt;<br />
+&nbsp;&lt;description&gt;Dolby Digital 5.1&lt;/description&gt;<br />
+&nbsp;&lt;channel&gt;dd 5.1&lt;/channel&gt;<br />
+&lt;/audio&gt;<br />
+</code></div>
+<br />
+
+<br />
+<br />
 
 <hr />
 <h1 class="center"><a name="Channels">Channels</a></h1>
@@ -461,46 +525,79 @@ <h1 class="center"><a name="Info">Info</a></h1>
 GET http://&lt;ip&gt;:&lt;port&gt;/info.&lt;format&gt;
 </code></div>
 <br />
+<br />
+<b>Description of the Parameters:</b>
+<br />
+
+<ul>
+<li>&lt;format&gt; - The requested format: json, xml or html.
+</ul>
+<br />
 <b>Example Results:</b><br />
 <br />
 <div class="code"><code>
 <br />
-&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;
-&lt;info xmlns="http://www.domain.org/restfulapi/2011/info-xml"&gt;
- &lt;version&gt;0.0.1&lt;/version&gt;
- &lt;time&gt;1311710291&lt;/time&gt;
- &lt;services&gt;
-  &lt;service path="/info"  version="1" internal="true" /&gt;
-  &lt;service path="/channels"  version="1" internal="true" /&gt;
-  &lt;service path="/channels/groups"  version="1" internal="true" /&gt;
-  &lt;service path="/channels/image"  version="1" internal="true" /&gt;
-  &lt;service path="/events"  version="1" internal="true" /&gt;
-  &lt;service path="/events/image"  version="1" internal="true" /&gt;
-  &lt;service path="/events/search"  version="1" internal="false" /&gt;
-  &lt;service path="/recordings"  version="1" internal="true" /&gt;
-  &lt;service path="/remote"  version="1" internal="true" /&gt;
-  &lt;service path="/timers"  version="1" internal="true" /&gt;
-  &lt;service path="/osd"  version="1" internal="true" /&gt;
-  &lt;service path="/searchtimers"  version="1" internal="false" /&gt;
- &lt;/services&gt;
- &lt;channel&gt;C-71-71-61920&lt;/channel&gt;
- &lt;vdr&gt;
-  &lt;plugins&gt;
-   &lt;plugin name="restfulapi" version="0.0.1" /&gt;
-   &lt;plugin name="shutdown" version="0.0.2" /&gt;
-   &lt;plugin name="vnsiserver" version="0.9.0" /&gt;
-   &lt;plugin name="live" version="0.2.0" /&gt;
-   &lt;plugin name="epgsearchonly" version="0.0.1" /&gt;
-   &lt;plugin name="svdrposd" version="0.1.0" /&gt;
-   &lt;plugin name="xineliboutput" version="1.0.90-cvs" /&gt;
-   &lt;plugin name="streamdev-server" version="0.5.1-git" /&gt;
-   &lt;plugin name="epgsearch" version="0.9.25.beta22" /&gt;
-   &lt;plugin name="quickepgsearch" version="0.0.1" /&gt;
-   &lt;plugin name="text2skin" version="1.3.1" /&gt;
-   &lt;plugin name="conflictcheckonly" version="0.0.1" /&gt;
-  &lt;/plugins&gt;
- &lt;/vdr&gt;
-&lt;/info&gt;
+&lt;?xml version="1.0" encoding="UTF-8" standalone="yes"?&gt;<br />
+&lt;info xmlns="http://www.domain.org/restfulapi/2011/info-xml"&gt;<br />
+&nbsp;&lt;version&gt;0.0.1&lt;/version&gt;<br />
+&nbsp;&lt;time&gt;1372855585&lt;/time&gt;<br />
+&nbsp;&lt;services&gt;<br />
+&nbsp;&nbsp;&lt;service path="/audio"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/channels"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/channels/groups"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/channels/image"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/events"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/events/image"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/events/search"  version="1" internal="false" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/info"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/osd"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/recordings"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/recordings/cut"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/recordings/marks"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/recordings/play"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/recordings/rewind"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/remote"  version="1" internal="true" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/searchtimers"  version="1" internal="false" /&gt;<br />
+&nbsp;&nbsp;&lt;service path="/timers"  version="1" internal="true" /&gt;<br />
+&nbsp;&lt;/services&gt;<br />
+&nbsp;&lt;channel&gt;S19.2E-1-1019-10302&lt;/channel&gt;<br />
+&nbsp;&lt;channel_name&gt;arte HD&lt;/channel_name&gt;<br />
+&nbsp;&lt;channel_number&gt;4&lt;/channel_number&gt;<br />
+&nbsp;&lt;eventid&gt;64734&lt;/eventid&gt;<br />
+&nbsp;&lt;start_time&gt;1372853100&lt;/start_time&gt;<br />
+&nbsp;&lt;duration&gt;5700&lt;/duration&gt;<br />
+&nbsp;&lt;title&gt;Die schönsten Augen von Portugal&lt;/title&gt;<br />
+&nbsp;&lt;recording&gt;false&lt;/recording&gt;<br />
+&nbsp;&lt;diskspace&gt;1405401MB 156536MB 88%&lt;/diskspace&gt;<br />
+&nbsp;&lt;vdr&gt;<br />
+&nbsp;&nbsp;&lt;version&gt;2.0.2&lt;/version&gt;<br />
+&nbsp;&nbsp;&lt;plugins&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="softhddevice" version="0.6.0" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="dbus2vdr" version="12e" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="skinnopacity" version="0.1.2" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="play" version="0.0.14" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="menuorg" version="0.5.1" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="channellists" version="0.0.5" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="markad" version="0.1.5pre" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="tvguide" version="0.0.5" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="music" version="0.9.9-dev2" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="epgsearch" version="1.0.1.beta5" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="yaepghd" version="0.0.5_pre1" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="extrecmenu" version="1.2.2" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="streamdev-server" version="0.6.0-git" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="cinebars" version="0.1.0" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="conflictcheckonly" version="0.0.1" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="live" version="0.3.0" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="osdserver" version="0.1.3" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="quickepgsearch" version="0.0.1" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="restfulapi" version="0.1.2" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="sleeptimer" version="0.8.3-201205011650dev" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="vnsiserver3" version="0.9.1" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="femon" version="2.0.0" /&gt;<br />
+&nbsp;&nbsp;&nbsp;&lt;plugin name="epgsearchonly" version="0.0.1" /&gt;<br />
+&nbsp;&nbsp;&lt;/plugins&gt;<br />
+&nbsp;&lt;/vdr&gt;<br />
+&lt;/info&gt;<br />
 </code></div>
 <br />
 Instead of the channel it can also contain the currently playing video file:<br />
@@ -603,7 +700,7 @@ <h1 class="center"><a name="Recordings">Recordings</a></h1>
 <br />
 
 <div class="code"><code>
-GET http://127.0.0.1:8002/recordings.json?start=0&amp;limit=1i&amp;marks=true<br />
+GET http://127.0.0.1:8002/recordings.json?start=0&amp;limit=1&amp;marks=true<br />
 <br />
 {"recordings":[{<br />
 "number":0,<br />
@@ -639,6 +736,31 @@ <h2><a name="RecordingCut">Cut</a></h2>
 </code></div>
 <br />
 
+<br />
+<h2><a name="RecordingDelete">Delete</a></h2>
+
+This service can delete recordings by filename.<br />
+<br />
+Method: <b>POST and DELETE</b><br />
+<br />
+Examples: <br/>
+<br />
+<div class="code"><code>
+POST http://&lt;ip&gt;:&lt;port&gt;/recordings/delete<br />
+DELETE http://&lt;ip&gt;:&lt;port&gt;/recordings/delete<br />
+</code></div>
+<br />
+<b>Required Body Parameters:</b><br />
+
+<ul>
+<li>file - source path of the recording (use an url-encoder for this text if you use special characters)
+</ul>
+<br />
+<div class="code"><code>
+file=/var/lib/video.00/Asterix_in_Amerika/2011-06-19.12.40.1-0.rec<br />
+</code></div>
+<br />
+
 
 <br />
 <h2><a name="RecordingsMarks">Marks</a></h2>
@@ -680,19 +802,46 @@ <h2><a name="RecordingsMarks">Marks</a></h2>
 {'marks':['0:02:18.10','0:34:08.24']}
 </code></div>
 <br />
+
+
+
 <br />
+<h2><a name="RecordingMove">Move</a></h2>
 
+This service can move or copy recordings by filename.<br />
+<br />
+Method: <b>POST</b><br />
+<br />
+Examples: <br/>
+<br />
+<div class="code"><code>
+POST http://&lt;ip&gt;:&lt;port&gt;/recordings/delete<br />
+</code></div>
+<br />
+<b>Required Body Parameters:</b><br />
 
+<ul>
+<li>source - source path of the recording (use an url-encoder for this text if you use special characters)
+<li>target - relative path of the recording.
+</ul>
+<br />
+<div class="code"><code>
+source=/var/lib/video.00/Asterix_in_Amerika/2011-06-19.12.40.1-0.rec<br />
+target=Movies/Asterix_in_Amerika<br />
+copy_only=false
+</code></div>
+<br />
+
+<br />
 <h2><a name="RecordingPlay">Play</a></h2>
 
-This service tells your VDR to play or rewind a recording:<br />
+This service tells your VDR to play a recording:<br />
 <br />
-Method: <b>GET, POST</b><br />
+Method: <b>POST</b><br />
 <br />
 Examples: <br/>
 <br />
 <div class="code"><code>
-GET http://&lt;ip&gt;:&lt;port&gt;/recordings/play/&lt;number&gt;<br />
 POST http://&lt;ip&gt;:&lt;port&gt;/recordings/play/&lt;number&gt;
 </code></div>
 <br />
@@ -701,7 +850,28 @@ <h2><a name="RecordingPlay">Play</a></h2>
 <br />
 
 <ul>
-<li>&lt;number&gt; - The number of the recording you want to play (GET).
+<li>&lt;number&gt; - The number of the recording you want to play (POST).
+</ul>
+<br />
+<br />
+
+<h2><a name="RecordingRewind">Rewind</a></h2>
+
+This service tells your VDR to play a recording from the beginning:<br />
+<br />
+Method: <b>POST</b><br />
+<br />
+Examples: <br/>
+<br />
+<div class="code"><code>
+POST http://&lt;ip&gt;:&lt;port&gt;/recordings/rewind/&lt;number&gt;
+</code></div>
+<br />
+<br />
+<b>Description of the Parameters:</b>
+<br />
+
+<ul>
 <li>&lt;number&gt; - The number of the recording you want to rewind (POST).
 </ul>
 <br />

HISTORY

@@ -1,5 +1,8 @@
 VDR Plugin 'restfulapi' Revision History
 ----------------------------------------
+2013-07-03: Version 0.1.3
+
+- New revision.
 
 2011-05-16: Version 0.0.1
 

Makefile

@@ -57,7 +57,7 @@ PLGCONFDIR = $(CONFDIR)/plugins/$(PLUGIN)
 
 ### The object files (add further files here):
 
-OBJS = $(PLUGIN).o serverthread.o tools.o info.o channels.o events.o recordings.o remote.o timers.o statusmonitor.o osd.o jsonparser.o epgsearch.o searchtimers.o
+OBJS = $(PLUGIN).o serverthread.o tools.o info.o channels.o events.o recordings.o remote.o timers.o statusmonitor.o osd.o jsonparser.o epgsearch.o searchtimers.o audio.o
 CFGS = API.html
 
 ### The main target:

Makefile-1.7.33pre

@@ -57,7 +57,7 @@ DEFINES += -D_GNU_SOURCE -DPLUGIN_NAME_I18N='"$(PLUGIN)"'
 
 ### The object files (add further files here):
 
-OBJS = $(PLUGIN).o serverthread.o tools.o info.o channels.o events.o recordings.o remote.o timers.o statusmonitor.o osd.o jsonparser.o epgsearch.o searchtimers.o
+OBJS = $(PLUGIN).o serverthread.o tools.o info.o channels.o events.o recordings.o remote.o timers.o statusmonitor.o osd.o jsonparser.o epgsearch.o searchtimers.o audio.o
 
 ### The main target: