Skip to content

Commit 0851b00

Browse files
committed
mixed old README with parts from API.html
1 parent bbe2244 commit 0851b00

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README

+13-13
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ vdr-plugin-restfulapi
44
A plugin for Klaus Schmidingers Video Disk Recorder.
55

66

7-
Preface
8-
7+
Preface:
8+
---------
99
This plugin has been developed to offer a modern API for other developers to communicate with the VDR.
1010
The plugin supports the following outputs formats: xml, json and html.
1111
It also supports the folloing input formats: json and html.
@@ -14,26 +14,26 @@ For a detailed API description, see API.html
1414

1515
Someone who wants to install the plugin on his/her VDR needs following applications and libraries:
1616

17-
VDR 1.7.18
17+
VDR >= 1.7.18
1818
libcxxtools Rev. >= 1231, which is available as package for Ubuntu in the yavdr-PPA's
1919

20+
The plugin can be installed like any other standard plugin (unpack, soft link, make plugins).
21+
For Ubuntu it is available as package in the yavdr-PPA's
22+
2023
Someone who wants to develop an application which uses this API:
2124

2225
XML or JSON Parser (Depends on which format you want to use! - You can also use the html-format, but that one is more a proof for the restful concept and does not show all information!)
2326
URL Decoder or JSON Serializer (to send data to the webservice, required f.e. to create timers, searchtimers usw...)
2427

25-
Configuration
28+
Configuration:
29+
---------------
30+
With yaVDR create a new file called plugin.restfulapi.conf in /etc/vdr/plugins/ .
2631

27-
Create a new file called plugin.restfulapi.conf in /etc/vdr/plugins/ .
32+
### Command line parameters for vdr-plugin-restfulapi
33+
--port=8002 --ip=0.0.0.0 --epgimages=/var/cache/vdr/epgimages --channellogos=/usr/share/vdr/channel-logos
2834

29-
# # Command line parameters for vdr-plugin-restfulapi # --port=8002 --ip=0.0.0.0 --epgimages=/var/cache/vdr/epgimages --channellogos=/usr/share/vdr/channel-logos
3035

3136
Links:
32-
33-
Installation: http://www.yavdr.org/installation/
34-
Configuration: http://www.yavdr.org/configuration/
35-
Features: http://www.yavdr.org/features/
36-
Issue tracker: https://bugs.yavdr.com/projects/yavdr/issues/new
37+
-------
38+
Issue tracker: https://bugs.yavdr.com/projects/vdr-restfulapi/
3739
Package source: https://github.com/yavdr/vdr-plugin-restfulapi
38-
Team members: http://www.yavdr.org/developer-zone/team-members/
39-

audio.o

-1.45 MB
Binary file not shown.

0 commit comments

Comments
 (0)