summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README96
1 files changed, 60 insertions, 36 deletions
diff --git a/README b/README
index 5a82acb..39a0312 100644
--- a/README
+++ b/README
@@ -15,13 +15,17 @@ Contents:
1. Description
2. Installation
-2.1 VDR 1.2.X
-2.2 VDR 1.3.X and above
+2.1 VDR 1.3.X and older
+2.2 VDR 1.4.X and above
+2.3 Updating from streamdev 0.3.x
3. Usage
3.1 Usage HTTP server
3.2 Usage VDR-to-VDR server
3.3 Usage VDR-to-VDR client
4. Other useful Plugins
+4.1 Plugins for VDR-to-VDR clients
+4.2 Plugins for Server
+4.3 Alternatives
5. Known Problems
@@ -57,7 +61,7 @@ the PROTOCOL file.
2. Installation:
----------------
-Let's say streamdev's version is 0.3.1 and vdr's version is 1.X.X. If you
+Let's say streamdev's version is 0.4.0 and vdr's version is 1.X.X. If you
use anything else please exchange the version numbers appropriately (this
way I don't have to update this section all the times;) ).
@@ -68,48 +72,62 @@ command line.
What's important is that the client requests a channel using its Unique Channel
ID. So, in order to find the channel at the server, it must have the same ID
that is used on the client. You can achieve this by putting the server's
-channels.conf on the client, preferably after scanning (in case you use 1.2.X
-with AutoPID or 1.3.X).
+channels.conf on the client, preferably after scanning.
If you want to drive additional Input-Devices (with different sources) on the
client, you can merge the channels.conf files. VDR will detect if the local
device or the network device can receive the channels.
-Last, but not least you have to put the provided streamdevhosts.conf.example
-into the "plugins" subfolder of your config-directory (which is equal to your
-video-directory if not specified otherwise), rename it to streamdevhosts.conf
-and adjust it to your needs. The syntax is the same as for svdrphosts.conf, so
-please consult VDR's documentation on how to fill that file, if you can't do
-it on-the-fly. For example, if you didn't specify a separate config-directory,
-and specified your video directory as "/video0", the file has to be put to
-/video0/plugins/streamdevhosts.conf.
+Last, but not least you have to copy the streamdev folder into the
+"plugins/streamdev" subfolder of VDR's config-directory (which is equal to your
+video-directory if not specified otherwise). For example, if you didn't specify
+a separate config-directory, and specified your video directory as "/video0",
+the directory has to be copied to /video0/plugins/streamdev.
+The directory contains a file named streamdevhosts.conf which you must adjust
+to your needs. The syntax is the same as for svdrphosts.conf, so please consult
+VDR's documentation on how to fill that file, if you can't do it on-the-fly.
-2.1 VDR 1.2.X:
---------------
+There's also a sample externremux.sh script in this directory. It is used by
+streamdev's external remux feature. The sample script uses mencoder. Please
+check the script for further information. You can specify a different script
+location with the -r parameter. The VDR commandline would then include a
+"-P 'streamdev-server -r /usr/local/bin/remux.sh'". Note the additional quotes,
+as otherwise -r will be passed to VDR and not to streamdev.
-It is recommended that you apply a patch to VDR that improves thread
-cancellation. You can work without it, but you _might_ have delays in switching
-(especially when using VDR-to-VDR streaming) that are around three seconds.
-cd vdr-1.X.X/PLUGINS/src
-tar xvfz vdr-streamdev-0.3.1.tgz
-ln -s streamdev-0.3.1 streamdev
-cd ../..
-patch -p1 <PLUGINS/src/streamdev/patches/thread.c.diff
-make [options, if necessary] vdr
-make [options, if necessary] plugins
+2.1 VDR 1.3.X and older:
+------------------------
+
+This version is not compatible to VDR releases older than 1.4.0. You will
+probably need one of the streamdev-0.3.x releases.
-2.2 VDR 1.3.X and above:
+2.2 VDR 1.4.X and above:
------------------------
cd vdr-1.X.X/PLUGINS/src
-tar xvfz vdr-streamdev-0.3.1.tgz
-ln -s streamdev-0.3.1 streamdev
+tar xvfz vdr-streamdev-0.4.0.tgz
+ln -s streamdev-0.4.0 streamdev
+cp -r streamdev/streamdev VDRCONFDIR/plugins/
cd ../..
make [options, if necessary] vdr
make [options, if necessary] plugins
+2.3 Updating from streamdev 0.3.x
+----------------------------------
+
+Starting with streamdev 0.4.0, all additional files are kept in a directory
+called "streamdev" inside VDR's plugin config directory. This affects in
+particular the file "streamdevhosts.conf". You will have to move it to its
+new location:
+
+mv VDRCONFDIR/plugins/streamdevhosts.conf VDRCONFDIR/plugins/streamdev/
+
+(Directory VDRCONFDIR/plugins/streamdev already exists, as you copied the
+whole folder from the sources directory as suggested above, right?)
+
+The new default location for externremux.sh is also in this directory.
+
3. Usage:
---------
@@ -120,12 +138,12 @@ can run in one VDR instance, if necessary.
The parameter "Suspend behaviour" allows you to specify how the server should
react in case the client requests a channel that would require switching the
-primary device (i.e. disrupt live-tv). If set to "Offer suspend mode" (the
-default), you will have a new entry in the main menu. Activating that will put
-the server into "Suspend Mode" (a picture is displayed on TV). Then, a client
-may switch the primary card to wherever it likes to. While watching TV (Suspend
-deactivated), the client may not switch the transponder on the primary device.
-If you set the behaviour to "Always suspended", there will be normal live-tv
+primary device (i.e. disrupt live-tv). If set to "Offer suspend mode", you will
+have a new entry in the main menu. Activating that will put the server into
+"Suspend Mode" (a picture is displayed on TV). Then, a client may switch the
+primary card to wherever it likes to. While watching TV (Suspend deactivated),
+the client may not switch the transponder on the primary device. If you set
+the behaviour to "Always suspended" (the default), there will be normal live-tv
on the server, but whenever a client decides to switch the transponder, the
server will lose it's live-tv. Set to "Never suspended", the server always
prevents the client from switching transponders. If you set "Client may
@@ -198,6 +216,11 @@ no need to restart VDR.
3.3 Usage VDR-to-VDR client:
----------------------------
+Streamdev-client adds a "Suspend Server" item to VDR's mainmenu. With the
+setup parameter "Hide Mainmenu Entry" you can hide this menu item if you don't
+need it. "Suspend Server" is only useful if the server runs in "Offer suspend
+mode" with "Client may suspend" enabled.
+
The parameter "Remote IP" uses an IP-Adress-Editor, where you can just enter
the IP number with the number keys on your remote. After three digits (or if
the next digit would result in an invalid IP adress, or if the first digit is
@@ -214,8 +237,9 @@ setting "Start Client" to yes. It is disabled by default, because it wouldn't
make much sense to start the client without specifying a server anyway. The
client is activated after you push the OK button, so there's no need to restart
VDR. Deactivation on-the-fly is not possible, so in order to deactivate the
-client, you will have to restart VDR. All other settings can be changed without
-restarting VDR.
+client, you will have to restart VDR. However requests to switch channels will
+be refused by streamdev-client once it has been deactivated. All other settings
+can be changed without restarting VDR.
The client will try to connect to the server (in case it isn't yet) whenever
a remote channel is requested. Just activate the client and switch to a