← Back to branch summary

~mfisch/brasero/update-to-3.8.0

« 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): Sebastien Bacher
  • Date: 2010-03-30 00:57:57 UTC
  • mfrom: (1.1.40 upstream)
  • Revision ID: james.westby@ubuntu.com-20100330005757-ugoop0td80dcth72
Tags: 2.30.0-0ubuntu1
* New upstream version
  Bug Fixes:
  - Fix a problem if multiple tracks were processed in a single pass by
    a plugin then progress was not smooth 
  - Fix video options so that for SVCD we do have a proper default for
    aspect ratio 
  - Fix two problem with video transcoding: 
    - a hang that was caused by buffers being too little  
    - progress reporting that did not always properly work 
  - Make soft autodetection. 
  - Update to latest GTK code 
  - Fix #Bug 611111 - brasero burn:/// hangs 
  - Use gtk_widget_style_attach  () in realize implementations
* debian/control.in: 
  - updated gtk requirement

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-brasero-burn-lib.html
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.13 (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="ch01.html" title="API Reference for Libbrasero-burn">
14
 
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
15
 
<link rel="index" href="api-index-full.html" title="API Index">
16
 
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
17
13
</head>
18
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
19
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
41
37
</tr></table></div>
42
38
<div class="refsynopsisdiv" title="Synopsis">
43
39
<a name="libbrasero-burn-brasero-burn-lib.synopsis"></a><h2>Synopsis</h2>
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"><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
 
                                                         <span class="returnvalue">char</span> **argv[]);
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
 
<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
 
<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
 
                                                        (<a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType"><span class="returnvalue">BraseroTrackType</span></a> *type);
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);
 
40
<pre class="synopsis">#define             <a class="link" href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MAJOR:CAPS" title="LIBBRASERO_BURN_VERSION_MAJOR">LIBBRASERO_BURN_VERSION_MAJOR</a>
 
41
#define             <a class="link" href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MINOR:CAPS" title="LIBBRASERO_BURN_VERSION_MINOR">LIBBRASERO_BURN_VERSION_MINOR</a>
 
42
#define             <a class="link" href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-VERSION-MICRO:CAPS" title="LIBBRASERO_BURN_VERSION_MICRO">LIBBRASERO_BURN_VERSION_MICRO</a>
 
43
#define             <a class="link" href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-AGE:CAPS" title="LIBBRASERO_BURN_AGE">LIBBRASERO_BURN_AGE</a>
 
44
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-start" title="brasero_burn_library_start ()">brasero_burn_library_start</a>          (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
45
                                                         <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);
 
46
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-stop" title="brasero_burn_library_stop ()">brasero_burn_library_stop</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
 
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *      <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-option-group" title="brasero_burn_library_get_option_group ()">brasero_burn_library_get_option_group</a>
 
48
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-plugins-list" title="brasero_burn_library_get_plugins_list ()">brasero_burn_library_get_plugins_list</a>
 
50
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-can-checksum" title="brasero_burn_library_can_checksum ()">brasero_burn_library_can_checksum</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
52
<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-brasero-burn-lib.html#brasero-burn-library-input-supported" title="brasero_burn_library_input_supported ()">brasero_burn_library_input_supported</a>
 
53
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-track-type.html#BraseroTrackType" title="BraseroTrackType"><span class="type">BraseroTrackType</span></a> *type</code></em>);
 
54
<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        <a class="link" href="libbrasero-burn-brasero-burn-lib.html#brasero-burn-library-get-media-capabilities" title="brasero_burn_library_get_media_capabilities ()">brasero_burn_library_get_media_capabilities</a>
 
55
                                                        (<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> media</code></em>);
60
56
</pre>
61
57
</div>
62
58
<div class="refsect1" title="Description">
96
92
<hr>
97
93
<div class="refsect2" title="brasero_burn_library_start ()">
98
94
<a name="brasero-burn-library-start"></a><h3>brasero_burn_library_start ()</h3>
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
 
                                                         <span class="returnvalue">char</span> **argv[]);</pre>
 
95
<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          (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
96
                                                         <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);</pre>
101
97
<p>
102
98
Starts the library. This function must be called
103
99
before using any of the functions.
104
100
</p>
105
101
<p>
106
 
Rename to: init</p>
 
102
Rename to: init
 
103
</p>
107
104
<div class="variablelist"><table border="0">
108
105
<col align="left" valign="top">
109
106
<tbody>
110
107
<tr>
111
108
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
112
 
<td> an <span class="type">int</span>.
 
109
<td>an <span class="type">int</span>.
113
110
</td>
114
111
</tr>
115
112
<tr>
116
113
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
117
 
<td> a <span class="type">char</span> **.
 
114
<td>a <span class="type">char</span> **.
118
115
</td>
119
116
</tr>
120
117
<tr>
128
125
<hr>
129
126
<div class="refsect2" title="brasero_burn_library_stop ()">
130
127
<a name="brasero-burn-library-stop"></a><h3>brasero_burn_library_stop ()</h3>
131
 
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_burn_library_stop           (void);</pre>
 
128
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_burn_library_stop           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
132
129
<p>
133
130
Stop the library. Don't use any of the functions or
134
131
objects afterwards
135
132
</p>
136
133
<p>
137
 
Rename to: deinit</p>
 
134
Rename to: deinit
 
135
</p>
138
136
</div>
139
137
<hr>
140
138
<div class="refsect2" title="brasero_burn_library_get_option_group ()">
141
139
<a name="brasero-burn-library-get-option-group"></a><h3>brasero_burn_library_get_option_group ()</h3>
142
140
<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
 
                                                        (void);</pre>
 
141
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
144
142
<p>
145
143
Returns a GOptionGroup for the commandline arguments recognized by libbrasero-burn.
146
144
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
 
to parse your commandline arguments.</p>
 
145
to parse your commandline arguments.
 
146
</p>
148
147
<div class="variablelist"><table border="0">
149
148
<col align="left" valign="top">
150
149
<tbody><tr>
158
157
<div class="refsect2" title="brasero_burn_library_get_plugins_list ()">
159
158
<a name="brasero-burn-library-get-plugins-list"></a><h3>brasero_burn_library_get_plugins_list ()</h3>
160
159
<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
 
                                                        (void);</pre>
 
160
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
162
161
<p>
163
162
This function returns the list of plugins that 
164
 
are available to libbrasero-burn.</p>
 
163
are available to libbrasero-burn.
 
164
</p>
165
165
<div class="variablelist"><table border="0">
166
166
<col align="left" valign="top">
167
167
<tbody><tr>
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"><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>
 
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   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
177
177
<p>
178
178
Checks whether the library can do any kind of
179
 
checksum at all.</p>
 
179
checksum at all.
 
180
</p>
180
181
<div class="variablelist"><table border="0">
181
182
<col align="left" valign="top">
182
183
<tbody><tr>
189
190
<hr>
190
191
<div class="refsect2" title="brasero_burn_library_input_supported ()">
191
192
<a name="brasero-burn-library-input-supported"></a><h3>brasero_burn_library_input_supported ()</h3>
192
 
<pre class="programlisting"><a href="libbrasero-burn-brasero-enums.html#BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_library_input_supported
193
 
                                                        (<a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType"><span class="returnvalue">BraseroTrackType</span></a> *type);</pre>
 
193
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   brasero_burn_library_input_supported
 
194
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-track-type.html#BraseroTrackType" title="BraseroTrackType"><span class="type">BraseroTrackType</span></a> *type</code></em>);</pre>
194
195
<p>
195
 
Checks whether <em class="parameter"><code>type</code></em> can be used as input.</p>
 
196
Checks whether <em class="parameter"><code>type</code></em> can be used as input.
 
197
</p>
196
198
<div class="variablelist"><table border="0">
197
199
<col align="left" valign="top">
198
200
<tbody>
199
201
<tr>
200
202
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
201
 
<td> a <a href="libbrasero-burn-brasero-track-type.html#BraseroTrackType"><span class="type">BraseroTrackType</span></a>
 
203
<td>a <a class="link" href="libbrasero-burn-brasero-track-type.html#BraseroTrackType" title="BraseroTrackType"><span class="type">BraseroTrackType</span></a>
202
204
</td>
203
205
</tr>
204
206
<tr>
205
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
206
 
<td> a <a href="libbrasero-burn-brasero-enums.html#BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>
 
208
<td> a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>
207
209
</td>
208
210
</tr>
209
211
</tbody>
213
215
<div class="refsect2" title="brasero_burn_library_get_media_capabilities ()">
214
216
<a name="brasero-burn-library-get-media-capabilities"></a><h3>brasero_burn_library_get_media_capabilities ()</h3>
215
217
<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>
 
218
                                                        (<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> media</code></em>);</pre>
217
219
<p>
218
220
Used to test what the library can do based on the medium type.
219
221
Returns BRASERO_MEDIUM_WRITABLE if the disc can be written
220
 
and / or BRASERO_MEDIUM_REWRITABLE if the disc can be erased.</p>
 
222
and / or BRASERO_MEDIUM_REWRITABLE if the disc can be erased.
 
223
</p>
221
224
<div class="variablelist"><table border="0">
222
225
<col align="left" valign="top">
223
226
<tbody>
224
227
<tr>
225
228
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
226
 
<td> a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
 
229
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
227
230
</td>
228
231
</tr>
229
232
<tr>
238
241
</div>
239
242
<div class="footer">
240
243
<hr>
241
 
          Generated by GTK-Doc V1.13</div>
 
244
          Generated by GTK-Doc V1.14</div>
242
245
</body>
243
246
</html>
 
 
b'\\ No newline at end of file'