← Back to branch summary

~ubuntu-branches/debian/wheezy/brasero/wheezy

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-burn-lib.html

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Henriksson
  • Date: 2009-12-14 22:35:03 UTC
  • mfrom: (1.2.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20091214223503-aa2l0jrjl85ar2ue
Tags: 2.28.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-burn-lib.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>brasero-burn-lib</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Libbrasero-burn Reference Manual">
8
8
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
9
9
<link rel="prev" href="ch01.html" title="API Reference for Libbrasero-burn">
10
10
<link rel="next" href="libbrasero-burn-brasero-error.html" title="brasero-error">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="API Reference for Libbrasero-burn">
14
14
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
15
15
<link rel="index" href="api-index-full.html" title="API Index">
 
16
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
16
17
</head>
17
18
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
19
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
25
26
</tr>
26
27
<tr><td colspan="5" class="shortcuts">
27
28
<a href="#libbrasero-burn-brasero-burn-lib.synopsis" class="shortcut">Top</a>
28
 
                 | 
29
 
                <a href="#libbrasero-burn-brasero-burn-lib.description" class="shortcut">Description</a>
 
29
                   | 
 
30
                  <a href="#libbrasero-burn-brasero-burn-lib.description" class="shortcut">Description</a>
30
31
</td></tr>
31
32
</table>
32
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="brasero-burn-lib">
33
34
<a name="libbrasero-burn-brasero-burn-lib"></a><div class="titlepage"></div>
34
35
<div class="refnamediv"><table width="100%"><tr>
35
36
<td valign="top">
38
39
</td>
39
40
<td valign="top" align="right"></td>
40
41
</tr></table></div>
41
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
42
43
<a name="libbrasero-burn-brasero-burn-lib.synopsis"></a><h2>Synopsis</h2>
43
 
<pre class="synopsis">
44
 
#define             <a
45
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MAJOR--CAPS"
46
 
>LIBBRASERO_BURN_VERSION_MAJOR</a>
47
 
#define             <a
48
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MINOR--CAPS"
49
 
>LIBBRASERO_BURN_VERSION_MINOR</a>
50
 
#define             <a
51
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MICRO--CAPS"
52
 
>LIBBRASERO_BURN_VERSION_MICRO</a>
53
 
#define             <a
54
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-AGE--CAPS"
55
 
>LIBBRASERO_BURN_AGE</a>
56
 
<a
57
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
58
 
>gboolean</a>            <a
59
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-start"
60
 
>brasero_burn_library_start</a>          (int *argc,
 
44
<pre class="synopsis">#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MAJOR:CAPS">LIBBRASERO_BURN_VERSION_MAJOR</a>
 
45
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MINOR:CAPS">LIBBRASERO_BURN_VERSION_MINOR</a>
 
46
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MICRO:CAPS">LIBBRASERO_BURN_VERSION_MICRO</a>
 
47
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-AGE:CAPS">LIBBRASERO_BURN_AGE</a>
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-start">brasero_burn_library_start</a>          (int *argc,
61
49
                                                         char **argv[]);
62
 
void                <a
63
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-stop"
64
 
>brasero_burn_library_stop</a>           (void);
65
 
<a
66
 
href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"
67
 
>GOptionGroup</a> *      <a
68
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-option-group"
69
 
>brasero_burn_library_get_option_group</a>
70
 
                                                        (void);
71
 
<a
72
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
73
 
>GSList</a> *            <a
74
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-plugins-list"
75
 
>brasero_burn_library_get_plugins_list</a>
76
 
                                                        (void);
77
 
<a
78
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
79
 
>gboolean</a>            <a
80
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-can-checksum"
81
 
>brasero_burn_library_can_checksum</a>   (void);
82
 
<a
83
 
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnResult"
84
 
>BraseroBurnResult</a>   <a
85
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-input-supported"
86
 
>brasero_burn_library_input_supported</a>
87
 
                                                        (<a
88
 
href="../libbrasero-burn/libbrasero-burn-brasero-track-type.html#BraseroTrackType"
89
 
>BraseroTrackType</a> *type);
90
 
<a
91
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
92
 
>BraseroMedia</a>        <a
93
 
href="../libbrasero-burn/libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-media-capabilities"
94
 
>brasero_burn_library_get_media_capabilities</a>
95
 
                                                        (<a
96
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
97
 
>BraseroMedia</a> media);
 
50
void                <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-stop">brasero_burn_library_stop</a>           (void);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> *      <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-option-group">brasero_burn_library_get_option_group</a>
 
52
                                                        (void);
 
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList">GSList</a> *            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-plugins-list">brasero_burn_library_get_plugins_list</a>
 
54
                                                        (void);
 
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-can-checksum">brasero_burn_library_can_checksum</a>   (void);
 
56
<a href="libbrasero-burn-brasero-enums.html#BraseroBurnResult">BraseroBurnResult</a>   <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-input-supported">brasero_burn_library_input_supported</a>
 
57
                                                        (<a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType">BraseroTrackType</a> *type);
 
58
<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia">BraseroMedia</a>        <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-media-capabilities">brasero_burn_library_get_media_capabilities</a>
 
59
                                                        (<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia">BraseroMedia</a> media);
98
60
</pre>
99
61
</div>
100
 
<div class="refsect1" lang="en">
 
62
<div class="refsect1" title="Description">
101
63
<a name="libbrasero-burn-brasero-burn-lib.description"></a><h2>Description</h2>
102
64
<p>
103
65
</p>
104
66
</div>
105
 
<div class="refsect1" lang="en">
 
67
<div class="refsect1" title="Details">
106
68
<a name="libbrasero-burn-brasero-burn-lib.details"></a><h2>Details</h2>
107
 
<div class="refsect2" lang="en">
108
 
<a name="LIBBRASERO-BURN-VERSION-MAJOR--CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MAJOR</h3>
 
69
<div class="refsect2" title="LIBBRASERO_BURN_VERSION_MAJOR">
 
70
<a name="LIBBRASERO-BURN-VERSION-MAJOR:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MAJOR</h3>
109
71
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MAJOR</pre>
110
72
<p>
111
73
</p>
112
74
</div>
113
75
<hr>
114
 
<div class="refsect2" lang="en">
115
 
<a name="LIBBRASERO-BURN-VERSION-MINOR--CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MINOR</h3>
 
76
<div class="refsect2" title="LIBBRASERO_BURN_VERSION_MINOR">
 
77
<a name="LIBBRASERO-BURN-VERSION-MINOR:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MINOR</h3>
116
78
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MINOR</pre>
117
79
<p>
118
80
</p>
119
81
</div>
120
82
<hr>
121
 
<div class="refsect2" lang="en">
122
 
<a name="LIBBRASERO-BURN-VERSION-MICRO--CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MICRO</h3>
 
83
<div class="refsect2" title="LIBBRASERO_BURN_VERSION_MICRO">
 
84
<a name="LIBBRASERO-BURN-VERSION-MICRO:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MICRO</h3>
123
85
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MICRO</pre>
124
86
<p>
125
87
</p>
126
88
</div>
127
89
<hr>
128
 
<div class="refsect2" lang="en">
129
 
<a name="LIBBRASERO-BURN-AGE--CAPS"></a><h3>LIBBRASERO_BURN_AGE</h3>
 
90
<div class="refsect2" title="LIBBRASERO_BURN_AGE">
 
91
<a name="LIBBRASERO-BURN-AGE:CAPS"></a><h3>LIBBRASERO_BURN_AGE</h3>
130
92
<pre class="programlisting">#define             LIBBRASERO_BURN_AGE</pre>
131
93
<p>
132
94
</p>
133
95
</div>
134
96
<hr>
135
 
<div class="refsect2" lang="en">
 
97
<div class="refsect2" title="brasero_burn_library_start ()">
136
98
<a name="brasero-burn-library-start"></a><h3>brasero_burn_library_start ()</h3>
137
 
<pre class="programlisting"><a
138
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
139
 
>gboolean</a>            brasero_burn_library_start          (int *argc,
 
99
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            brasero_burn_library_start          (int *argc,
140
100
                                                         char **argv[]);</pre>
141
101
<p>
142
102
</p>
162
122
</table></div>
163
123
</div>
164
124
<hr>
165
 
<div class="refsect2" lang="en">
 
125
<div class="refsect2" title="brasero_burn_library_stop ()">
166
126
<a name="brasero-burn-library-stop"></a><h3>brasero_burn_library_stop ()</h3>
167
127
<pre class="programlisting">void                brasero_burn_library_stop           (void);</pre>
168
128
<p>
169
129
</p>
170
130
</div>
171
131
<hr>
172
 
<div class="refsect2" lang="en">
 
132
<div class="refsect2" title="brasero_burn_library_get_option_group ()">
173
133
<a name="brasero-burn-library-get-option-group"></a><h3>brasero_burn_library_get_option_group ()</h3>
174
 
<pre class="programlisting"><a
175
 
href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"
176
 
>GOptionGroup</a> *      brasero_burn_library_get_option_group
 
134
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup">GOptionGroup</a> *      brasero_burn_library_get_option_group
177
135
                                                        (void);</pre>
178
136
<p>
179
137
Returns a GOptionGroup for the commandline arguments recognized by libbrasero-burn.
180
 
You should add this to your GOptionContext if your are using <a
181
 
href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-parse"
182
 
><code class="function">g_option_context_parse()</code></a>
 
138
You should add this to your GOptionContext if your are using <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a>
183
139
to parse your commandline arguments.</p>
184
 
<p>
185
 
</p>
186
140
<div class="variablelist"><table border="0">
187
141
<col align="left" valign="top">
188
142
<tbody><tr>
189
143
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
190
 
<td> a <a
191
 
href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"
192
 
><span class="type">GOptionGroup</span></a> *
 
144
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> *
193
145
</td>
194
146
</tr></tbody>
195
147
</table></div>
196
148
</div>
197
149
<hr>
198
 
<div class="refsect2" lang="en">
 
150
<div class="refsect2" title="brasero_burn_library_get_plugins_list ()">
199
151
<a name="brasero-burn-library-get-plugins-list"></a><h3>brasero_burn_library_get_plugins_list ()</h3>
200
 
<pre class="programlisting"><a
201
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
202
 
>GSList</a> *            brasero_burn_library_get_plugins_list
 
152
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList">GSList</a> *            brasero_burn_library_get_plugins_list
203
153
                                                        (void);</pre>
204
154
<p>
205
155
This function returns the list of plugins that 
206
156
are available to libbrasero-burn.</p>
207
 
<p>
208
 
</p>
209
157
<div class="variablelist"><table border="0">
210
158
<col align="left" valign="top">
211
159
<tbody><tr>
212
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213
 
<td> a <a
214
 
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
215
 
><span class="type">GSList</span></a> that must be destroyed when not needed and each object unreffed.
 
161
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> that must be destroyed when not needed and each object unreffed.
216
162
</td>
217
163
</tr></tbody>
218
164
</table></div>
219
165
</div>
220
166
<hr>
221
 
<div class="refsect2" lang="en">
 
167
<div class="refsect2" title="brasero_burn_library_can_checksum ()">
222
168
<a name="brasero-burn-library-can-checksum"></a><h3>brasero_burn_library_can_checksum ()</h3>
223
 
<pre class="programlisting"><a
224
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
225
 
>gboolean</a>            brasero_burn_library_can_checksum   (void);</pre>
 
169
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            brasero_burn_library_can_checksum   (void);</pre>
226
170
<p>
227
171
</p>
228
172
<div class="variablelist"><table border="0">
235
179
</table></div>
236
180
</div>
237
181
<hr>
238
 
<div class="refsect2" lang="en">
 
182
<div class="refsect2" title="brasero_burn_library_input_supported ()">
239
183
<a name="brasero-burn-library-input-supported"></a><h3>brasero_burn_library_input_supported ()</h3>
240
 
<pre class="programlisting"><a
241
 
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnResult"
242
 
>BraseroBurnResult</a>   brasero_burn_library_input_supported
243
 
                                                        (<a
244
 
href="../libbrasero-burn/libbrasero-burn-brasero-track-type.html#BraseroTrackType"
245
 
>BraseroTrackType</a> *type);</pre>
 
184
<pre class="programlisting"><a href="libbrasero-burn-brasero-enums.html#BraseroBurnResult">BraseroBurnResult</a>   brasero_burn_library_input_supported
 
185
                                                        (<a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType">BraseroTrackType</a> *type);</pre>
246
186
<p>
247
187
</p>
248
188
<div class="variablelist"><table border="0">
262
202
</table></div>
263
203
</div>
264
204
<hr>
265
 
<div class="refsect2" lang="en">
 
205
<div class="refsect2" title="brasero_burn_library_get_media_capabilities ()">
266
206
<a name="brasero-burn-library-get-media-capabilities"></a><h3>brasero_burn_library_get_media_capabilities ()</h3>
267
 
<pre class="programlisting"><a
268
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
269
 
>BraseroMedia</a>        brasero_burn_library_get_media_capabilities
270
 
                                                        (<a
271
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
272
 
>BraseroMedia</a> media);</pre>
 
207
<pre class="programlisting"><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia">BraseroMedia</a>        brasero_burn_library_get_media_capabilities
 
208
                                                        (<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia">BraseroMedia</a> media);</pre>
273
209
<p>
274
210
Used to test what the library can do based on the medium type.
275
211
Returns BRASERO_MEDIUM_WRITABLE if the disc can be written
276
212
and / or BRASERO_MEDIUM_REWRITABLE if the disc can be erased.</p>
277
 
<p>
278
 
</p>
279
213
<div class="variablelist"><table border="0">
280
214
<col align="left" valign="top">
281
215
<tbody>
282
216
<tr>
283
217
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
284
 
<td> a <a
285
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
286
 
><span class="type">BraseroMedia</span></a>
 
218
<td> a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
287
219
</td>
288
220
</tr>
289
221
<tr>
290
222
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
291
 
<td> a <a
292
 
href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"
293
 
><span class="type">BraseroMedia</span></a>
 
223
<td> a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
294
224
</td>
295
225
</tr>
296
226
</tbody>
300
230
</div>
301
231
<div class="footer">
302
232
<hr>
303
 
          Generated by GTK-Doc V1.11</div>
 
233
          Generated by GTK-Doc V1.12</div>
304
234
</body>
305
235
</html>