libburner-media3-dev 3.0.4-0ubuntu1 / usr / share / gtk-doc / html / libburner-burn / libburner-burn-burner-status.html

This file is indexed.

/usr/share/gtk-doc/html/libburner-burn/libburner-burn-burner-status.html is in libburner-media3-dev 3.0.4-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>burner-status: Libburner-burn Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libburner-burn Reference Manual">
<link rel="up" href="ch01.html" title="API Reference for Libburner-burn">
<link rel="prev" href="libburner-burn-burner-tags.html" title="burner-tags">
<link rel="next" href="libburner-burn-burner-enums.html" title="burner-enums">
<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="#libburner-burn-burner-status.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libburner-burn-burner-tags.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libburner-burn-burner-enums.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libburner-burn-burner-status"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libburner-burn-burner-status.top_of_page"></a>burner-status</span></h2>
<p>burner-status</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libburner-burn-burner-status.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">
<a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="returnvalue">BurnerStatus</span></a> *
</td>
<td class="function_name">
<a class="link" href="libburner-burn-burner-status.html#burner-status-new" title="burner_status_new ()">burner_status_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-burner-status.html#burner-status-get-result" title="burner_status_get_result ()">burner_status_get_result</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-burner-status.html#burner-status-get-progress" title="burner_status_get_progress ()">burner_status_get_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
</td>
<td class="function_name">
<a class="link" href="libburner-burn-burner-status.html#burner-status-get-error" title="burner_status_get_error ()">burner_status_get_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libburner-burn-burner-status.html#burner-status-get-current-action" title="burner_status_get_current_action ()">burner_status_get_current_action</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="libburner-burn-burner-status.html#burner-status-set-completed" title="burner_status_set_completed ()">burner_status_set_completed</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="libburner-burn-burner-status.html#burner-status-set-not-ready" title="burner_status_set_not_ready ()">burner_status_set_not_ready</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="libburner-burn-burner-status.html#burner-status-set-error" title="burner_status_set_error ()">burner_status_set_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libburner-burn-burner-status.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">struct</td>
<td class="function_name"><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus">BurnerStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libburner-burn-burner-status.html#BurnerStatusType" title="enum BurnerStatusType">BurnerStatusType</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libburner-burn-burner-status.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libburner-burn-burner-status.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="burner-status-new"></a><h3>burner_status_new ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="returnvalue">BurnerStatus</span></a> *
burner_status_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> object.</p>
<div class="refsect3">
<a name="burner-status-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-get-result"></a><h3>burner_status_get_result ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
burner_status_get_result (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>);</pre>
<p>After an object (see <code class="function">burner_burn_track_get_status()</code>) has
been requested its status, this function returns that status.</p>
<div class="refsect3">
<a name="burner-status-get-result.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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-status-get-result.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="type">BurnerBurnResult</span></a>.
BURNER_BURN_OK if the object is ready.
BURNER_BURN_NOT_READY if some time should be given to the object before it is ready.
BURNER_BURN_ERR if there is an error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-get-progress"></a><h3>burner_status_get_progress ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
burner_status_get_progress (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>);</pre>
<p>If <a class="link" href="libburner-burn-burner-status.html#burner-status-get-result" title="burner_status_get_result ()"><code class="function">burner_status_get_result()</code></a> returned BURNER_BURN_NOT_READY,
this function returns the progress regarding the operation completion.</p>
<div class="refsect3">
<a name="burner-status-get-progress.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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-status-get-progress.returns"></a><h4>Returns</h4>
<p> a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-get-error"></a><h3>burner_status_get_error ()</h3>
<pre class="programlisting"><a href="../glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
burner_status_get_error (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>);</pre>
<p>If <a class="link" href="libburner-burn-burner-status.html#burner-status-get-result" title="burner_status_get_result ()"><code class="function">burner_status_get_result()</code></a> returned BURNER_BURN_ERR,
this function returns the error.</p>
<div class="refsect3">
<a name="burner-status-get-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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-status-get-error.returns"></a><h4>Returns</h4>
<p> a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-get-current-action"></a><h3>burner_status_get_current_action ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
burner_status_get_current_action (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>);</pre>
<p>If <a class="link" href="libburner-burn-burner-status.html#burner-status-get-result" title="burner_status_get_result ()"><code class="function">burner_status_get_result()</code></a> returned BURNER_BURN_NOT_READY,
this function returns a string describing the operation currently performed.
Free the string when it is not needed anymore.</p>
<div class="refsect3">
<a name="burner-status-get-current-action.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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-status-get-current-action.returns"></a><h4>Returns</h4>
<p> a <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-set-completed"></a><h3>burner_status_set_completed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
burner_status_set_completed (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>);</pre>
<p>Sets the status for a request to BURNER_BURN_OK.</p>
<div class="refsect3">
<a name="burner-status-set-completed.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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-set-not-ready"></a><h3>burner_status_set_not_ready ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
burner_status_set_not_ready (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</code></em>,
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> progress</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *current_action</code></em>);</pre>
<p>Sets the status for a request to BURNER_BURN_NOT_READY.
Allows to set a string describing the operation currently performed
as well as the progress regarding the operation completion.</p>
<div class="refsect3">
<a name="burner-status-set-not-ready.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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or -1.0.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>current_action</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> or NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-status-set-error"></a><h3>burner_status_set_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
burner_status_set_error (<em class="parameter"><code><a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a> *status</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>Sets the status for a request to BURNER_BURN_ERR.</p>
<div class="refsect3">
<a name="burner-status-set-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>status</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-burner-status.html#BurnerStatus" title="struct BurnerStatus"><span class="type">BurnerStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libburner-burn-burner-status.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BurnerStatus"></a><h3>struct BurnerStatus</h3>
<pre class="programlisting">struct BurnerStatus {
	GObject parent_instance;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="BurnerStatusType"></a><h3>enum BurnerStatusType</h3>
<div class="refsect3">
<a name="BurnerStatusType.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="BURNER-STATUS-OK:CAPS"></a>BURNER_STATUS_OK</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BURNER-STATUS-ERROR:CAPS"></a>BURNER_STATUS_ERROR</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BURNER-STATUS-QUESTION:CAPS"></a>BURNER_STATUS_QUESTION</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BURNER-STATUS-INFORMATION:CAPS"></a>BURNER_STATUS_INFORMATION</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.