~ubuntu-branches/ubuntu/trusty/brasero/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/html/libbrasero-burn-BraseroBurn.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-04-17 14:41:53 UTC
  • mfrom: (1.1.54)
  • Revision ID: package-import@ubuntu.com-20120417144153-tuyvgt9jp2fr738k
Tags: 3.4.1-0ubuntu1
* New upstream release:
  - Translation updates

Show diffs side-by-side

added added

removed removed

Lines of Context:
41
41
<a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="returnvalue">BraseroBurn</span></a> *       <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-new" title="brasero_burn_new ()">brasero_burn_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
42
42
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-record" title="brasero_burn_record ()">brasero_burn_record</a>                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
43
43
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
44
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
44
                                                         <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>);
45
45
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-check" title="brasero_burn_check ()">brasero_burn_check</a>                  (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
46
46
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
47
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
47
                                                         <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>);
48
48
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-blank" title="brasero_burn_blank ()">brasero_burn_blank</a>                  (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
49
49
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
50
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
50
                                                         <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>);
51
51
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-cancel" title="brasero_burn_cancel ()">brasero_burn_cancel</a>                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);
 
52
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);
53
53
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-status" title="brasero_burn_status ()">brasero_burn_status</a>                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
54
54
                                                         <em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> *media</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);
 
55
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
 
56
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
 
57
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);
58
58
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-get-action-string" title="brasero_burn_get_action_string ()">brasero_burn_get_action_string</a>      (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
59
59
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnAction" title="enum BraseroBurnAction"><span class="type">BraseroBurnAction</span></a> action</code></em>,
60
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);
 
60
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);
61
61
</pre>
62
62
</div>
63
63
<div class="refsect1">
96
96
<a name="brasero-burn-record"></a><h3>brasero_burn_record ()</h3>
97
97
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_record                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
98
98
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
99
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
99
                                                         <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>
100
100
<p>
101
101
Burns or creates a disc image according to the parameters
102
102
set in <em class="parameter"><code>session</code></em>.
116
116
</tr>
117
117
<tr>
118
118
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
119
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
119
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
120
120
</td>
121
121
</tr>
122
122
<tr>
132
132
<a name="brasero-burn-check"></a><h3>brasero_burn_check ()</h3>
133
133
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_check                  (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
134
134
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
135
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
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>
136
136
<p>
137
137
Checks the integrity of a medium according to the parameters
138
138
set in <em class="parameter"><code>session</code></em>. The medium must be inserted in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
153
153
</tr>
154
154
<tr>
155
155
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
156
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
156
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
157
157
</td>
158
158
</tr>
159
159
<tr>
169
169
<a name="brasero-burn-blank"></a><h3>brasero_burn_blank ()</h3>
170
170
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_blank                  (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
171
171
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
172
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
172
                                                         <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>
173
173
<p>
174
174
Blanks a medium according to the parameters
175
175
set in <em class="parameter"><code>session</code></em>. The medium must be inserted in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
190
190
</tr>
191
191
<tr>
192
192
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
193
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
193
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
194
194
</td>
195
195
</tr>
196
196
<tr>
205
205
<div class="refsect2">
206
206
<a name="brasero-burn-cancel"></a><h3>brasero_burn_cancel ()</h3>
207
207
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_cancel                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
208
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);</pre>
 
208
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);</pre>
209
209
<p>
210
210
Cancels any ongoing operation. If <em class="parameter"><code>protect</code></em> is TRUE then
211
211
cancellation will not take place for a "critical" task, a task whose interruption
221
221
</tr>
222
222
<tr>
223
223
<td><p><span class="term"><em class="parameter"><code>protect</code></em> :</span></p></td>
224
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
 
224
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
225
225
</td>
226
226
</tr>
227
227
<tr>
237
237
<a name="brasero-burn-status"></a><h3>brasero_burn_status ()</h3>
238
238
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_status                 (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
239
239
                                                         <em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> *media</code></em>,
240
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
241
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
242
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);</pre>
 
240
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
 
241
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
 
242
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);</pre>
243
243
<p>
244
244
Returns various information about the current operation 
245
245
in <em class="parameter"><code>media</code></em> (the current media type being burnt),
261
261
</tr>
262
262
<tr>
263
263
<td><p><span class="term"><em class="parameter"><code>isosize</code></em> :</span></p></td>
264
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
 
264
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
265
265
</tr>
266
266
<tr>
267
267
<td><p><span class="term"><em class="parameter"><code>written</code></em> :</span></p></td>
268
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
 
268
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
269
269
</tr>
270
270
<tr>
271
271
<td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
272
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> or NULL</td>
 
272
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> or NULL</td>
273
273
</tr>
274
274
<tr>
275
275
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
284
<a name="brasero-burn-get-action-string"></a><h3>brasero_burn_get_action_string ()</h3>
285
285
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_burn_get_action_string      (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
286
286
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnAction" title="enum BraseroBurnAction"><span class="type">BraseroBurnAction</span></a> action</code></em>,
287
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);</pre>
 
287
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);</pre>
288
288
<p>
289
289
This function returns the current action (in <em class="parameter"><code>string</code></em>)  of
290
290
an ongoing operation performed by <em class="parameter"><code>burn</code></em>.
307
307
</tr>
308
308
<tr>
309
309
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
310
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **</td>
 
310
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **</td>
311
311
</tr>
312
312
</tbody>
313
313
</table></div>