← Back to branch summary

~ubuntu-branches/ubuntu/maverick/brasero/maverick

« 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): Martin Pitt
  • Date: 2010-01-04 17:45:17 UTC
  • mfrom: (1.1.36 upstream)
  • Revision ID: james.westby@ubuntu.com-20100104174517-vz0avr4o1vdfusrf
Tags: 2.29.4-0ubuntu1
* New upstream release:
  - Bug fixes
  - Fixes for Video DVD
  - Updated translations.
* Add 001_nautilus_lazy_init.patch: Do not call brasero_*_start() at
  nautilus startup, they are very expensive; lazily initialize those
  instead.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-burn-lib.html
45
45
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MINOR:CAPS">LIBBRASERO_BURN_VERSION_MINOR</a>
46
46
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MICRO:CAPS">LIBBRASERO_BURN_VERSION_MICRO</a>
47
47
#define             <a href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-AGE:CAPS">LIBBRASERO_BURN_AGE</a>
48
 
<span class="returnvalue">gboolean</span>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-start">brasero_burn_library_start</a>          (<span class="returnvalue">int</span> *argc,
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-start">brasero_burn_library_start</a>          (<span class="returnvalue">int</span> *argc,
49
49
                                                         <span class="returnvalue">char</span> **argv[]);
50
50
<span class="returnvalue">void</span>                <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-stop">brasero_burn_library_stop</a>           (void);
51
 
<span class="returnvalue">GOptionGroup</span> *      <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-option-group">brasero_burn_library_get_option_group</a>
52
 
                                                        (void);
53
 
<span class="returnvalue">GSList</span> *            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-plugins-list">brasero_burn_library_get_plugins_list</a>
54
 
                                                        (void);
55
 
<span class="returnvalue">gboolean</span>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-can-checksum">brasero_burn_library_can_checksum</a>   (void);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></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"><span class="returnvalue">GSList</span></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"><span class="returnvalue">gboolean</span></a>            <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-can-checksum">brasero_burn_library_can_checksum</a>   (void);
56
56
<a href="libbrasero-burn-brasero-enums.html#BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-input-supported">brasero_burn_library_input_supported</a>
57
57
                                                        (<a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType"><span class="returnvalue">BraseroTrackType</span></a> *type);
58
 
<a href="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></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="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a> media);
 
58
<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></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"><span class="returnvalue">BraseroMedia</span></a> media);
60
60
</pre>
61
61
</div>
62
62
<div class="refsect1" title="Description">
96
96
<hr>
97
97
<div class="refsect2" title="brasero_burn_library_start ()">
98
98
<a name="brasero-burn-library-start"></a><h3>brasero_burn_library_start ()</h3>
99
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            brasero_burn_library_start          (<span class="returnvalue">int</span> *argc,
 
99
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            brasero_burn_library_start          (<span class="returnvalue">int</span> *argc,
100
100
                                                         <span class="returnvalue">char</span> **argv[]);</pre>
101
101
<p>
102
102
Starts the library. This function must be called
119
119
</tr>
120
120
<tr>
121
121
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
122
 
<td> a <span class="type">gboolean</span>
 
122
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
123
123
</td>
124
124
</tr>
125
125
</tbody>
139
139
<hr>
140
140
<div class="refsect2" title="brasero_burn_library_get_option_group ()">
141
141
<a name="brasero-burn-library-get-option-group"></a><h3>brasero_burn_library_get_option_group ()</h3>
142
 
<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> *      brasero_burn_library_get_option_group
 
142
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *      brasero_burn_library_get_option_group
143
143
                                                        (void);</pre>
144
144
<p>
145
145
Returns a GOptionGroup for the commandline arguments recognized by libbrasero-burn.
146
 
You should add this to your GOptionContext if your are using <code class="function">g_option_context_parse()</code>
 
146
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>
147
147
to parse your commandline arguments.</p>
148
148
<div class="variablelist"><table border="0">
149
149
<col align="left" valign="top">
150
150
<tbody><tr>
151
151
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
152
 
<td> a <span class="type">GOptionGroup</span> *
 
152
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> *
153
153
</td>
154
154
</tr></tbody>
155
155
</table></div>
157
157
<hr>
158
158
<div class="refsect2" title="brasero_burn_library_get_plugins_list ()">
159
159
<a name="brasero-burn-library-get-plugins-list"></a><h3>brasero_burn_library_get_plugins_list ()</h3>
160
 
<pre class="programlisting"><span class="returnvalue">GSList</span> *            brasero_burn_library_get_plugins_list
 
160
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            brasero_burn_library_get_plugins_list
161
161
                                                        (void);</pre>
162
162
<p>
163
163
This function returns the list of plugins that 
166
166
<col align="left" valign="top">
167
167
<tbody><tr>
168
168
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
169
 
<td>a <span class="type">GSList</span> that must be destroyed when not needed and each object unreffed.. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym> GObject.Object. </td>
 
169
<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.. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym> GObject.Object. </td>
170
170
</tr></tbody>
171
171
</table></div>
172
172
</div>
173
173
<hr>
174
174
<div class="refsect2" title="brasero_burn_library_can_checksum ()">
175
175
<a name="brasero-burn-library-can-checksum"></a><h3>brasero_burn_library_can_checksum ()</h3>
176
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            brasero_burn_library_can_checksum   (void);</pre>
 
176
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            brasero_burn_library_can_checksum   (void);</pre>
177
177
<p>
178
178
Checks whether the library can do any kind of
179
179
checksum at all.</p>
181
181
<col align="left" valign="top">
182
182
<tbody><tr>
183
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184
 
<td> a <span class="type">gboolean</span>
 
184
<td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
185
185
</td>
186
186
</tr></tbody>
187
187
</table></div>
212
212
<hr>
213
213
<div class="refsect2" title="brasero_burn_library_get_media_capabilities ()">
214
214
<a name="brasero-burn-library-get-media-capabilities"></a><h3>brasero_burn_library_get_media_capabilities ()</h3>
215
 
<pre class="programlisting"><a href="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        brasero_burn_library_get_media_capabilities
216
 
                                                        (<a href="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a> media);</pre>
 
215
<pre class="programlisting"><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        brasero_burn_library_get_media_capabilities
 
216
                                                        (<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a> media);</pre>
217
217
<p>
218
218
Used to test what the library can do based on the medium type.
219
219
Returns BRASERO_MEDIUM_WRITABLE if the disc can be written
223
223
<tbody>
224
224
<tr>
225
225
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
226
 
<td> a <a href="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
 
226
<td> a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
227
227
</td>
228
228
</tr>
229
229
<tr>
230
230
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
231
 
<td> a <a href="/gnome/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
 
231
<td> a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
232
232
</td>
233
233
</tr>
234
234
</tbody>