~ubuntu-branches/ubuntu/saucy/totem-pl-parser/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/reference/tmpl/totem-pl-parser.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Raphaël Hertzog
  • Date: 2011-04-10 16:59:54 UTC
  • mfrom: (1.5.8 sid)
  • Revision ID: james.westby@ubuntu.com-20110410165954-rxyx4stokepivd4o
Tags: 2.32.4-2
* Team upload.
* Add libquvi-dev to the dependencies of libtotem-pl-parser-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- ##### SECTION Title ##### -->
2
 
TotemPlParser
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
 
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
 
10
 
</para>
11
 
 
12
 
<!-- ##### SECTION See_Also ##### -->
13
 
<para>
14
 
 
15
 
</para>
16
 
 
17
 
<!-- ##### SECTION Stability_Level ##### -->
18
 
 
19
 
 
20
 
<!-- ##### SECTION Image ##### -->
21
 
 
22
 
 
23
 
<!-- ##### STRUCT TotemPlParser ##### -->
24
 
<para>
25
 
 
26
 
</para>
27
 
 
28
 
 
29
 
<!-- ##### SIGNAL TotemPlParser::entry-parsed ##### -->
30
 
<para>
31
 
 
32
 
</para>
33
 
 
34
 
@totemplparser: the object which received the signal.
35
 
@arg1: 
36
 
@arg2: 
37
 
 
38
 
<!-- ##### SIGNAL TotemPlParser::playlist-ended ##### -->
39
 
<para>
40
 
 
41
 
</para>
42
 
 
43
 
@totemplparser: the object which received the signal.
44
 
@arg1: 
45
 
 
46
 
<!-- ##### SIGNAL TotemPlParser::playlist-started ##### -->
47
 
<para>
48
 
 
49
 
</para>
50
 
 
51
 
@totemplparser: the object which received the signal.
52
 
@arg1: 
53
 
@arg2: 
54
 
 
55
 
<!-- ##### ARG TotemPlParser:debug ##### -->
56
 
<para>
57
 
 
58
 
</para>
59
 
 
60
 
<!-- ##### ARG TotemPlParser:disable-unsafe ##### -->
61
 
<para>
62
 
 
63
 
</para>
64
 
 
65
 
<!-- ##### ARG TotemPlParser:force ##### -->
66
 
<para>
67
 
 
68
 
</para>
69
 
 
70
 
<!-- ##### ARG TotemPlParser:recurse ##### -->
71
 
<para>
72
 
 
73
 
</para>
74
 
 
75
 
<!-- ##### TYPEDEF TotemPlParserClass ##### -->
76
 
<para>
77
 
 
78
 
</para>
79
 
 
80
 
 
81
 
<!-- ##### ENUM TotemPlParserResult ##### -->
82
 
<para>
83
 
 
84
 
</para>
85
 
 
86
 
@TOTEM_PL_PARSER_RESULT_UNHANDLED: 
87
 
@TOTEM_PL_PARSER_RESULT_ERROR: 
88
 
@TOTEM_PL_PARSER_RESULT_SUCCESS: 
89
 
@TOTEM_PL_PARSER_RESULT_IGNORED: 
90
 
@TOTEM_PL_PARSER_RESULT_CANCELLED: 
91
 
 
92
 
<!-- ##### ENUM TotemPlParserType ##### -->
93
 
<para>
94
 
 
95
 
</para>
96
 
 
97
 
@TOTEM_PL_PARSER_PLS: 
98
 
@TOTEM_PL_PARSER_M3U: 
99
 
@TOTEM_PL_PARSER_M3U_DOS: 
100
 
@TOTEM_PL_PARSER_XSPF: 
101
 
@TOTEM_PL_PARSER_IRIVER_PLA: 
102
 
 
103
 
<!-- ##### ENUM TotemPlParserError ##### -->
104
 
<para>
105
 
 
106
 
</para>
107
 
 
108
 
@TOTEM_PL_PARSER_ERROR_NO_DISC: 
109
 
@TOTEM_PL_PARSER_ERROR_MOUNT_FAILED: 
110
 
@TOTEM_PL_PARSER_ERROR_EMPTY_PLAYLIST: 
111
 
 
112
 
<!-- ##### FUNCTION totem_pl_parser_new ##### -->
113
 
<para>
114
 
 
115
 
</para>
116
 
 
117
 
@void: 
118
 
@Returns: 
119
 
 
120
 
 
121
 
<!-- ##### FUNCTION totem_pl_parser_parse ##### -->
122
 
<para>
123
 
 
124
 
</para>
125
 
 
126
 
@parser: 
127
 
@uri: 
128
 
@fallback: 
129
 
@Returns: 
130
 
 
131
 
 
132
 
<!-- ##### FUNCTION totem_pl_parser_parse_async ##### -->
133
 
<para>
134
 
 
135
 
</para>
136
 
 
137
 
@parser: 
138
 
@uri: 
139
 
@fallback: 
140
 
@cancellable: 
141
 
@callback: 
142
 
@user_data: 
143
 
 
144
 
 
145
 
<!-- ##### FUNCTION totem_pl_parser_parse_finish ##### -->
146
 
<para>
147
 
 
148
 
</para>
149
 
 
150
 
@parser: 
151
 
@async_result: 
152
 
@error: 
153
 
@Returns: 
154
 
 
155
 
 
156
 
<!-- ##### FUNCTION totem_pl_parser_parse_with_base ##### -->
157
 
<para>
158
 
 
159
 
</para>
160
 
 
161
 
@parser: 
162
 
@uri: 
163
 
@base: 
164
 
@fallback: 
165
 
@Returns: 
166
 
 
167
 
 
168
 
<!-- ##### FUNCTION totem_pl_parser_parse_with_base_async ##### -->
169
 
<para>
170
 
 
171
 
</para>
172
 
 
173
 
@parser: 
174
 
@uri: 
175
 
@base: 
176
 
@fallback: 
177
 
@cancellable: 
178
 
@callback: 
179
 
@user_data: 
180
 
 
181
 
 
182
 
<!-- ##### FUNCTION totem_pl_parser_save ##### -->
183
 
<para>
184
 
 
185
 
</para>
186
 
 
187
 
@parser: 
188
 
@playlist: 
189
 
@dest: 
190
 
@title: 
191
 
@type: 
192
 
@error: 
193
 
@Returns: 
194
 
 
195
 
 
196
 
<!-- ##### FUNCTION totem_pl_parser_parse_duration ##### -->
197
 
<para>
198
 
 
199
 
</para>
200
 
 
201
 
@duration: 
202
 
@debug: 
203
 
@Returns: 
204
 
 
205
 
 
206
 
<!-- ##### FUNCTION totem_pl_parser_parse_date ##### -->
207
 
<para>
208
 
 
209
 
</para>
210
 
 
211
 
@date_str: 
212
 
@debug: 
213
 
@Returns: 
214
 
 
215
 
 
216
 
<!-- ##### FUNCTION totem_pl_parser_add_ignored_scheme ##### -->
217
 
<para>
218
 
 
219
 
</para>
220
 
 
221
 
@parser: 
222
 
@scheme: 
223
 
 
224
 
 
225
 
<!-- ##### FUNCTION totem_pl_parser_add_ignored_mimetype ##### -->
226
 
<para>
227
 
 
228
 
</para>
229
 
 
230
 
@parser: 
231
 
@mimetype: 
232
 
 
233
 
 
234
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_URI ##### -->
235
 
<para>
236
 
 
237
 
</para>
238
 
 
239
 
 
240
 
 
241
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_GENRE ##### -->
242
 
<para>
243
 
 
244
 
</para>
245
 
 
246
 
 
247
 
 
248
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_TITLE ##### -->
249
 
<para>
250
 
 
251
 
</para>
252
 
 
253
 
 
254
 
 
255
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_AUTHOR ##### -->
256
 
<para>
257
 
 
258
 
</para>
259
 
 
260
 
 
261
 
 
262
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_ALBUM ##### -->
263
 
<para>
264
 
 
265
 
</para>
266
 
 
267
 
 
268
 
 
269
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_BASE ##### -->
270
 
<para>
271
 
 
272
 
</para>
273
 
 
274
 
 
275
 
 
276
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_VOLUME ##### -->
277
 
<para>
278
 
 
279
 
</para>
280
 
 
281
 
 
282
 
 
283
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_AUTOPLAY ##### -->
284
 
<para>
285
 
 
286
 
</para>
287
 
 
288
 
 
289
 
 
290
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_DURATION ##### -->
291
 
<para>
292
 
 
293
 
</para>
294
 
 
295
 
 
296
 
 
297
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_DURATION_MS ##### -->
298
 
<para>
299
 
 
300
 
</para>
301
 
 
302
 
 
303
 
 
304
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_STARTTIME ##### -->
305
 
<para>
306
 
 
307
 
</para>
308
 
 
309
 
 
310
 
 
311
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_ENDTIME ##### -->
312
 
<para>
313
 
 
314
 
</para>
315
 
 
316
 
 
317
 
 
318
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_COPYRIGHT ##### -->
319
 
<para>
320
 
 
321
 
</para>
322
 
 
323
 
 
324
 
 
325
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_ABSTRACT ##### -->
326
 
<para>
327
 
 
328
 
</para>
329
 
 
330
 
 
331
 
 
332
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_DESCRIPTION ##### -->
333
 
<para>
334
 
 
335
 
</para>
336
 
 
337
 
 
338
 
 
339
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_SUMMARY ##### -->
340
 
<para>
341
 
 
342
 
</para>
343
 
 
344
 
 
345
 
 
346
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_MOREINFO ##### -->
347
 
<para>
348
 
 
349
 
</para>
350
 
 
351
 
 
352
 
 
353
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_SCREENSIZE ##### -->
354
 
<para>
355
 
 
356
 
</para>
357
 
 
358
 
 
359
 
 
360
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_UI_MODE ##### -->
361
 
<para>
362
 
 
363
 
</para>
364
 
 
365
 
 
366
 
 
367
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_PUB_DATE ##### -->
368
 
<para>
369
 
 
370
 
</para>
371
 
 
372
 
 
373
 
 
374
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_FILESIZE ##### -->
375
 
<para>
376
 
 
377
 
</para>
378
 
 
379
 
 
380
 
 
381
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_LANGUAGE ##### -->
382
 
<para>
383
 
 
384
 
</para>
385
 
 
386
 
 
387
 
 
388
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_CONTACT ##### -->
389
 
<para>
390
 
 
391
 
</para>
392
 
 
393
 
 
394
 
 
395
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_IMAGE_URI ##### -->
396
 
<para>
397
 
 
398
 
</para>
399
 
 
400
 
 
401
 
 
402
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_DOWNLOAD_URI ##### -->
403
 
<para>
404
 
 
405
 
</para>
406
 
 
407
 
 
408
 
 
409
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_ID ##### -->
410
 
<para>
411
 
 
412
 
</para>
413
 
 
414
 
 
415
 
 
416
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_IS_PLAYLIST ##### -->
417
 
<para>
418
 
 
419
 
</para>
420
 
 
421
 
 
422
 
 
423
 
<!-- ##### MACRO TOTEM_PL_PARSER_FIELD_SUBTITLE_URI ##### -->
424
 
<para>
425
 
 
426
 
</para>
427
 
 
428
 
 
429