1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>UPnP/DLNA plugin for VDR: cPluginUpnp Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>cPluginUpnp Class Reference</h1><!-- doxytag: class="cPluginUpnp" --><code>#include <<a class="el" href="upnp_8h-source.html">upnp.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for cPluginUpnp:</div>
<div class="dynsection">
<p><center><img src="classcPluginUpnp__coll__graph.png" border="0" usemap="#cPluginUpnp__coll__map" alt="Collaboration graph"></center>
<map name="cPluginUpnp__coll__map">
<area shape="rect" href="classcUPnPServer.html" title="{cUPnPServer\n|- mIsRunning\l- mIsEnabled\l- mServerAddr\l- mInterface\l- mIsAutoDetectionEnabled\l- mDeviceDescription\l- mWebServer\l- mMediaDatabase\l- mDeviceHandle\l- mConnectionManager\l- mContentDirectory\l|+ cUPnPServer()\l+ ~cUPnPServer()\l+ enable()\l+ start()\l+ restart()\l+ stop()\l+ autoDetectSettings()\l+ getServerAddress()\l+ getInterface()\l+ setServerPort()\l+ setInterface()\l+ setAddress()\l+ setAutoDetection()\l+ isEnabled()\l+ isRunning()\l+ isAutoDetectionEnabled()\l- init()\l- uninit()\l- upnpActionCallback()\l}" alt="" coords="331,2245,509,2773"><area shape="rect" href="classcContentDirectory.html" title="{cContentDirectory\n|- mMediaDatabase\l|+ cContentDirectory()\l+ ~cContentDirectory()\l+ subscribe()\l+ execute()\l+ setError()\l- Action()\l- getSearchCapabilities()\l- getSortCapabilities()\l- getSystemUpdateID()\l- browse()\l}" alt="" coords="275,1909,437,2133"><area shape="rect" href="classcUpnpService.html" title="{cUpnpService\n|# mDeviceHandle\l|+ ~cUpnpService()\l+ subscribe()\l+ execute()\l# setError()\l# parseIntegerValue()\l# parseStringValue()\l- cUpnpService()\l}" alt="" coords="229,1493,373,1669"><area shape="rect" href="classcConnectionManager.html" title="{cConnectionManager\n|- mDefaultConnection\l- mVirtualConnections\l- mSupportedProtocols\l|+ cConnectionManager()\l+ ~cConnectionManager()\l+ subscribe()\l+ execute()\l+ setError()\l- setError()\l- getProtocolInfo()\l- getCurrentConnectionIDs()\l- getCurrentConnectionInfo()\l- prepareForConnection()\l- connectionComplete()\l- createVirtualConnection()\l- destroyVirtualConnection()\l- getConnectionIDsCVS()\l}" alt="" coords="67,1861,251,2181"><area shape="rect" href="classcMediaDatabase.html" title="{cMediaDatabase\n|- mSystemUpdateID\l- mFactory\l- mObjects\l- mDatabase\l- mLastInsertObjectID\l|+ getSystemUpdateID()\l+ getContainerUpdateIDs()\l+ cMediaDatabase()\l+ ~cMediaDatabase()\l+ addFastFind()\l+ getObjectByFastFind()\l+ getObjectByID()\l+ browse()\l+ search()\l- getNextObjectID()\l- cacheObject()\l- prepareDatabase()\l- loadChannels()\l- loadRecordings()\l- updateChannelEPG()\l- updateRecordings()\l- init()\l- updateSystemID()\l- Action()\l}" alt="" coords="397,1365,573,1797"><area shape="rect" href="classcUPnPObjectFactory.html" title="{cUPnPObjectFactory\n|- mDatabase\l- mMediators\l- mInstance\l|+ registerMediator()\l+ unregisterMediator()\l+ createObject()\l+ getObject()\l+ saveObject()\l+ deleteObject()\l+ clearObject()\l+ getInstance()\l- findMediatorByID()\l- findMediatorByClass()\l- cUPnPObjectFactory()\l}" alt="" coords="405,973,565,1245"><area shape="rect" href="classcSQLiteDatabase.html" title="{cSQLiteDatabase\n|- mAutoCommit\l- mActiveTransaction\l- mLastRow\l- mRows\l- mDatabase\l- mInstance\l|+ ~cSQLiteDatabase()\l+ getResultCount()\l+ getLastInsertRowID()\l+ getResultRows()\l+ execStatement()\l+ startTransaction()\l+ commitTransaction()\l+ rollbackTransaction()\l+ setAutoCommit()\l+ sprintf()\l+ getInstance()\l- cSQLiteDatabase()\l- initialize()\l- initializeTables()\l- initializeTriggers()\l- exec()\l- getResultRow()\l}" alt="" coords="291,437,445,853"><area shape="rect" href="classcRows.html" title="{cRows\n|- mLastRow\l|+ ~cRows()\l+ fetchRow()\l- cRows()\l}" alt="" coords="432,261,528,373"><area shape="rect" href="classcRow.html" title="{cRow\n|- currentCol\l- ColCount\l- Columns\l- Values\l|+ ~cRow()\l+ Count()\l+ fetchColumn()\l+ fetchColumn()\l- cRow()\l}" alt="" coords="333,5,448,197"><area shape="rect" href="structcUPnPObjectID.html" title="{cUPnPObjectID\n|+ _ID\l|+ cUPnPObjectID()\l+ cUPnPObjectID()\l+ cUPnPObjectID()\l+ operator=()\l+ operator=()\l+ operator=()\l+ operator++()\l+ operator++()\l+ operator--()\l+ operator--()\l+ operator!=()\l+ operator==()\l+ operator!=()\l+ operator==()\l+ operator!=()\l+ operator==()\l+ operator unsigned int()\l+ operator int()\l+ operator long()\l+ operator*()\l}" alt="" coords="675,917,837,1301"><area shape="rect" href="classcUPnPWebServer.html" title="{cUPnPWebServer\n|- mRootdir\l- mInstance\l- mVirtualDirCallbacks\l|+ init()\l+ uninit()\l+ ~cUPnPWebServer()\l+ getInstance()\l+ getInfo()\l+ open()\l+ read()\l+ write()\l+ seek()\l+ close()\l- cUPnPWebServer()\l}" alt="" coords="611,1885,765,2157"><area shape="rect" href="classcVirtualConnection.html" title="{cVirtualConnection\n|- mRemoteProtocolInfo\l- mRemoteConnectionManager\l- mDirection\l- mRemoteConnectionID\l- mConnectionID\l- mAVTransportID\l- mRcsID\l- mStatus\l|- cVirtualConnection()\l- getStatusString()\l- getDirectionString()\l- getDirection()\l- getConnectionStatus()\l}" alt="" coords="5,1453,205,1709"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcPluginUpnp-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#584844bf459ec3eb7f6037f9cbb52fd5">Version</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#6fc36c7fdf1f0deed776897725bcda9b">Description</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#e2e63843aab64e06ce9b533f4893f7e0">CommandLineHelp</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#acbc8a8b3f67d08ed20ff1c8beaa4fe2">ProcessArgs</a> (int argc, char *argv[])</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#3f3daf1d0cd8d176cf1a349b9de10df7">Initialize</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#4738d8a5d72e56ec8b7b2f4f0b3549fe">Start</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#f59cbb0bb2a3872e33461fb46b4f79b4">Stop</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual cString </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#6b220cadefe502e7dfa4d70acea35083">Active</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual cMenuSetupPage * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#9b1891ed7e2d3aa56dae03b778d616ee">SetupMenu</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#3f8b911f1e452789110e69b11587ebce">SetupParse</a> (const char *Name, const char *Value)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcPluginUpnp.html#ac2101984519b848cc04370b5527c145">getConfigDirectory</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The UPnP/DLNA plugin<p>
This is a UPnP/DLNA media server plugin. It supports live-TV and recordings of the VDR as well as custom video files. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6b220cadefe502e7dfa4d70acea35083"></a><!-- doxytag: member="cPluginUpnp::Active" ref="6b220cadefe502e7dfa4d70acea35083" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cString cPluginUpnp::Active </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Message if still active<p>
This returns a message if the plugin is still active when a user attempts to shut down the VDR.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the message shown on the screen. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e2e63843aab64e06ce9b533f4893f7e0"></a><!-- doxytag: member="cPluginUpnp::CommandLineHelp" ref="e2e63843aab64e06ce9b533f4893f7e0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * cPluginUpnp::CommandLineHelp </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the command line help<p>
This returns the command line help output, which comes, when the user types <code>--help</code> into the command line.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the command line help </dd></dl>
</div>
</div><p>
<a class="anchor" name="6fc36c7fdf1f0deed776897725bcda9b"></a><!-- doxytag: member="cPluginUpnp::Description" ref="6fc36c7fdf1f0deed776897725bcda9b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * cPluginUpnp::Description </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the description<p>
This returns a brief description of the plugin and what it does.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the description of the plugin </dd></dl>
</div>
</div><p>
<a class="anchor" name="ac2101984519b848cc04370b5527c145"></a><!-- doxytag: member="cPluginUpnp::getConfigDirectory" ref="ac2101984519b848cc04370b5527c145" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * cPluginUpnp::getConfigDirectory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the configuration directory<p>
This returns the directory, where configuration files are stored.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the directory of the configuration files. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3f3daf1d0cd8d176cf1a349b9de10df7"></a><!-- doxytag: member="cPluginUpnp::Initialize" ref="3f3daf1d0cd8d176cf1a349b9de10df7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cPluginUpnp::Initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializes the plugin<p>
This initializes any background activities of the plugin.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns<ul>
<li><b><code>true</code>,</b> if initializing was successful</li><li><b><code>false</code>,</b> otherwise </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="acbc8a8b3f67d08ed20ff1c8beaa4fe2"></a><!-- doxytag: member="cPluginUpnp::ProcessArgs" ref="acbc8a8b3f67d08ed20ff1c8beaa4fe2" args="(int argc, char *argv[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cPluginUpnp::ProcessArgs </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>argv</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Processes the commandline arguments<p>
This processes the commandline arguments which the user specified at the start of the plugin.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns<ul>
<li><b><code>true</code>,</b> if processing was successful</li><li><b><code>false</code>,</b> otherwise </li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>the number of arguments in the list </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>the arguments as a char array </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9b1891ed7e2d3aa56dae03b778d616ee"></a><!-- doxytag: member="cPluginUpnp::SetupMenu" ref="9b1891ed7e2d3aa56dae03b778d616ee" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cMenuSetupPage * cPluginUpnp::SetupMenu </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Setup menu<p>
This creates a new instance of the setup menu, which is shown to the user when he enters the VDR plugin setup menu<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the menu of the plugin </dd></dl>
</div>
</div><p>
<a class="anchor" name="3f8b911f1e452789110e69b11587ebce"></a><!-- doxytag: member="cPluginUpnp::SetupParse" ref="3f8b911f1e452789110e69b11587ebce" args="(const char *Name, const char *Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cPluginUpnp::SetupParse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse setup variable<p>
This parses the setup variable with the according value. The value is a string representation and must be converted into the according data type.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns<ul>
<li><b><code>true</code>,</b> if parsing was successful</li><li><b><code>false</code>,</b> otherwise </li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Name</em> </td><td>the name of the variable </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>the according value of the variable </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4738d8a5d72e56ec8b7b2f4f0b3549fe"></a><!-- doxytag: member="cPluginUpnp::Start" ref="4738d8a5d72e56ec8b7b2f4f0b3549fe" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cPluginUpnp::Start </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts the plugin<p>
This starts the plugin. It starts additional threads, which are required by the plugin.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>returns<ul>
<li><b><code>true</code>,</b> if starting was successful</li><li><b><code>false</code>,</b> otherwise </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="f59cbb0bb2a3872e33461fb46b4f79b4"></a><!-- doxytag: member="cPluginUpnp::Stop" ref="f59cbb0bb2a3872e33461fb46b4f79b4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cPluginUpnp::Stop </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stops the plugin<p>
This stops the plugin and all its components
</div>
</div><p>
<a class="anchor" name="584844bf459ec3eb7f6037f9cbb52fd5"></a><!-- doxytag: member="cPluginUpnp::Version" ref="584844bf459ec3eb7f6037f9cbb52fd5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * cPluginUpnp::Version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the version of the plugin<p>
Returns the version string of the plugin<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string representation of the plugin version </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="upnp_8h-source.html">upnp.h</a><li>upnp.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 8 15:44:09 2009 for UPnP/DLNA plugin for VDR by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
