[kmplayer/0.11] doc: Add note about special kmplayer:// urls (from a question on kde-apps)

[Koos Vriezen]

Git commit 81eac500df35c99818505a3fade6deadd01606d1 by Koos Vriezen.
Committed on 22/08/2005 at 12:57.
Pushed by ltoscano into branch '0.11'.

Add note about special kmplayer:// urls (from a question on kde-apps)

svn path=/trunk/extragear/multimedia/doc/kmplayer/; revision=452033

M  +25   -2    doc/index.docbook

https://commits.kde.org/kmplayer/81eac500df35c99818505a3fade6deadd01606d1

diff --git a/doc/index.docbook b/doc/index.docbook
index c522501..726281e 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -111,7 +111,7 @@ to:kde-user at kde.org">The &kde; User Mailing list</ulink>.</para>
 <para>
     &kmplayer; can play from various sources. These sources are listed in the Source menu.
 </para>
-<section>
+<section id="tvsource">
     <title>TV</title>
     <para>
         &kmplayer; can play from TV cards using <application>MPlayer</application> or <acronym>XVideo</acronym> (using <application>kxvplayer</application>). Before you can watch TV, you have to configure which device to use and the TV channels. You can use the scanner from the configure dialog for this or edit the config file manually.
@@ -154,7 +154,7 @@ Also width and height attributes are ignored by the <acronym>XVideo</acronym> pl
 See the VDR section for more information about using <acronym>XVideo</acronym>.
 </para>
 </section>
-<section>
+<section id="vdrsource">
     <title>VDR</title>
 <para>
 To configure your VDR settings in kmplayer, see the Configure panel->Source->VDR->XVideo port panel. There should be ports detected, from which you should select one. You have to figure out what encoding you should use (eg. for western europe, that is PAL) and likely the correct one has a name with <quote>dvb</quote> in it.
@@ -175,6 +175,29 @@ EndSection
  Unfortunately, when ever you update your video driver, you have to reconfigure this setting. 
 </para>
 </section>
+<section id="kmplayer_url">
+    <title>Commandline</title>
+<para>
+    Internally for the sources, KMPlayer uses distinct names. At the time of
+    this writing these are "dvdnavsource", "dvdsource", "exitsource",
+    "hrefsource", "introsource", "pipesource", "tvscanner", "tvsource",
+    "urlsource", "vcdsource" and "vdrsource". When activated, they mostly
+    starts playing the list of playable items.
+</para>
+<para>
+    You can activate a particular source with a <filename>kmplayer://</filename> type <acronym>URL</acronym>. Just set the host part as the source name and optional path part as extra arguments, so for a channel for the "vdrsource" this could look like <filename>kmplayer://vdrsource/22 MTV 2</filename>. Eg. this script starts kmplayer using "dvdnavsource" and using <acronym>DCOP</acronym> to play fullscreen.
+    <programlisting>
+/bin/bash
+kmplayer kmplayer://dvdnavsource/ &
+PID=$!
+sleep 2
+dcop kmplayer-$PID KMediaPlayer toggleFullScreen
+    </programlisting>
+    For some sources this will not do much because they are not meant to be
+    for normal playing. For "pipesource" this is disabled because that
+    would be a bad security hole of course.
+</para>
+</section>
 </chapter>
 <chapter id="questionsanswersandtips">
     <title>Questions, Answers, and Tips</title>