This file is indexed.

/usr/share/gtk-doc/html/libbrasero-burn/libbrasero-burn-brasero-burn-lib.html is in libbrasero-media3-dev 3.4.1-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>brasero-burn-lib</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libbrasero-burn Reference Manual">
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
<link rel="prev" href="ch01.html" title="API Reference for Libbrasero-burn">
<link rel="next" href="libbrasero-burn-brasero-error.html" title="brasero-error">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbrasero-burn Reference Manual</th>
<td><a accesskey="n" href="libbrasero-burn-brasero-error.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbrasero-burn-brasero-burn-lib.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbrasero-burn-brasero-burn-lib.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbrasero-burn-brasero-burn-lib"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbrasero-burn-brasero-burn-lib.top_of_page"></a>brasero-burn-lib</span></h2>
<p>brasero-burn-lib</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbrasero-burn-brasero-burn-lib.synopsis"></a><h2>Synopsis</h2>
<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>
#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>
#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>
#define             <a class="link" href="libbrasero-burn-brasero-burn-lib.html#LIBBRASERO-BURN-AGE:CAPS" title="LIBBRASERO_BURN_AGE">LIBBRASERO_BURN_AGE</a>
<a href="/usr/share/gtk-doc/html/glib/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>,
                                                         <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);
<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>);
<a href="/usr/share/gtk-doc/html/glib/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>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/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>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/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>);
<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>
                                                        (<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>);
<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>
                                                        (<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> media</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbrasero-burn-brasero-burn-lib.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libbrasero-burn-brasero-burn-lib.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LIBBRASERO-BURN-VERSION-MAJOR:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MAJOR</h3>
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MAJOR</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="LIBBRASERO-BURN-VERSION-MINOR:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MINOR</h3>
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MINOR</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="LIBBRASERO-BURN-VERSION-MICRO:CAPS"></a><h3>LIBBRASERO_BURN_VERSION_MICRO</h3>
<pre class="programlisting">#define             LIBBRASERO_BURN_VERSION_MICRO</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="LIBBRASERO-BURN-AGE:CAPS"></a><h3>LIBBRASERO_BURN_AGE</h3>
<pre class="programlisting">#define             LIBBRASERO_BURN_AGE</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-start"></a><h3>brasero_burn_library_start ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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>,
                                                         <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);</pre>
<p>
Starts the library. This function must be called
before using any of the functions.
</p>
<p>
Rename to: init
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>an <span class="type">int</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>a <span class="type">char</span> **.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-stop"></a><h3>brasero_burn_library_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_burn_library_stop           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Stop the library. Don't use any of the functions or
objects afterwards
</p>
<p>
Rename to: deinit
</p>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-get-option-group"></a><h3>brasero_burn_library_get_option_group ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *      brasero_burn_library_get_option_group
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a GOptionGroup for the commandline arguments recognized by libbrasero-burn.
You should add this to your GOptionContext if your are using <a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a>
to parse your commandline arguments.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> *</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-get-plugins-list"></a><h3>brasero_burn_library_get_plugins_list ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            brasero_burn_library_get_plugins_list
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function returns the list of plugins that 
are available to libbrasero-burn.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> that must be destroyed when not needed and each object unreffed. <span class="annotation">[<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>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-can-checksum"></a><h3>brasero_burn_library_can_checksum ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/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>
<p>
Checks whether the library can do any kind of
checksum at all.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-input-supported"></a><h3>brasero_burn_library_input_supported ()</h3>
<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
                                                        (<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>
<p>
Checks whether <em class="parameter"><code>type</code></em> can be used as input.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-track-type.html#BraseroTrackType" title="BraseroTrackType"><span class="type">BraseroTrackType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-library-get-media-capabilities"></a><h3>brasero_burn_library_get_media_capabilities ()</h3>
<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
                                                        (<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> media</code></em>);</pre>
<p>
Used to test what the library can do based on the medium type.
Returns BRASERO_MEDIUM_WRITABLE if the disc can be written
and / or BRASERO_MEDIUM_REWRITABLE if the disc can be erased.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>