From c908ce13a73dfbe536ef8441df73ed1cda5f812f Mon Sep 17 00:00:00 2001
From: Antti Ajanki <antti.ajanki@iki.fi>
Date: Sat, 13 Nov 2010 17:39:59 +0200
Subject: document SVDRP and bookmarklet

---
 README.vdrplugin          | 39 +++++++++++++++++++++++++++++++++++++++
 src/vdr-plugin/webvideo.c |  8 ++++----
 2 files changed, 43 insertions(+), 4 deletions(-)

diff --git a/README.vdrplugin b/README.vdrplugin
index 02d8662..dc317f9 100644
--- a/README.vdrplugin
+++ b/README.vdrplugin
@@ -194,3 +194,42 @@ the path) of the downloaded file.
 
 An example script for transcoding the downloaded files to Ogg format
 is included in the source distribution in examples/transcode2ogg.sh.
+
+SVDRP interface
+---------------
+
+The plugin provides the following SVDRP commands:
+
+PLAY <url>
+    Stream a media file embedded on web page at <url>.
+DWLD <url>
+    Download a media file embedded on web page at <url>.
+
+Note: <url> should be the the address of the web page that contains
+the video, not the address of the video file itself. If you know the
+direct address to the video file, use xineliboutput SVDRP commands
+instead. See README for the list of supported sites.
+
+"Watch on VDR" bookmarklet
+--------------------------
+
+It is possible to send the video you are watching on your web browser
+to VDR and view it on your TV.
+
+1. Create a new bookmark on your web browser and paste the content of
+examples/watchonvdr_bookmarklet.js as the address of the new bookmark.
+If your VDR is running on a different machine than your browser, put
+VDR's address into vdrserver variable near the beginning of the
+bookmarklet.
+
+2. Set up the firewall of the VDR machine to allow incoming
+connections on port 43280 only from the machine where you are running
+your web browser. WARNING: Unrestricted access to port 43280 means
+that anyone in the Internet can instruct your VDR to play videos.
+
+3. Run examples/bookmarklet_proxy.py on VDR machine. If the SVDRP port
+differs from 2001 (the default changed to 6419 in VDR 1.7.15) use -s
+option.
+
+4. When viewing a video on one of the supported sites click "watch on
+VDR" bookmarklet. The video starts playing on VDR.
diff --git a/src/vdr-plugin/webvideo.c b/src/vdr-plugin/webvideo.c
index 002c58d..0c2cc9b 100644
--- a/src/vdr-plugin/webvideo.c
+++ b/src/vdr-plugin/webvideo.c
@@ -403,10 +403,10 @@ bool cPluginWebvideo::Service(const char *Id, void *Data)
 const char **cPluginWebvideo::SVDRPHelpPages(void)
 {
   static const char *HelpPages[] = {
-    "PLAY <file>\n"
-    "    Stream a media file.",
-    "DWLD <file>\n"
-    "    Download a media file.",
+    "PLAY <url>\n"
+    "    Stream a media file embedded on web page at <url>.",
+    "DWLD <url>\n"
+    "    Download a media file embedded on web page at <url>.",
     NULL
     };
   return HelpPages;
-- 
cgit v1.2.3