Hi everybody,
today I've got the pleasure to announce my first plugin for VDR:
It's a community project of the yaVDR-Team who've welcomed me in their team some time ago.
But now to the important stuff:
RESTFULAPI - 0.1.0
What does the plugin offer?
* A modern alternative to SVDRP.based on the restful-concept
* HTTP based
* Full UTF8-Support.
* MultiUser-Support
* Different-Output-Formats: Json, Xml and Html
* Epgsearch integration
* OSD-Support
* Epg-Pictures and Channel-Logo Support
* and much more...
Which API-Calls are implemented?
* Channels
* Channelgroups
* Channellogos
* EPG
* EPG-Images
* Searching in the EPG (if epgsearch is installed)
* Info (plugins, services, currently playing recording, channel)
* Osd (default osd of vdr)
* Recordings (GET + DELETE)
* Remote control
* Timers (Creating, Updating, Deleting and retrieving)
* Searchtimers ( Creating, Deleting, retrieving and Searching the EPG-Info for the Searchtimers)
Are there any Issues?
* No, every known bug has been fixed before this release. But the plugin is huge and we haven't been able to test every tiny detail.
* But there is one more thing: The HTML-OSD is ugly, if you have an idea for a better Theme, let us know and I will add it to the plugin. (You only have to create a new osd.css file to change the theme.)
What should I do if I find bugs?
* Collect all information about the plugin you can find:
less /var/log/syslog | grep restfulapi
Your Request
And if possible a stracktrace
* Create a bug-report on yaVDR-Redmine:
https://bugs.yavdr.com/projects/vdr-restfulapi
Where do I find the API documentation?
* Download the plugin and open the API.html. It also contains a lot of examples.
Where can I download the plugin?
https://github.com/yavdr/vdr-plugin-restfulapi
What do I need to compile the plugin?
* cxxtools rev 1231 or newer (Important!! I treally has to be at least rev 1231, older revisions won't work.)
* VDR 1.7.18, older versions are not supported
How does the communication look like? (An example)
HTTP-Request, Method GET, URL: http://127.0.0.1:8002/timers.xml?start=0&limit=1
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<timers xmlns="http://www.domain.org/restfulapi/2011/timers-xml">
<timer>
<param name="id">C-71-71-61920:0:1309039200:2013:2200</param>
<param name="start">2013</param>
<param name="stop">2200</param>
<param name="priority">50</param>
<param name="lifetime">99</param>
<param name="event_id">27312</param>
<param name="weekdays">-------</param>
<param name="day">2011-06-26</param>
<param name="channel">1</param>
<param name="is_recording">false</param>
<param name="is_pending">false>/param>
<param name="filename">Mad Money>/param>
<param name="channelname">ORF1 HD>/param>
<param name="is_active">true>/param>
</timer>
<count>1</count><total>2</total>
</timers>
Display More
More examples are in the documentation (API.html).
nice regards