Debian Codegraph @

src/README

raw
1 XBMC MediaPortal TV-client ('MPTV') PVR Add-on
2 ----------------------------------------------
3 Supported platforms (pvrclient):
4 - Windows
5 - Linux
6 - OSX (should work, not tested by me)
7
8 Dependencies:
9 - MediaPortal TVServer 1.1.x or 1.2.x. May work also on newer versions
10 - TVServerXBMC v1.1.0.100 or higher
11
12 THIS IS A PRELIMINARY README AND IS SUBJECT TO CHANGE!!!
13
14 Written by: Marcel Groothuis
15
16 Project's homepage: http://www.scintilla.utwente.nl/~marcelg/xbmc/
17 Latest version available at: project homepage
18
19 The MediaPortal TV-Server plugin "TVServerXMBC", status updates, screenshots,
20 last-minute patches can be found at:
21
22 http://www.scintilla.utwente.nl/~marcelg/xbmc/
23
24 This program is free software; you can redistribute it and/or modify
25 it under the terms of the GNU General Public License as published by
26 the Free Software Foundation; either version 2 of the License, or
27 any later version.
28 See the file LICENSE.GPL for more information.
29
30 ----------------------------------------------
31 General description:
32
33 This is a PVR Add-on for XBMC to access/control the MediaPortal TV-Server
34 backend from XBMC. It consists of two plugins: one for XBMC-PVR (1) and one for
35 the MediaPortal TV Server (2).
36
37 1. PVR client "XBMC_MPTV_win32.pvr" (for Windows):
38 This is the addon in this directory. After building the XBMC solution (and
39 the "pvrclient_mptv") this plugin file should be in addons\pvr\MediaPortal\
40
41 The MediaPortal TV Server is written in C#, making it difficult for XBMC to
42 control it directly. The TV Server connection of this AddOn depends on a
43 special plugin at the TV Server side, called TVServerXBMC.
44
45
46 2. TV Server plugin TVServerXBMC.dll/.exe (Windows only):
47 The TVServerXBMC plugin for the TV Server provides a socket interface to
48 XBMC to control the TV Server.
49 You can download it separately from:
50 http://www.scintilla.utwente.nl/~marcelg/xbmc
51 (It is not included by default in the XBMC pvr-testing2 branch, because it
52 will introduce a dependency on Visual C#.)
53 Please read the "readme.txt" file included in the TVServerXBMC zip files
54 for more information.
55
56 ----------------------------------------------
57 Detailed instructions:
58
59 (Preliminary...)
60
61 1. Install MediaPortal & MediaPortal TV Server (1.1.0)
62 (for older versions, you will need to recompile the TVServerXBMC plugin from source)
63 2. Use MediaPortal to make sure that the TV Server is working fine
64 3. Download the TVServerXBMC plugin for the TV Server (see my website)
65 4. Run the TVServerXBMC.exe (standalone version of the TV Server plugin) and
66 test it (see the readme.txt file included in the TVServerXBMC zip file).
67 Test for example the commands "ListTVChannels", "TimeshiftChannel"
68 (id is the first field returned by "ListTVChannels"). The "TimeshiftChannel"
69 command should return a URL like "rtsp://xxx.xxx.xxx.xx/stream2.0" on a
70 successful timeshift start. You can test this URL in VLC player. This should
71 work before proceeding to the next steps.
72 5. Test the rtsp stream in XBMC (you can just use the standard 9.11)
73 Create a playlist file "rtsp-stream.m3u" with the rtsp:// URL as content and
74 start it from inside XBMC.
75 Example contents rtsp-stream.m3u:
76 -----
77 rtsp://192.168.2.5/steam2.0
78 -----
79 When this is all working fine, you can finally build XBMC-pvr-testing2:
80
81 6. Build the XBMC solution in VC Express (pvr-testing2)
82 (check if XBMC_MPTV_win32.pvr was created succesfully in addons\pvr\MediaPortal)
83
84 ----------------------------------------------
85 MediaPortal PVR-addon settings:
86
87 Names are taken from addons/pvr/MediaPortal/settings.xml
88
89 host: "Mediaportal Hostname"
90 IP-address of the machine that runs the TVServerXBMC tool
91 Default: 127.0.0.1 (localhost)
92 port: "Mediaportal XBMC plugin Port"
93 Port number for the TVServerXBMC.
94 Default: 9596
95 ftaonly: "Free-to-air only"
96 Fetch/show only Free-to-air channels from MediaPortal TV
97 Default: false
98 useradio: "Include Radio"
99 Fetch also radio channels
100 Default: true
101 convertchar: "Character Set Conversion"
102 Enable character conversion to UTF-8.
103 Does nothing. Not yet implemented.
104 Default: false
105 timeout: "Connect timeout (s)"
106 Timeout on XBMC<->TVServerXBMC communication. After the selected timeout,
107 XBMC won't wait any longer for an answer from TVServerXBMC and abort the
108 selected action. Bottleneck is the timeshift start for TV channels. This
109 can take a long time, so don't make this
110 value too small.
111 Default: 6
112 tvgroup: "Import only TV Channels from group"
113 Allows you to fetch only the TV channels in a specific MediaPortal TVServer
114 group. E.g. you can create a "XBMC" group at the TVServer side that contains
115 only the TV channels that you want to appear at the XBMC side.
116 Default: <empty>
117 radiogroup: "Import only Radio Channels from group"
118 Allows you to fetch only the radio channels in a specific MediaPortal TVServer
119 group. E.g. you can create a "XBMC" group at the TVServer side that contains
120 only the radio channels that you want to appear at the XBMC side.
121 Default: <empty>
122 resolvertsphostname: "Convert hostname to IP-address"
123 Resolve the TVServer hostname in the rtsp:// streaming URLs to an ip-address
124 at the TVServerXBMC side. May help you with connection problems.
125 Default: true
126 readgenre: "EPG: Read genre strings (slow)"
127 Try to translate the EPG genre strings from MediaPortal into XBMC compatible
128 genre id's. However, depending on your EPG source, MediaPortal may return
129 strings in your local language. In this case, you can skip the genre
130 translation via readgenre=false.
131 The current implementation translates only English strings as workaround for
132 the mismatch between XBMC's genre ids and MediaPortals genre strings.
133 Default: false (= don't read and translate the genre strings)
134 sleeponrtspurl: "Wait after tuning a channel (ms)"
135 Adds an additional waiting time between the request to start a timeshift for
136 the selected channel and opening the rtsp:// stream in XBMC. You may need this
137 in case XBMC tries to open the returned rtsp:// stream before it is really
138 available. Typical symptom: the channel doesn't play the first time, but it
139 does play the second time.
140 Default: 0 (milliseconds)
141 userecordingsdir: "Play recordings directly (no streaming)"
142 By default, the recordings are played via rtsp:// streaming, which is not
143 needed when the TV Server and XBMC are running on the same machine.
144 When you enable this option, XBMC will use the filename of the recording
145 for playback instead of the rtsp::// url.
146 Default: false
147 recordingsdir: "Mediaportal recordings directory"
148 The previous setting can also be used on a different pc by sharing the
149 recordings directory over the network. You can use this option to specify
150 where XBMC can find the recordings.
151 Default: <empty>
152 ----------------------------------------------
153 Troubleshooting:
154 TODO...
155 You can reach me on the XBMC forum, user: margro or via
156 IRC: #xbmc, #xbmc-pvr user: margro
157 ----------------------------------------------
158 Links:
159
160 MediaPortal: http://www.team-mediaportal.com
161 TVServer plugin: http://www.scintilla.utwente.nl/~marcelg/xbmc
162