summaryrefslogtreecommitdiff
path: root/doc/html/classcDlna.html
blob: 904a2a2a5717bb8a78ef9f6cf63c8527cf10c5d4 (plain)
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
<!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: cDlna 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>cDlna Class Reference</h1><!-- doxytag: class="cDlna" --><code>#include &lt;<a class="el" href="dlna_8h-source.html">dlna.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for cDlna:</div>
<div class="dynsection">
<p><center><img src="classcDlna__coll__graph.png" border="0" usemap="#cDlna__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcDlna-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">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#a7ae0cc7b651bc6ccd82ef5da527d09a">getDeviceDescription</a> (const char *URLBase)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#0250d3903e7dcbdc8ebadfacd4e6fb50">registerProfile</a> (<a class="el" href="structDLNAProfile.html">DLNAProfile</a> *Profile, int Op=-1, const char *Ps=NULL, int Ci=-1, unsigned int Flags=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#e26b723ec63a60f397ce41bd95641dfa">registerMainProfiles</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#68a9565f022c7037c51ad337274d8c3a">getSupportedProtocols</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#992777f6c75dadd61bed6a75e03f1dfd">getProtocolInfo</a> (<a class="el" href="structDLNAProfile.html">DLNAProfile</a> *Prof)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#4eacc299d19fa20beba98d88d4230388">getProfileOfChannel</a> (cChannel *Channel)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#69dc71fe30130cafa399bb851ef5def8">getProfileOfRecording</a> (cRecording *Recording)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#4b5c30f707060b66c3980af70b7d8d08">getProfileOfFile</a> (cString File)</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 <a class="el" href="classcDlna.html">cDlna</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#1e30449831b903d508dae6640039fc25">getInstance</a> (void)</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02ebb94fd2cdff4bfb2da3267446d62b"></a><!-- doxytag: member="cDlna::cUPnPServer" ref="02ebb94fd2cdff4bfb2da3267446d62b" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcDlna.html#02ebb94fd2cdff4bfb2da3267446d62b">cUPnPServer</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Enable DLNA compliant media transfer<p>
This class enables media transmission with DLNA conformity. Its compliant with version 1.5 of the DLNA guidelines. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a7ae0cc7b651bc6ccd82ef5da527d09a"></a><!-- doxytag: member="cDlna::getDeviceDescription" ref="a7ae0cc7b651bc6ccd82ef5da527d09a" args="(const char *URLBase)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * cDlna::getDeviceDescription           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>URLBase</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Device description document<p>
This will return the device description document with service type definitions as well as some DLNA specific information<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The description document </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>URLBase</em>&nbsp;</td><td>the URLBase to be set in the document </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="1e30449831b903d508dae6640039fc25"></a><!-- doxytag: member="cDlna::getInstance" ref="1e30449831b903d508dae6640039fc25" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcDlna.html">cDlna</a> * cDlna::getInstance           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the instance of DLNA object<p>
This will create a DLNA object instance. It will return the same instance on subsequent calls.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the DLNA object instance </dd></dl>

</div>
</div><p>
<a class="anchor" name="4eacc299d19fa20beba98d88d4230388"></a><!-- doxytag: member="cDlna::getProfileOfChannel" ref="4eacc299d19fa20beba98d88d4230388" args="(cChannel *Channel)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> * cDlna::getProfileOfChannel           </td>
          <td>(</td>
          <td class="paramtype">cChannel *&nbsp;</td>
          <td class="paramname"> <em>Channel</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Profile of a channel<p>
Returns the DLNA profile of a VDR channel. It checks the video type to determine which profile will match.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the matching DLNA profile </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>Channel</em>&nbsp;</td><td>the channel of which the profile should created from </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="4b5c30f707060b66c3980af70b7d8d08"></a><!-- doxytag: member="cDlna::getProfileOfFile" ref="4b5c30f707060b66c3980af70b7d8d08" args="(cString File)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> * cDlna::getProfileOfFile           </td>
          <td>(</td>
          <td class="paramtype">cString&nbsp;</td>
          <td class="paramname"> <em>File</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Profile of a file<p>
Returns the DLNA profile of a file. It checks the content of the file with <em>ffmpeg</em> to determine which profile will match.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the matching DLNA profile </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>File</em>&nbsp;</td><td>the file of which the profile should be created from </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="69dc71fe30130cafa399bb851ef5def8"></a><!-- doxytag: member="cDlna::getProfileOfRecording" ref="69dc71fe30130cafa399bb851ef5def8" args="(cRecording *Recording)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> * cDlna::getProfileOfRecording           </td>
          <td>(</td>
          <td class="paramtype">cRecording *&nbsp;</td>
          <td class="paramname"> <em>Recording</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Profile of a recording<p>
Returns the DLNA profile of a VDR recording. It checks the video file to determine which profile will match.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the matching DLNA profile </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>Recording</em>&nbsp;</td><td>the recording of which the profile should be created from </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="992777f6c75dadd61bed6a75e03f1dfd"></a><!-- doxytag: member="cDlna::getProtocolInfo" ref="992777f6c75dadd61bed6a75e03f1dfd" args="(DLNAProfile *Prof)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * cDlna::getProtocolInfo           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> *&nbsp;</td>
          <td class="paramname"> <em>Prof</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Protocol info of a specific DLNA profile<p>
Returns the protocol info string of a specific DLNA profile with its options and flags.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the protocol info string of the profile </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>Prof</em>&nbsp;</td><td>the Profile of which the protocol info shall be returned </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="68a9565f022c7037c51ad337274d8c3a"></a><!-- doxytag: member="cDlna::getSupportedProtocols" ref="68a9565f022c7037c51ad337274d8c3a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * cDlna::getSupportedProtocols           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
CSV list of supported protocols<p>
Returns a comma separated list with all supported protocols. This means, it returns the list of protocols of the registered profiles.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>CSV list of registered protocols </dd></dl>

</div>
</div><p>
<a class="anchor" name="e26b723ec63a60f397ce41bd95641dfa"></a><!-- doxytag: member="cDlna::registerMainProfiles" ref="e26b723ec63a60f397ce41bd95641dfa" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cDlna::registerMainProfiles           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Registeres all known DLNA profiles<p>
Registeres all well known DLNA profiles with its known options 
</div>
</div><p>
<a class="anchor" name="0250d3903e7dcbdc8ebadfacd4e6fb50"></a><!-- doxytag: member="cDlna::registerProfile" ref="0250d3903e7dcbdc8ebadfacd4e6fb50" args="(DLNAProfile *Profile, int Op=&#45;1, const char *Ps=NULL, int Ci=&#45;1, unsigned int Flags=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cDlna::registerProfile           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structDLNAProfile.html">DLNAProfile</a> *&nbsp;</td>
          <td class="paramname"> <em>Profile</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Op</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>Ps</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Ci</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>Flags</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Registeres a DLNA profile<p>
Registeres a DLNA profile with specific optional options<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="common_8h-source.html">common.h</a> </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>Profile</em>&nbsp;</td><td>the DLNA profile </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Op</em>&nbsp;</td><td>operation mode </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Ps</em>&nbsp;</td><td>play speed (CSV list) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Ci</em>&nbsp;</td><td>conversion indication flag </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Flags</em>&nbsp;</td><td>DLNA flags </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>upnpcomponents/<a class="el" href="dlna_8h-source.html">dlna.h</a><li>upnpcomponents/dlna.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&nbsp;
<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>