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

« back to all changes in this revision

Viewing changes to docs/reference/html/totem-pl-parser-TotemDisc.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-08-04 19:13:44 UTC
  • mfrom: (1.4.8 upstream) (1.5.5 sid)
  • Revision ID: james.westby@ubuntu.com-20100804191344-sv8wa90wdt3e63lw
Tags: 2.30.2-1
* debian/control.in:
  + Fix description of the GIR package.
* New upstream bugfix release:
  + debian/control.in:
    - Add libsoup-gnome2.4-dev build dependency.
    - Update gobject-introspection build dependency to >= 0.6.14.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="api-reference.html" title="API Reference">
9
9
<link rel="prev" href="totem-pl-parser-TotemPlPlaylistIter.html" title="TotemPlPlaylistIter">
10
10
<link rel="next" href="api-index-full.html" title="Index of all symbols">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="api-reference.html" title="API Reference">
14
 
<link rel="index" href="api-index-full.html" title="Index of all symbols">
15
 
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
16
 
<link rel="index" href="annotation-glossary.html" title="Annotation glossary">
17
 
<link rel="glossary" href="annotation-glossary.html#annotation-glossary" title="Annotation Glossary">
18
13
</head>
19
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
20
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
27
22
</tr>
28
23
<tr><td colspan="5" class="shortcuts">
29
24
<a href="#totem-pl-parser-TotemDisc.synopsis" class="shortcut">Top</a>
30
 
                 | 
31
 
                <a href="#totem-pl-parser-TotemDisc.description" class="shortcut">Description</a>
 
25
                   | 
 
26
                  <a href="#totem-pl-parser-TotemDisc.description" class="shortcut">Description</a>
32
27
</td></tr>
33
28
</table>
34
29
<div class="refentry" title="totem-disc">
47
42
<div class="refsynopsisdiv" title="Synopsis">
48
43
<a name="totem-pl-parser-TotemDisc.synopsis"></a><h2>Synopsis</h2>
49
44
<pre class="synopsis">
50
 
 
51
45
#include &lt;totem-disc.h&gt;
52
46
 
53
47
enum                <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>;
54
 
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type" title="totem_cd_detect_type ()">totem_cd_detect_type</a>                (const char *device,
55
 
                                                         <a
56
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
57
 
>GError</a> **error);
58
 
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-with-url" title="totem_cd_detect_type_with_url ()">totem_cd_detect_type_with_url</a>       (const char *device,
59
 
                                                         char **mrl,
60
 
                                                         <a
61
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
62
 
>GError</a> **error);
63
 
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-from-dir" title="totem_cd_detect_type_from_dir ()">totem_cd_detect_type_from_dir</a>       (const char *dir,
64
 
                                                         char **mrl,
65
 
                                                         <a
66
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
67
 
>GError</a> **error);
68
 
const char *        <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-get-human-readable-name" title="totem_cd_get_human_readable_name ()">totem_cd_get_human_readable_name</a>    (<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a> type);
69
 
char *              <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-mrl-from-type" title="totem_cd_mrl_from_type ()">totem_cd_mrl_from_type</a>              (const char *scheme,
70
 
                                                         const char *dir);
71
 
<a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
73
 
>gboolean</a>            <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-has-medium" title="totem_cd_has_medium ()">totem_cd_has_medium</a>                 (const char *device);
 
48
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type" title="totem_cd_detect_type ()">totem_cd_detect_type</a>                (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
 
49
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
50
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-with-url" title="totem_cd_detect_type_with_url ()">totem_cd_detect_type_with_url</a>       (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
 
51
                                                         <em class="parameter"><code><span class="type">char</span> **mrl</code></em>,
 
52
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
53
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-from-dir" title="totem_cd_detect_type_from_dir ()">totem_cd_detect_type_from_dir</a>       (<em class="parameter"><code>const <span class="type">char</span> *dir</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">char</span> **mrl</code></em>,
 
55
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
56
const <span class="returnvalue">char</span> *        <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-get-human-readable-name" title="totem_cd_get_human_readable_name ()">totem_cd_get_human_readable_name</a>    (<em class="parameter"><code><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> type</code></em>);
 
57
<span class="returnvalue">char</span> *              <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-mrl-from-type" title="totem_cd_mrl_from_type ()">totem_cd_mrl_from_type</a>              (<em class="parameter"><code>const <span class="type">char</span> *scheme</code></em>,
 
58
                                                         <em class="parameter"><code>const <span class="type">char</span> *dir</code></em>);
 
59
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-has-medium" title="totem_cd_has_medium ()">totem_cd_has_medium</a>                 (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>);
74
60
</pre>
75
61
</div>
76
62
<div class="refsect1" title="Description">
86
72
valid URI as far as, for example, GIO is concerned.
87
73
</p>
88
74
<p>
89
 
The rest of the totem-pl-parser API exclusively uses URIs.</p>
90
 
<p>
 
75
The rest of the totem-pl-parser API exclusively uses URIs.
91
76
</p>
92
77
</div>
93
78
<div class="refsect1" title="Details">
100
85
  MEDIA_TYPE_CDDA,
101
86
  MEDIA_TYPE_VCD,
102
87
  MEDIA_TYPE_DVD,
103
 
  MEDIA_TYPE_DVB,
104
 
  MEDIA_TYPE_NUM_TYPES
 
88
  MEDIA_TYPE_DVB
105
89
} TotemDiscMediaType;
106
90
</pre>
107
91
<p>
108
 
Gives the media type of a disc, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR--CAPS"><code class="literal">MEDIA_TYPE_ERROR</code></a> if the media type
109
 
could not be determined.</p>
110
 
<p>
 
92
Gives the media type of a disc, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR:CAPS"><code class="literal">MEDIA_TYPE_ERROR</code></a> if the media type
 
93
could not be determined.
111
94
</p>
112
95
<div class="variablelist"><table border="0">
113
96
<col align="left" valign="top">
114
97
<tbody>
115
98
<tr>
116
 
<td><p><a name="MEDIA-TYPE-ERROR--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_ERROR</code></span></p></td>
117
 
<td> there was an error determining the media's type
118
 
</td>
119
 
</tr>
120
 
<tr>
121
 
<td><p><a name="MEDIA-TYPE-DATA--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DATA</code></span></p></td>
122
 
<td> data disc
123
 
</td>
124
 
</tr>
125
 
<tr>
126
 
<td><p><a name="MEDIA-TYPE-CDDA--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_CDDA</code></span></p></td>
127
 
<td> audio CD
128
 
</td>
129
 
</tr>
130
 
<tr>
131
 
<td><p><a name="MEDIA-TYPE-VCD--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_VCD</code></span></p></td>
132
 
<td> video CD
133
 
</td>
134
 
</tr>
135
 
<tr>
136
 
<td><p><a name="MEDIA-TYPE-DVD--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DVD</code></span></p></td>
137
 
<td> video DVD
138
 
</td>
139
 
</tr>
140
 
<tr>
141
 
<td><p><a name="MEDIA-TYPE-DVB--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DVB</code></span></p></td>
142
 
<td> digital television
143
 
</td>
144
 
</tr>
145
 
<tr>
146
 
<td><p><a name="MEDIA-TYPE-NUM-TYPES--CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_NUM_TYPES</code></span></p></td>
147
 
<td> the number of supported media types
 
99
<td><p><a name="MEDIA-TYPE-ERROR:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_ERROR</code></span></p></td>
 
100
<td>there was an error determining the media's type
 
101
</td>
 
102
</tr>
 
103
<tr>
 
104
<td><p><a name="MEDIA-TYPE-DATA:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DATA</code></span></p></td>
 
105
<td>data disc
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td><p><a name="MEDIA-TYPE-CDDA:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_CDDA</code></span></p></td>
 
110
<td>audio CD
 
111
</td>
 
112
</tr>
 
113
<tr>
 
114
<td><p><a name="MEDIA-TYPE-VCD:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_VCD</code></span></p></td>
 
115
<td>video CD
 
116
</td>
 
117
</tr>
 
118
<tr>
 
119
<td><p><a name="MEDIA-TYPE-DVD:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DVD</code></span></p></td>
 
120
<td>video DVD
 
121
</td>
 
122
</tr>
 
123
<tr>
 
124
<td><p><a name="MEDIA-TYPE-DVB:CAPS"></a><span class="term"><code class="literal">MEDIA_TYPE_DVB</code></span></p></td>
 
125
<td>digital television
148
126
</td>
149
127
</tr>
150
128
</tbody>
153
131
<hr>
154
132
<div class="refsect2" title="totem_cd_detect_type ()">
155
133
<a name="totem-cd-detect-type"></a><h3>totem_cd_detect_type ()</h3>
156
 
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  totem_cd_detect_type                (const char *device,
157
 
                                                         <a
158
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
159
 
>GError</a> **error);</pre>
 
134
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  totem_cd_detect_type                (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
 
135
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
160
136
<p>
161
137
Detects the disc's type, given its device node path.
162
138
</p>
163
139
<p>
164
 
Possible error codes are as per <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-with-url" title="totem_cd_detect_type_with_url ()"><code class="function">totem_cd_detect_type_with_url()</code></a>.</p>
165
 
<p>
 
140
Possible error codes are as per <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-with-url" title="totem_cd_detect_type_with_url ()"><code class="function">totem_cd_detect_type_with_url()</code></a>.
166
141
</p>
167
142
<div class="variablelist"><table border="0">
168
143
<col align="left" valign="top">
169
144
<tbody>
170
145
<tr>
171
146
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
172
 
<td> a device node path
 
147
<td>a device node path
173
148
</td>
174
149
</tr>
175
150
<tr>
176
151
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
177
 
<td> return location for a <a
178
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
179
 
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
 
152
<td>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
180
153
</td>
181
154
</tr>
182
155
<tr>
183
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184
 
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR--CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
 
157
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR:CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
185
158
</td>
186
159
</tr>
187
160
</tbody>
190
163
<hr>
191
164
<div class="refsect2" title="totem_cd_detect_type_with_url ()">
192
165
<a name="totem-cd-detect-type-with-url"></a><h3>totem_cd_detect_type_with_url ()</h3>
193
 
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  totem_cd_detect_type_with_url       (const char *device,
194
 
                                                         char **mrl,
195
 
                                                         <a
196
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
197
 
>GError</a> **error);</pre>
 
166
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  totem_cd_detect_type_with_url       (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
 
167
                                                         <em class="parameter"><code><span class="type">char</span> **mrl</code></em>,
 
168
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
198
169
<p>
199
170
Detects the disc's type, given its device node path. If
200
171
a string pointer is passed to <em class="parameter"><code>mrl</code></em>, it will return the disc's
204
175
Note that this function does synchronous I/O.
205
176
</p>
206
177
<p>
207
 
Possible error codes are as per <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-from-dir" title="totem_cd_detect_type_from_dir ()"><code class="function">totem_cd_detect_type_from_dir()</code></a>.</p>
208
 
<p>
 
178
Possible error codes are as per <a class="link" href="totem-pl-parser-TotemDisc.html#totem-cd-detect-type-from-dir" title="totem_cd_detect_type_from_dir ()"><code class="function">totem_cd_detect_type_from_dir()</code></a>.
209
179
</p>
210
180
<div class="variablelist"><table border="0">
211
181
<col align="left" valign="top">
212
182
<tbody>
213
183
<tr>
214
184
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
215
 
<td> a device node path
 
185
<td>a device node path
216
186
</td>
217
187
</tr>
218
188
<tr>
219
189
<td><p><span class="term"><em class="parameter"><code>mrl</code></em> :</span></p></td>
220
 
<td> return location for the disc's MRL, or <code class="literal">NULL</code>. <acronym title="Parameter for returning results. Default is transfer-full."><span class="acronym">out</span></acronym>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> full. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a> full. </td>
 
190
<td> return location for the disc's MRL, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
221
191
</tr>
222
192
<tr>
223
193
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
224
 
<td> return location for a <a
225
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
226
 
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
 
194
<td>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
227
195
</td>
228
196
</tr>
229
197
<tr>
230
198
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
231
 
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR--CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
 
199
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR:CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
232
200
</td>
233
201
</tr>
234
202
</tbody>
237
205
<hr>
238
206
<div class="refsect2" title="totem_cd_detect_type_from_dir ()">
239
207
<a name="totem-cd-detect-type-from-dir"></a><h3>totem_cd_detect_type_from_dir ()</h3>
240
 
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a>  totem_cd_detect_type_from_dir       (const char *dir,
241
 
                                                         char **mrl,
242
 
                                                         <a
243
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
244
 
>GError</a> **error);</pre>
 
208
<pre class="programlisting"><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="returnvalue">TotemDiscMediaType</span></a>  totem_cd_detect_type_from_dir       (<em class="parameter"><code>const <span class="type">char</span> *dir</code></em>,
 
209
                                                         <em class="parameter"><code><span class="type">char</span> **mrl</code></em>,
 
210
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
245
211
<p>
246
212
Detects the disc's type, given its mount directory URI. If
247
213
a string pointer is passed to <em class="parameter"><code>mrl</code></em>, it will return the disc's
251
217
Note that this function does synchronous I/O.
252
218
</p>
253
219
<p>
254
 
If no disc is present in the drive, a <a class="link" href="TotemPlParser.html#TOTEM-PL-PARSER-ERROR-NO-DISC--CAPS"><span class="type">TOTEM_PL_PARSER_ERROR_NO_DISC</span></a>
 
220
If no disc is present in the drive, a <a class="link" href="TotemPlParser.html#TOTEM-PL-PARSER-ERROR-NO-DISC:CAPS"><span class="type">TOTEM_PL_PARSER_ERROR_NO_DISC</span></a>
255
221
error will be returned. On unknown mounting errors, a
256
 
<a class="link" href="TotemPlParser.html#TOTEM-PL-PARSER-ERROR-MOUNT-FAILED--CAPS"><span class="type">TOTEM_PL_PARSER_ERROR_MOUNT_FAILED</span></a> error will be returned. On other
 
222
<a class="link" href="TotemPlParser.html#TOTEM-PL-PARSER-ERROR-MOUNT-FAILED:CAPS"><span class="type">TOTEM_PL_PARSER_ERROR_MOUNT_FAILED</span></a> error will be returned. On other
257
223
I/O errors, or if resolution of symlinked mount paths failed, a code from
258
 
<a
259
 
href="/usr/share/gtk-doc/html/gio/gio-GIOError.html#GIOErrorEnum"
260
 
><span class="type">GIOErrorEnum</span></a> will be returned.</p>
261
 
<p>
 
224
<a href="/usr/share/gtk-doc/html/gio/gio-GIOError.html#GIOErrorEnum"><span class="type">GIOErrorEnum</span></a> will be returned.
262
225
</p>
263
226
<div class="variablelist"><table border="0">
264
227
<col align="left" valign="top">
265
228
<tbody>
266
229
<tr>
267
230
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
268
 
<td> a directory URI
 
231
<td>a directory URI
269
232
</td>
270
233
</tr>
271
234
<tr>
272
235
<td><p><span class="term"><em class="parameter"><code>mrl</code></em> :</span></p></td>
273
 
<td> return location for the disc's MRL, or <code class="literal">NULL</code>. <acronym title="Parameter for returning results. Default is transfer-full."><span class="acronym">out</span></acronym>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> full. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a> full. </td>
 
236
<td> return location for the disc's MRL, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
274
237
</tr>
275
238
<tr>
276
239
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
277
 
<td> return location for a <a
278
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
279
 
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
 
240
<td>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
280
241
</td>
281
242
</tr>
282
243
<tr>
283
244
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
 
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR--CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
 
245
<td> <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> corresponding to the disc's type, or <a class="link" href="totem-pl-parser-TotemDisc.html#MEDIA-TYPE-ERROR:CAPS"><span class="type">MEDIA_TYPE_ERROR</span></a> on failure
285
246
</td>
286
247
</tr>
287
248
</tbody>
290
251
<hr>
291
252
<div class="refsect2" title="totem_cd_get_human_readable_name ()">
292
253
<a name="totem-cd-get-human-readable-name"></a><h3>totem_cd_get_human_readable_name ()</h3>
293
 
<pre class="programlisting">const char *        totem_cd_get_human_readable_name    (<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType">TotemDiscMediaType</a> type);</pre>
 
254
<pre class="programlisting">const <span class="returnvalue">char</span> *        totem_cd_get_human_readable_name    (<em class="parameter"><code><a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a> type</code></em>);</pre>
294
255
<p>
295
256
Returns the human-readable name for the given
296
 
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a>.</p>
297
 
<p>
 
257
<a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a>.
298
258
</p>
299
259
<div class="variablelist"><table border="0">
300
260
<col align="left" valign="top">
301
261
<tbody>
302
262
<tr>
303
263
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
304
 
<td> a <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a>
 
264
<td>a <a class="link" href="totem-pl-parser-TotemDisc.html#TotemDiscMediaType" title="enum TotemDiscMediaType"><span class="type">TotemDiscMediaType</span></a>
305
265
</td>
306
266
</tr>
307
267
<tr>
308
268
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
309
 
<td> the disc media type's readable name, which must not be freed, or <code class="literal">NULL</code> for unhandled media types
 
269
<td> the disc media type's readable name, which must not be freed, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for unhandled media types
310
270
</td>
311
271
</tr>
312
272
</tbody>
315
275
<hr>
316
276
<div class="refsect2" title="totem_cd_mrl_from_type ()">
317
277
<a name="totem-cd-mrl-from-type"></a><h3>totem_cd_mrl_from_type ()</h3>
318
 
<pre class="programlisting">char *              totem_cd_mrl_from_type              (const char *scheme,
319
 
                                                         const char *dir);</pre>
 
278
<pre class="programlisting"><span class="returnvalue">char</span> *              totem_cd_mrl_from_type              (<em class="parameter"><code>const <span class="type">char</span> *scheme</code></em>,
 
279
                                                         <em class="parameter"><code>const <span class="type">char</span> *dir</code></em>);</pre>
320
280
<p>
321
281
Builds an MRL using the scheme <em class="parameter"><code>scheme</code></em> and the given URI <em class="parameter"><code>dir</code></em>,
322
282
taking the filename from the URI if it's a <code class="filename">file://</code> and just
323
 
using the whole URI otherwise.</p>
324
 
<p>
 
283
using the whole URI otherwise.
325
284
</p>
326
285
<div class="variablelist"><table border="0">
327
286
<col align="left" valign="top">
328
287
<tbody>
329
288
<tr>
330
289
<td><p><span class="term"><em class="parameter"><code>scheme</code></em> :</span></p></td>
331
 
<td> a scheme (e.g. "dvd")
 
290
<td>a scheme (e.g. "dvd")
332
291
</td>
333
292
</tr>
334
293
<tr>
335
294
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
336
 
<td> a directory URI
 
295
<td>a directory URI
337
296
</td>
338
297
</tr>
339
298
<tr>
347
306
<hr>
348
307
<div class="refsect2" title="totem_cd_has_medium ()">
349
308
<a name="totem-cd-has-medium"></a><h3>totem_cd_has_medium ()</h3>
350
 
<pre class="programlisting"><a
351
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
352
 
>gboolean</a>            totem_cd_has_medium                 (const char *device);</pre>
353
 
<p>
354
 
Returns whether the disc has a physical medium.</p>
355
 
<p>
 
309
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            totem_cd_has_medium                 (<em class="parameter"><code>const <span class="type">char</span> *device</code></em>);</pre>
 
310
<p>
 
311
Returns whether the disc has a physical medium.
356
312
</p>
357
313
<div class="variablelist"><table border="0">
358
314
<col align="left" valign="top">
359
315
<tbody>
360
316
<tr>
361
317
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
362
 
<td> a device node path
 
318
<td>a device node path
363
319
</td>
364
320
</tr>
365
321
<tr>
366
322
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
367
 
<td> <code class="literal">TRUE</code> if the disc physically exists
 
323
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the disc physically exists
368
324
</td>
369
325
</tr>
370
326
</tbody>
374
330
</div>
375
331
<div class="footer">
376
332
<hr>
377
 
          Generated by GTK-Doc V1.11</div>
 
333
          Generated by GTK-Doc V1.14</div>
378
334
</body>
379
 
</html>
 
335
</html>
 
 
b'\\ No newline at end of file'