← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/html/TotemPlParser.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-29 22:09:57 UTC
  • mfrom: (1.4.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20100329220957-lb93wobm4v0f5f7h
Tags: 2.30.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TotemPlParser.html
215
215
<p>
216
216
</p>
217
217
<div class="example">
218
 
<a name="id549052"></a><p class="title"><b>Example 1. Reading a Playlist</b></p>
 
218
<a name="id484540"></a><p class="title"><b>Example 1. Reading a Playlist</b></p>
219
219
<div class="example-contents"><pre class="programlisting">
220
220
TotemPlParser *pl = totem_pl_parser_new ();
221
221
g_object_set (pl, "recurse", FALSE, "disable-unsafe", TRUE, NULL);
233
233
<p>
234
234
</p>
235
235
<div class="example">
236
 
<a name="id550423"></a><p class="title"><b>Example 2. Reading a Playlist Asynchronously</b></p>
 
236
<a name="id485911"></a><p class="title"><b>Example 2. Reading a Playlist Asynchronously</b></p>
237
237
<div class="example-contents"><pre class="programlisting">
238
238
TotemPlParser *pl = totem_pl_parser_new ();
239
239
g_object_set (pl, "recurse", FALSE, "disable-unsafe", TRUE, NULL);
259
259
<p>
260
260
</p>
261
261
<div class="example">
262
 
<a name="id557060"></a><p class="title"><b>Example 3. Getting Metadata from Entries</b></p>
 
262
<a name="id492548"></a><p class="title"><b>Example 3. Getting Metadata from Entries</b></p>
263
263
<div class="example-contents"><pre class="programlisting">
264
264
static void
265
265
entry_parsed (TotemPlParser *parser, const gchar *uri, GHashTable *metadata, gpointer user_data)
277
277
<p>
278
278
</p>
279
279
<div class="example">
280
 
<a name="id554551"></a><p class="title"><b>Example 4. Writing a Playlist</b></p>
 
280
<a name="id490039"></a><p class="title"><b>Example 4. Writing a Playlist</b></p>
281
281
<div class="example-contents"><pre class="programlisting">
282
282
{
283
283
        TotemPlParser *pl;
506
506
</tr>
507
507
<tr>
508
508
<td><p><span class="term"><em class="parameter"><code>fallback</code></em> :</span></p></td>
509
 
<td> <code class="literal">TRUE</code> if the parser should add the playlist URI to the
 
509
<td> <a
 
510
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
511
><code class="literal">TRUE</code></a> if the parser should add the playlist URI to the
510
512
end of the playlist on parse failure
511
513
</td>
512
514
</tr>
562
564
</tr>
563
565
<tr>
564
566
<td><p><span class="term"><em class="parameter"><code>fallback</code></em> :</span></p></td>
565
 
<td> <code class="literal">TRUE</code> if the parser should add the playlist URI to the
 
567
<td> <a
 
568
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
569
><code class="literal">TRUE</code></a> if the parser should add the playlist URI to the
566
570
end of the playlist on parse failure
567
571
</td>
568
572
</tr>
570
574
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
571
575
<td> optional <a
572
576
href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"
573
 
><span class="type">GCancellable</span></a> object, or <code class="literal">NULL</code>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
 
577
><span class="type">GCancellable</span></a> object, or <a
 
578
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
579
><code class="literal">NULL</code></a>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
574
580
</tr>
575
581
<tr>
576
582
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
624
630
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
625
631
<td> a <a
626
632
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
627
 
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
 
633
><span class="type">GError</span></a>, or <a
 
634
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
635
><code class="literal">NULL</code></a>
628
636
</td>
629
637
</tr>
630
638
<tr>
664
672
</tr>
665
673
<tr>
666
674
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
667
 
<td> the base path for relative filenames, or <code class="literal">NULL</code>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
 
675
<td> the base path for relative filenames, or <a
 
676
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
677
><code class="literal">NULL</code></a>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
668
678
</tr>
669
679
<tr>
670
680
<td><p><span class="term"><em class="parameter"><code>fallback</code></em> :</span></p></td>
671
 
<td> <code class="literal">TRUE</code> if the parser should add the playlist URI to the
 
681
<td> <a
 
682
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
683
><code class="literal">TRUE</code></a> if the parser should add the playlist URI to the
672
684
end of the playlist on parse failure
673
685
</td>
674
686
</tr>
726
738
</tr>
727
739
<tr>
728
740
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
729
 
<td> the base path for relative filenames, or <code class="literal">NULL</code>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
 
741
<td> the base path for relative filenames, or <a
 
742
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
743
><code class="literal">NULL</code></a>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
730
744
</tr>
731
745
<tr>
732
746
<td><p><span class="term"><em class="parameter"><code>fallback</code></em> :</span></p></td>
733
 
<td> <code class="literal">TRUE</code> if the parser should add the playlist URI to the
 
747
<td> <a
 
748
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
749
><code class="literal">TRUE</code></a> if the parser should add the playlist URI to the
734
750
end of the playlist on parse failure
735
751
</td>
736
752
</tr>
738
754
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
739
755
<td> optional <a
740
756
href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"
741
 
><span class="type">GCancellable</span></a> object, or <code class="literal">NULL</code>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
 
757
><span class="type">GCancellable</span></a> object, or <a
 
758
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
759
><code class="literal">NULL</code></a>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
742
760
</tr>
743
761
<tr>
744
762
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
830
848
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
831
849
<td> return loction for a <a
832
850
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
833
 
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
 
851
><span class="type">GError</span></a>, or <a
 
852
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
853
><code class="literal">NULL</code></a>
834
854
</td>
835
855
</tr>
836
856
<tr>
837
857
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
838
 
<td> <code class="literal">TRUE</code> on success
 
858
<td> <a
 
859
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
860
><code class="literal">TRUE</code></a> on success
839
861
</td>
840
862
</tr>
841
863
</tbody>
865
887
</tr>
866
888
<tr>
867
889
<td><p><span class="term"><em class="parameter"><code>debug</code></em> :</span></p></td>
868
 
<td> <code class="literal">TRUE</code> if debug statements should be printed
 
890
<td> <a
 
891
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
892
><code class="literal">TRUE</code></a> if debug statements should be printed
869
893
</td>
870
894
</tr>
871
895
<tr>
900
924
</tr>
901
925
<tr>
902
926
<td><p><span class="term"><em class="parameter"><code>debug</code></em> :</span></p></td>
903
 
<td> <code class="literal">TRUE</code> if debug statements should be printed
 
927
<td> <a
 
928
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
929
><code class="literal">TRUE</code></a> if debug statements should be printed
904
930
</td>
905
931
</tr>
906
932
<tr>
1041
1067
<pre class="programlisting">#define TOTEM_PL_PARSER_FIELD_AUTOPLAY              "autoplay"
1042
1068
</pre>
1043
1069
<p>
1044
 
Metadata field for an entry's "autoplay" flag, which is <code class="literal">TRUE</code> if the entry should play automatically.</p>
 
1070
Metadata field for an entry's "autoplay" flag, which is <a
 
1071
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1072
><code class="literal">TRUE</code></a> if the entry should play automatically.</p>
1045
1073
<p>
1046
1074
</p>
1047
1075
</div>
1238
1266
</pre>
1239
1267
<p>
1240
1268
Metadata field used to tell the calling code that the parsing of a playlist
1241
 
started. It is only <code class="literal">TRUE</code> for the metadata passed to <a class="link" href="TotemPlParser.html#TotemPlParser-playlist-started" title='The "playlist-started" signal'><span class="type">"playlist-started"</span></a> or
 
1269
started. It is only <a
 
1270
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1271
><code class="literal">TRUE</code></a> for the metadata passed to <a class="link" href="TotemPlParser.html#TotemPlParser-playlist-started" title='The "playlist-started" signal'><span class="type">"playlist-started"</span></a> or
1242
1272
<a class="link" href="TotemPlParser.html#TotemPlParser-playlist-ended" title='The "playlist-ended" signal'><span class="type">"playlist-ended"</span></a> signal handlers.</p>
1243
1273
<p>
1244
1274
</p>
1262
1292
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1263
1293
>gboolean</a>              : Read / Write</pre>
1264
1294
<p>
1265
 
If <code class="literal">TRUE</code>, the parser will output debug information.</p>
 
1295
If <a
 
1296
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1297
><code class="literal">TRUE</code></a>, the parser will output debug information.</p>
1266
1298
<p>
1267
1299
</p>
1268
1300
<p>Default value: FALSE</p>
1274
1306
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1275
1307
>gboolean</a>              : Read / Write</pre>
1276
1308
<p>
1277
 
If <code class="literal">TRUE</code>, the parser will not parse unsafe locations, such as local devices
 
1309
If <a
 
1310
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1311
><code class="literal">TRUE</code></a>, the parser will not parse unsafe locations, such as local devices
1278
1312
and local files if the playlist isn't local. This is useful if the library
1279
1313
is parsing a playlist from a remote location such as a website.</p>
1280
1314
<p>
1288
1322
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1289
1323
>gboolean</a>              : Read / Write</pre>
1290
1324
<p>
1291
 
If <code class="literal">TRUE</code>, the parser will attempt to parse a playlist, even if it
 
1325
If <a
 
1326
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1327
><code class="literal">TRUE</code></a>, the parser will attempt to parse a playlist, even if it
1292
1328
appears to be unsupported (usually because of its filename extension).</p>
1293
1329
<p>
1294
1330
</p>
1301
1337
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1302
1338
>gboolean</a>              : Read / Write / Construct</pre>
1303
1339
<p>
1304
 
If <code class="literal">TRUE</code>, the parser will recursively fetch playlists linked to by
 
1340
If <a
 
1341
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
 
1342
><code class="literal">TRUE</code></a>, the parser will recursively fetch playlists linked to by
1305
1343
the current one.</p>
1306
1344
<p>
1307
1345
</p>