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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RygelDataSource: librygel-server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="librygel-server Reference Manual">
<link rel="up" href="api-main-list.html" title="librygel-server API Reference">
<link rel="prev" href="RygelContentDirectory.html" title="RygelContentDirectory">
<link rel="next" href="RygelDLNAAvailableSeekRangeRequest.html" title="RygelDLNAAvailableSeekRangeRequest">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#RygelDataSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RygelDataSource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#RygelDataSource.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#RygelDataSource.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="api-main-list.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RygelContentDirectory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RygelDLNAAvailableSeekRangeRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RygelDataSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RygelDataSource.top_of_page"></a>RygelDataSource</span></h2>
<p>RygelDataSource — Interface for all data streams provided by a <a class="link" href="RygelMediaEngine.html" title="RygelMediaEngine"><span class="type">RygelMediaEngine</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RygelDataSource.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GeeList</span> *
</td>
<td class="function_name">
<a class="link" href="RygelDataSource.html#rygel-data-source-preroll" title="rygel_data_source_preroll ()">rygel_data_source_preroll</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelDataSource.html#rygel-data-source-start" title="rygel_data_source_start ()">rygel_data_source_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelDataSource.html#rygel-data-source-freeze" title="rygel_data_source_freeze ()">rygel_data_source_freeze</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelDataSource.html#rygel-data-source-thaw" title="rygel_data_source_thaw ()">rygel_data_source_thaw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelDataSource.html#rygel-data-source-stop" title="rygel_data_source_stop ()">rygel_data_source_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelDataSource.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RygelDataSource.html#RygelDataSource-data-available" title="The “data-available” signal">data-available</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RygelDataSource.html#RygelDataSource-done" title="The “done” signal">done</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RygelDataSource.html#RygelDataSource-error" title="The “error” signal">error</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelDataSource.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RygelDataSource.html#RygelDataSourceError" title="enum RygelDataSourceError">RygelDataSourceError</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="RygelDataSource.html#RygelDataSource-struct" title="RygelDataSource">RygelDataSource</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RygelDataSource.html#RygelDataSourceIface" title="struct RygelDataSourceIface">RygelDataSourceIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelDataSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> RygelDataSource
</pre>
</div>
<div class="refsect1">
<a name="RygelDataSource.prerequisites"></a><h2>Prerequisites</h2>
<p>
RygelDataSource requires
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="RygelDataSource.description"></a><h2>Description</h2>
<p>When Rygel receives a HTTP request to stream a given file, it creates a RygelDataSource object for this new file and instructs the RygelDataSource to begin streaming. The RygelDataSource object will duly pass this request on to the underlying media framework, which will in turn pass streamed bytes back to the RygelDataSource object. The RygelDataSource passes these bytes to Rygel which adds them to the response it sends to the original HTTP request received from the client.</p>
<p>The data source is responsible for providing response header information describing the content being produced and a streamable byte-stream via its data_available signal. End-of-stream is signalled by the done signal, while errors are signalled by the error signal.</p>
<p>Implementations should fulfil at least these requirements:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>It should support at least the file:/<span class="bold"><strong></strong></span>/ URI scheme.</p></li>
<li class="listitem"><p>It should be able to stream any kind of binary data, regardless of the format.</p></li>
</ol></div>
<p>RygelDataSource instances are provided by <code class="function">rygel_media_engine_create_data_source()</code> which will return a derived <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> that uses a specific IO backend and/or multimedia backend to stream the multimedia data at the URI.</p>
<p>The derived RygelDataSource may provide additional API for use by the derived media engine. For instance, <code class="function">rygel_media_engine_get_transcoders()</code> may return derived <span class="type">RygelTranscoder</span> instances, and these may use that additional API in their <code class="function">create_source()</code> implementations, for instance to access resources or data structures of the specific multimedia backend.</p>
</div>
<div class="refsect1">
<a name="RygelDataSource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rygel-data-source-preroll"></a><h3>rygel_data_source_preroll ()</h3>
<pre class="programlisting"><span class="returnvalue">GeeList</span> *
rygel_data_source_preroll (<em class="parameter"><code><a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="RygelHTTPSeekRequest.html" title="RygelHTTPSeekRequest"><span class="type">RygelHTTPSeekRequest</span></a> *seek</code></em>,
<em class="parameter"><code><a class="link" href="RygelPlaySpeedRequest.html" title="RygelPlaySpeedRequest"><span class="type">RygelPlaySpeedRequest</span></a> *playspeed</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Preroll the data with the given seek and playspeed.</p>
<p><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will be returned in <em class="parameter"><code>error</code></em> </p>
<p>if anything goes wrong while prerolling the stream. Throws DataSourceError.SEEK_FAILED if a seek method is not supported or the range is not fulfillable. Throws PLAYSPEED_FAILED if the rate is not supported or fulfillable. </p>
<div class="refsect3">
<a name="rygel-data-source-preroll.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>seek</p></td>
<td class="parameter_description">
<p> . </p>
<p>optional seek/range specifier </p>
<p>. </p>
</td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>playspeed</p></td>
<td class="parameter_description">
<p> . </p>
<p>optional playback rate specifier. This will only be provided when a scaled rate is requested (the speed will not be 0.0 or 1.0) </p>
<p>. </p>
</td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rygel-data-source-preroll.returns"></a><h4>Returns</h4>
<p>List of HTTPResponseElements appropriate for the content request and optional seek/playspeed (e.g. Content-Range, TimeSeekRange.dlna.org, etc) or null/empty list if none are appropriate. Note: the list will be processed in-order by the caller. </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-data-source-start"></a><h3>rygel_data_source_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_data_source_start (<em class="parameter"><code><a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *self</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Start producing the data.</p>
<p><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will be returned in <em class="parameter"><code>error</code></em> </p>
<p>if anything goes wrong while starting the stream. </p>
<div class="refsect3">
<a name="rygel-data-source-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-data-source-freeze"></a><h3>rygel_data_source_freeze ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_data_source_freeze (<em class="parameter"><code><a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *self</code></em>);</pre>
<p>Temporarily stop data generation.</p>
<p>May be called multiple times. If the source is already frozen, the following calles to freeze are ignored. After callging <code class="function">freeze()</code>, so <code class="function">data_available()</code> signal should be emitted.</p>
<div class="refsect3">
<a name="rygel-data-source-freeze.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-data-source-thaw"></a><h3>rygel_data_source_thaw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_data_source_thaw (<em class="parameter"><code><a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *self</code></em>);</pre>
<p>Resume data generation from a previous freeze call.</p>
<p>May be called multiple times, will be ignored if the source is not frozen.</p>
<div class="refsect3">
<a name="rygel-data-source-thaw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-data-source-stop"></a><h3>rygel_data_source_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_data_source_stop (<em class="parameter"><code><a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *self</code></em>);</pre>
<p>Stop producing data. After calling <code class="function">stop()</code>, calling <code class="function">start()</code> should produce data from the beginning and not resume streaming.</p>
<div class="refsect3">
<a name="rygel-data-source-stop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RygelDataSource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RygelDataSourceError"></a><h3>enum RygelDataSourceError</h3>
<div class="refsect3">
<a name="RygelDataSourceError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RYGEL-DATA-SOURCE-ERROR-GENERAL:CAPS"></a>RYGEL_DATA_SOURCE_ERROR_GENERAL</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RYGEL-DATA-SOURCE-ERROR-SEEK-FAILED:CAPS"></a>RYGEL_DATA_SOURCE_ERROR_SEEK_FAILED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RYGEL-DATA-SOURCE-ERROR-PLAYSPEED-FAILED:CAPS"></a>RYGEL_DATA_SOURCE_ERROR_PLAYSPEED_FAILED</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RygelDataSource-struct"></a><h3>RygelDataSource</h3>
<pre class="programlisting">typedef struct _RygelDataSource RygelDataSource;</pre>
<p>Interface for all data streams provided by a <a class="link" href="RygelMediaEngine.html" title="RygelMediaEngine"><span class="type">RygelMediaEngine</span></a>.</p>
<p>When Rygel receives a HTTP request to stream a given file, it creates a RygelDataSource object for this new file and instructs the RygelDataSource to begin streaming. The RygelDataSource object will duly pass this request on to the underlying media framework, which will in turn pass streamed bytes back to the RygelDataSource object. The RygelDataSource passes these bytes to Rygel which adds them to the response it sends to the original HTTP request received from the client.</p>
<p>The data source is responsible for providing response header information describing the content being produced and a streamable byte-stream via its data_available signal. End-of-stream is signalled by the done signal, while errors are signalled by the error signal.</p>
<p>Implementations should fulfil at least these requirements:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>It should support at least the file:/<span class="bold"><strong></strong></span>/ URI scheme.</p></li>
<li class="listitem"><p>It should be able to stream any kind of binary data, regardless of the format.</p></li>
</ol></div>
<p>RygelDataSource instances are provided by <code class="function">rygel_media_engine_create_data_source()</code> which will return a derived <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> that uses a specific IO backend and/or multimedia backend to stream the multimedia data at the URI.</p>
<p>The derived RygelDataSource may provide additional API for use by the derived media engine. For instance, <code class="function">rygel_media_engine_get_transcoders()</code> may return derived <span class="type">RygelTranscoder</span> instances, and these may use that additional API in their <code class="function">create_source()</code> implementations, for instance to access resources or data structures of the specific multimedia backend.</p>
</div>
<hr>
<div class="refsect2">
<a name="RygelDataSourceIface"></a><h3>struct RygelDataSourceIface</h3>
<pre class="programlisting">struct RygelDataSourceIface {
GTypeInterface parent_iface;
GeeList* (*preroll) (RygelDataSource* self, RygelHTTPSeekRequest* seek, RygelPlaySpeedRequest* playspeed, GError** error);
void (*start) (RygelDataSource* self, GError** error);
void (*freeze) (RygelDataSource* self);
void (*thaw) (RygelDataSource* self);
void (*stop) (RygelDataSource* self);
};
</pre>
<p>Interface for creating <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> implementations.</p>
<div class="refsect3">
<a name="RygelDataSourceIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="RygelDataSourceIface.parent-iface"></a>parent_iface</code></em>;</p></td>
<td class="struct_member_description"><p>the parent interface structure</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelDataSourceIface.preroll"></a>preroll</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelDataSource.html#rygel-data-source-preroll" title="rygel_data_source_preroll ()"><code class="function">rygel_data_source_preroll()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelDataSourceIface.start"></a>start</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelDataSource.html#rygel-data-source-start" title="rygel_data_source_start ()"><code class="function">rygel_data_source_start()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelDataSourceIface.freeze"></a>freeze</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelDataSource.html#rygel-data-source-freeze" title="rygel_data_source_freeze ()"><code class="function">rygel_data_source_freeze()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelDataSourceIface.thaw"></a>thaw</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelDataSource.html#rygel-data-source-thaw" title="rygel_data_source_thaw ()"><code class="function">rygel_data_source_thaw()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelDataSourceIface.stop"></a>stop</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelDataSource.html#rygel-data-source-stop" title="rygel_data_source_stop ()"><code class="function">rygel_data_source_stop()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RygelDataSource.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RygelDataSource-data-available"></a><h3>The <code class="literal">“data-available”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *data_source,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data_length1,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> data,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the source has produced some data.</p>
<p>This signal has to be emitted in the main thread.</p>
<div class="refsect3">
<a name="RygelDataSource-data-available.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data_source</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_length1</p></td>
<td class="parameter_description"><p>length of the <em class="parameter"><code>data</code></em>
array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RygelDataSource-done"></a><h3>The <code class="literal">“done”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *data_source,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the source does not have data anymore.</p>
<p>This signal has to be emitted in the main thread.</p>
<div class="refsect3">
<a name="RygelDataSource-done.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data_source</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RygelDataSource-error"></a><h3>The <code class="literal">“error”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> *data_source,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the source encounters a problem during data generation.</p>
<p>This signal has to be emitted in the main thread.</p>
<div class="refsect3">
<a name="RygelDataSource-error.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data_source</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelDataSource.html" title="RygelDataSource"><span class="type">RygelDataSource</span></a> instance that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|
