~ubuntu-branches/ubuntu/quantal/totem-pl-parser/quantal
» Revision
1.1.4
: docs/reference/html/totem-pl-parser-totem-pl-parser.html
« back to all changes in this revision
Viewing changes to docs/reference/html/totem-pl-parser-totem-pl-parser.html
- browse files at revision 1.1.4
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.4
- Committer: Bazaar Package Importer
- Author(s): Pedro Fragoso
- Date: 2008-03-10 13:48:17 UTC
- mto: (1.3.1 experimental) (50.1.1 experimental)
- mto: This revision was merged to the branch mainline in revision 7.
- Revision ID: james.westby@ubuntu.com-20080310134817-m8ds5eaaozb35pwi
Tags: upstream-2.22.1
Import upstream version 2.22.1
- files added:
- totem-pl-parser.spec
- files modified:
- ChangeLog
added
removed
docs/reference/html/totem-pl-parser-totem-pl-parser.html
29
29
 | 
30
30
<a href="#id383082" class="shortcut">Properties</a>
31
31
 | 
32
<a href="#id383118" class="shortcut">Signals</a></nobr></td></tr>
32
<a href="#id383117" class="shortcut">Signals</a></nobr></td></tr>
33
33
</table>
34
34
<div class="refentry" lang="en">
35
35
<a name="totem-pl-parser-totem-pl-parser"></a><div class="titlepage"></div>
43
43
<td valign="top" align="right"></td>
44
44
</tr></table></div>
45
45
<div class="refsect1" lang="en">
46
<a name="id355458"></a><h2>Stability Level</h2>
46
<a name="id355457"></a><h2>Stability Level</h2>
47
47
Stable, unless otherwise indicated
48
48
</div>
49
49
<div class="refsynopsisdiv">
190
190
</pre>
191
191
</div>
192
192
<div class="refsect1" lang="en">
193
<a name="id383118"></a><h2>Signals</h2>
193
<a name="id383117"></a><h2>Signals</h2>
194
194
<pre class="synopsis">
195
195
196
196
"<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser-entry-parsed">entry-parsed</a>" : Run Last
225
225
<p>
226
226
</p>
227
227
<div class="example">
228
<a name="id383190"></a><p class="title"><b>Example 2. Getting Metadata from Entries</b></p>
228
<a name="id383189"></a><p class="title"><b>Example 2. Getting Metadata from Entries</b></p>
229
229
<div class="example-contents"><pre class="programlisting">
230
230
static void
231
231
entry_parsed (TotemPlParser *parser, const gchar *uri, GHashTable *metadata, gpointer user_data)
243
243
<p>
244
244
</p>
245
245
<div class="example">
246
<a name="id383208"></a><p class="title"><b>Example 3. Writing a Playlist</b></p>
246
<a name="id383207"></a><p class="title"><b>Example 3. Writing a Playlist</b></p>
247
247
<div class="example-contents"><pre class="programlisting">
248
248
void
249
249
parser_func (GtkTreeModel *model, GtkTreeIter *iter, gchar **uri, gchar **title, gboolean *custom_title, gpointer user_data)
282
282
<div class="refsect1" lang="en">
283
283
<a name="id383230"></a><h2>Details</h2>
284
284
<div class="refsect2" lang="en">
285
<a name="id383240"></a><h3>
285
<a name="id383239"></a><h3>
286
286
<a name="TotemPlParser"></a>TotemPlParser</h3>
287
<a class="indexterm" name="id383250"></a><pre class="programlisting">typedef struct TotemPlParser TotemPlParser;
287
<a class="indexterm" name="id383249"></a><pre class="programlisting">typedef struct TotemPlParser TotemPlParser;
288
288
</pre>
289
289
<p>
290
290
All the fields in the <a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser"><span class="type">TotemPlParser</span></a> structure are private and should never be accessed directly.</p>
294
294
</div>
295
295
<hr>
296
296
<div class="refsect2" lang="en">
297
<a name="id383274"></a><h3>
297
<a name="id383273"></a><h3>
298
298
<a name="TotemPlParserClass"></a>TotemPlParserClass</h3>
299
<a class="indexterm" name="id383284"></a><pre class="programlisting">typedef struct TotemPlParserClass TotemPlParserClass;
299
<a class="indexterm" name="id383283"></a><pre class="programlisting">typedef struct TotemPlParserClass TotemPlParserClass;
300
300
</pre>
301
301
<p>
302
302
The class structure for the <a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser"><span class="type">TotemPlParser</span></a> type.</p>
306
306
</div>
307
307
<hr>
308
308
<div class="refsect2" lang="en">
309
<a name="id383308"></a><h3>
309
<a name="id383307"></a><h3>
310
310
<a name="TotemPlParserResult"></a>enum TotemPlParserResult</h3>
311
311
<a class="indexterm" name="id383318"></a><pre class="programlisting">typedef enum
312
312
{
349
349
</div>
350
350
<hr>
351
351
<div class="refsect2" lang="en">
352
<a name="id383433"></a><h3>
352
<a name="id383432"></a><h3>
353
353
<a name="TotemPlParserType"></a>enum TotemPlParserType</h3>
354
<a class="indexterm" name="id383444"></a><pre class="programlisting">typedef enum
354
<a class="indexterm" name="id383443"></a><pre class="programlisting">typedef enum
355
355
{
356
356
TOTEM_PL_PARSER_PLS,
357
357
TOTEM_PL_PARSER_M3U,
400
400
<div class="refsect2" lang="en">
401
401
<a name="id383566"></a><h3>
402
402
<a name="TotemPlParserError"></a>enum TotemPlParserError</h3>
403
<a class="indexterm" name="id383577"></a><pre class="programlisting">typedef enum
403
<a class="indexterm" name="id383576"></a><pre class="programlisting">typedef enum
404
404
{
405
405
TOTEM_PL_PARSER_ERROR_VFS_OPEN,
406
406
TOTEM_PL_PARSER_ERROR_VFS_WRITE,
432
432
<div class="refsect2" lang="en">
433
433
<a name="id383643"></a><h3>
434
434
<a name="TotemPlParserIterFunc"></a>TotemPlParserIterFunc ()</h3>
435
<a class="indexterm" name="id383654"></a><pre class="programlisting">void (*TotemPlParserIterFunc) (<a
435
<a class="indexterm" name="id383653"></a><pre class="programlisting">void (*TotemPlParserIterFunc) (<a
436
436
href="../gtk/GtkTreeModel.html"
437
437
>GtkTreeModel</a> *model,
438
438
<a
505
505
</div>
506
506
<hr>
507
507
<div class="refsect2" lang="en">
508
<a name="id383879"></a><h3>
508
<a name="id383878"></a><h3>
509
509
<a name="totem-pl-parser-new"></a>totem_pl_parser_new ()</h3>
510
510
<a class="indexterm" name="id383889"></a><pre class="programlisting"><a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a>* totem_pl_parser_new (void);</pre>
511
511
<p>
524
524
</div>
525
525
<hr>
526
526
<div class="refsect2" lang="en">
527
<a name="id383937"></a><h3>
527
<a name="id383936"></a><h3>
528
528
<a name="totem-pl-parser-parse"></a>totem_pl_parser_parse ()</h3>
529
<a class="indexterm" name="id383947"></a><pre class="programlisting"><a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParserResult">TotemPlParserResult</a> totem_pl_parser_parse (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
529
<a class="indexterm" name="id383946"></a><pre class="programlisting"><a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParserResult">TotemPlParserResult</a> totem_pl_parser_parse (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
530
530
const char *url,
531
531
<a
532
532
href="../glib/glib-Basic-Types.html#gboolean"
567
567
</div>
568
568
<hr>
569
569
<div class="refsect2" lang="en">
570
<a name="id384064"></a><h3>
570
<a name="id384063"></a><h3>
571
571
<a name="totem-pl-parser-parse-with-base"></a>totem_pl_parser_parse_with_base ()</h3>
572
<a class="indexterm" name="id384074"></a><pre class="programlisting"><a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParserResult">TotemPlParserResult</a> totem_pl_parser_parse_with_base (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
572
<a class="indexterm" name="id384073"></a><pre class="programlisting"><a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParserResult">TotemPlParserResult</a> totem_pl_parser_parse_with_base (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
573
573
const char *url,
574
574
const char *base,
575
575
<a
619
619
<div class="refsect2" lang="en">
620
620
<a name="id384214"></a><h3>
621
621
<a name="totem-pl-parser-write"></a>totem_pl_parser_write ()</h3>
622
<a class="indexterm" name="id384225"></a><pre class="programlisting"><a
622
<a class="indexterm" name="id384224"></a><pre class="programlisting"><a
623
623
href="../glib/glib-Basic-Types.html#gboolean"
624
624
>gboolean</a> totem_pl_parser_write (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
625
625
<a
704
704
</div>
705
705
<hr>
706
706
<div class="refsect2" lang="en">
707
<a name="id384490"></a><h3>
707
<a name="id384489"></a><h3>
708
708
<a name="totem-pl-parser-write-with-title"></a>totem_pl_parser_write_with_title ()</h3>
709
709
<a class="indexterm" name="id384500"></a><pre class="programlisting"><a
710
710
href="../glib/glib-Basic-Types.html#gboolean"
795
795
</div>
796
796
<hr>
797
797
<div class="refsect2" lang="en">
798
<a name="id384782"></a><h3>
798
<a name="id384781"></a><h3>
799
799
<a name="totem-pl-parser-parse-duration"></a>totem_pl_parser_parse_duration ()</h3>
800
<a class="indexterm" name="id384792"></a><pre class="programlisting"><a
800
<a class="indexterm" name="id384791"></a><pre class="programlisting"><a
801
801
href="../glib/glib-Basic-Types.html#gint64"
802
802
>gint64</a> totem_pl_parser_parse_duration (const char *duration,
803
803
<a
834
834
</div>
835
835
<hr>
836
836
<div class="refsect2" lang="en">
837
<a name="id384875"></a><h3>
837
<a name="id384874"></a><h3>
838
838
<a name="totem-pl-parser-parse-date"></a>totem_pl_parser_parse_date ()</h3>
839
<a class="indexterm" name="id384886"></a><pre class="programlisting"><a
839
<a class="indexterm" name="id384885"></a><pre class="programlisting"><a
840
840
href="../glib/glib-Basic-Types.html#guint64"
841
841
>guint64</a> totem_pl_parser_parse_date (const char *date_str,
842
842
<a
873
873
</div>
874
874
<hr>
875
875
<div class="refsect2" lang="en">
876
<a name="id384969"></a><h3>
876
<a name="id384968"></a><h3>
877
877
<a name="totem-pl-parser-resolve-url"></a>totem_pl_parser_resolve_url ()</h3>
878
<a class="indexterm" name="id384979"></a><pre class="programlisting">char* totem_pl_parser_resolve_url (const char *base,
878
<a class="indexterm" name="id384978"></a><pre class="programlisting">char* totem_pl_parser_resolve_url (const char *base,
879
879
const char *url);</pre>
880
880
<p>
881
881
Returns the absolute URI of <em class="parameter"><code>url</code></em>, resolving any relative
910
910
</div>
911
911
<hr>
912
912
<div class="refsect2" lang="en">
913
<a name="id385075"></a><h3>
913
<a name="id385074"></a><h3>
914
914
<a name="totem-pl-parser-add-ignored-scheme"></a>totem_pl_parser_add_ignored_scheme ()</h3>
915
915
<a class="indexterm" name="id385085"></a><pre class="programlisting">void totem_pl_parser_add_ignored_scheme (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
916
916
const char *scheme);</pre>
940
940
<div class="refsect2" lang="en">
941
941
<a name="id385154"></a><h3>
942
942
<a name="totem-pl-parser-add-ignored-mimetype"></a>totem_pl_parser_add_ignored_mimetype ()</h3>
943
<a class="indexterm" name="id385165"></a><pre class="programlisting">void totem_pl_parser_add_ignored_mimetype
943
<a class="indexterm" name="id385164"></a><pre class="programlisting">void totem_pl_parser_add_ignored_mimetype
944
944
(<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
945
945
const char *mimetype);</pre>
946
946
<p>
967
967
</div>
968
968
<hr>
969
969
<div class="refsect2" lang="en">
970
<a name="id385235"></a><h3>
970
<a name="id385234"></a><h3>
971
971
<a name="TOTEM-PL-PARSER-FIELD-URL:CAPS"></a>TOTEM_PL_PARSER_FIELD_URL</h3>
972
<a class="indexterm" name="id385245"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_URL "url"
972
<a class="indexterm" name="id385244"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_URL "url"
973
973
</pre>
974
974
<p>
975
975
Metadata field for an entry's URL.</p>
979
979
</div>
980
980
<hr>
981
981
<div class="refsect2" lang="en">
982
<a name="id385262"></a><h3>
982
<a name="id385261"></a><h3>
983
983
<a name="TOTEM-PL-PARSER-FIELD-GENRE:CAPS"></a>TOTEM_PL_PARSER_FIELD_GENRE</h3>
984
984
<a class="indexterm" name="id385272"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_GENRE "genre"
985
985
</pre>
991
991
</div>
992
992
<hr>
993
993
<div class="refsect2" lang="en">
994
<a name="id385289"></a><h3>
994
<a name="id385288"></a><h3>
995
995
<a name="TOTEM-PL-PARSER-FIELD-TITLE:CAPS"></a>TOTEM_PL_PARSER_FIELD_TITLE</h3>
996
<a class="indexterm" name="id385300"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_TITLE "title"
996
<a class="indexterm" name="id385299"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_TITLE "title"
997
997
</pre>
998
998
<p>
999
999
Metadata field for an entry's displayable title.</p>
1005
1005
<div class="refsect2" lang="en">
1006
1006
<a name="id385316"></a><h3>
1007
1007
<a name="TOTEM-PL-PARSER-FIELD-AUTHOR:CAPS"></a>TOTEM_PL_PARSER_FIELD_AUTHOR</h3>
1008
<a class="indexterm" name="id385327"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_AUTHOR "author"
1008
<a class="indexterm" name="id385326"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_AUTHOR "author"
1009
1009
</pre>
1010
1010
<p>
1011
1011
Metadata field for an entry's author/composer/director.</p>
1017
1017
<div class="refsect2" lang="en">
1018
1018
<a name="id385344"></a><h3>
1019
1019
<a name="TOTEM-PL-PARSER-FIELD-BASE:CAPS"></a>TOTEM_PL_PARSER_FIELD_BASE</h3>
1020
<a class="indexterm" name="id385355"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_BASE "base"
1020
<a class="indexterm" name="id385354"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_BASE "base"
1021
1021
</pre>
1022
1022
<p>
1023
1023
Metadata field for an entry's base path.</p>
1029
1029
<div class="refsect2" lang="en">
1030
1030
<a name="id385371"></a><h3>
1031
1031
<a name="TOTEM-PL-PARSER-FIELD-VOLUME:CAPS"></a>TOTEM_PL_PARSER_FIELD_VOLUME</h3>
1032
<a class="indexterm" name="id385382"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_VOLUME "volume"
1032
<a class="indexterm" name="id385381"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_VOLUME "volume"
1033
1033
</pre>
1034
1034
<p>
1035
1035
Metadata field for an entry's playback volume.</p>
1039
1039
</div>
1040
1040
<hr>
1041
1041
<div class="refsect2" lang="en">
1042
<a name="id385399"></a><h3>
1042
<a name="id385398"></a><h3>
1043
1043
<a name="TOTEM-PL-PARSER-FIELD-AUTOPLAY:CAPS"></a>TOTEM_PL_PARSER_FIELD_AUTOPLAY</h3>
1044
<a class="indexterm" name="id385409"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_AUTOPLAY "autoplay"
1044
<a class="indexterm" name="id385408"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_AUTOPLAY "autoplay"
1045
1045
</pre>
1046
1046
<p>
1047
1047
Metadata field for an entry's "autoplay" flag, which is <a
1053
1053
</div>
1054
1054
<hr>
1055
1055
<div class="refsect2" lang="en">
1056
<a name="id385435"></a><h3>
1056
<a name="id385434"></a><h3>
1057
1057
<a name="TOTEM-PL-PARSER-FIELD-DURATION:CAPS"></a>TOTEM_PL_PARSER_FIELD_DURATION</h3>
1058
1058
<a class="indexterm" name="id385445"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_DURATION "duration"
1059
1059
</pre>
1089
1089
</div>
1090
1090
<hr>
1091
1091
<div class="refsect2" lang="en">
1092
<a name="id385550"></a><h3>
1092
<a name="id385549"></a><h3>
1093
1093
<a name="TOTEM-PL-PARSER-FIELD-COPYRIGHT:CAPS"></a>TOTEM_PL_PARSER_FIELD_COPYRIGHT</h3>
1094
1094
<a class="indexterm" name="id385563"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_COPYRIGHT "copyright"
1095
1095
</pre>
1187
1187
<div class="refsect2" lang="en">
1188
1188
<a name="id385834"></a><h3>
1189
1189
<a name="TOTEM-PL-PARSER-FIELD-FILESIZE:CAPS"></a>TOTEM_PL_PARSER_FIELD_FILESIZE</h3>
1190
<a class="indexterm" name="id385847"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_FILESIZE "filesize"
1190
<a class="indexterm" name="id385846"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_FILESIZE "filesize"
1191
1191
</pre>
1192
1192
<p>
1193
1193
Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream.</p>
1235
1235
<div class="refsect2" lang="en">
1236
1236
<a name="id385966"></a><h3>
1237
1237
<a name="TOTEM-PL-PARSER-FIELD-IS-PLAYLIST:CAPS"></a>TOTEM_PL_PARSER_FIELD_IS_PLAYLIST</h3>
1238
<a class="indexterm" name="id385979"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_IS_PLAYLIST "is-playlist"
1238
<a class="indexterm" name="id385978"></a><pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_IS_PLAYLIST "is-playlist"
1239
1239
</pre>
1240
1240
<p>
1241
1241
Metadata field used to tell the calling code that the parsing of a playlist
1367
1367
</div>
1368
1368
<hr>
1369
1369
<div class="refsect2" lang="en">
1370
<a name="id386393"></a><h3>
1370
<a name="id386392"></a><h3>
1371
1371
<a name="TotemPlParser-playlist-ended"></a>The "playlist-ended" signal</h3>
1372
1372
<a class="indexterm" name="id386402"></a><pre class="programlisting">void user_function (<a class="link" href="totem-pl-parser-totem-pl-parser.html#TotemPlParser">TotemPlParser</a> *parser,
1373
1373
<a
Loggerhead is a web-based interface for Breezy
Version: 2.0.1