/usr/share/gtk-doc/html/libbrasero-burn/libbrasero-burn-BraseroSessionCfg.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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BraseroSessionCfg</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="libbrasero-burn-BraseroSessionSpan.html" title="BraseroSessionSpan">
<link rel="next" href="libbrasero-burn-BraseroBurnOptions.html" title="BraseroBurnOptions">
<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="libbrasero-burn-BraseroSessionSpan.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-BraseroBurnOptions.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-BraseroSessionCfg.synopsis" class="shortcut">Top</a>
|
<a href="#libbrasero-burn-BraseroSessionCfg.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbrasero-burn-BraseroSessionCfg"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbrasero-burn-BraseroSessionCfg.top_of_page"></a>BraseroSessionCfg</span></h2>
<p>BraseroSessionCfg — Configure automatically a <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbrasero-burn-BraseroSessionCfg.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <brasero-session-cfg.h>
<a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg">BraseroSessionCfg</a>;
enum <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError" title="enum BraseroSessionError">BraseroSessionError</a>;
#define <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BRASERO-SESSION-IS-VALID:CAPS" title="BRASERO_SESSION_IS_VALID()">BRASERO_SESSION_IS_VALID</a> (result_MACRO)
<a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="returnvalue">BraseroSessionCfg</span></a> * <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-new" title="brasero_session_cfg_new ()">brasero_session_cfg_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError" title="enum BraseroSessionError"><span class="returnvalue">BraseroSessionError</span></a> <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-get-error" title="brasero_session_cfg_get_error ()">brasero_session_cfg_get_error</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-add-flags" title="brasero_session_cfg_add_flags ()">brasero_session_cfg_add_flags</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-remove-flags" title="brasero_session_cfg_remove_flags ()">brasero_session_cfg_remove_flags</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</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-BraseroSessionCfg.html#brasero-session-cfg-is-supported" title="brasero_session_cfg_is_supported ()">brasero_session_cfg_is_supported</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</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-BraseroSessionCfg.html#brasero-session-cfg-is-compulsory" title="brasero_session_cfg_is_compulsory ()">brasero_session_cfg_is_compulsory</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</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-BraseroSessionCfg.html#brasero-session-cfg-has-default-output-path" title="brasero_session_cfg_has_default_output_path ()">brasero_session_cfg_has_default_output_path</a>
(<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-enable" title="brasero_session_cfg_enable ()">brasero_session_cfg_enable</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-disable" title="brasero_session_cfg_disable ()">brasero_session_cfg_disable</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbrasero-burn-BraseroSessionCfg.description"></a><h2>Description</h2>
<p>
This object configures automatically a session reacting to any change
made to the various parameters.
</p>
</div>
<div class="refsect1">
<a name="libbrasero-burn-BraseroSessionCfg.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BraseroSessionCfg"></a><h3>BraseroSessionCfg</h3>
<pre class="programlisting">typedef struct _BraseroSessionCfg BraseroSessionCfg;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BraseroSessionError"></a><h3>enum BraseroSessionError</h3>
<pre class="programlisting">typedef enum {
BRASERO_SESSION_VALID = 0,
BRASERO_SESSION_NO_CD_TEXT = 1,
BRASERO_SESSION_NOT_READY,
BRASERO_SESSION_EMPTY,
BRASERO_SESSION_NO_INPUT_IMAGE,
BRASERO_SESSION_UNKNOWN_IMAGE,
BRASERO_SESSION_NO_INPUT_MEDIUM,
BRASERO_SESSION_NO_OUTPUT,
BRASERO_SESSION_INSUFFICIENT_SPACE,
BRASERO_SESSION_OVERBURN_NECESSARY,
BRASERO_SESSION_NOT_SUPPORTED,
BRASERO_SESSION_DISC_PROTECTED
} BraseroSessionError;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BRASERO-SESSION-IS-VALID:CAPS"></a><h3>BRASERO_SESSION_IS_VALID()</h3>
<pre class="programlisting">#define BRASERO_SESSION_IS_VALID(result_MACRO)</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-new"></a><h3>brasero_session_cfg_new ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="returnvalue">BraseroSessionCfg</span></a> * brasero_session_cfg_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> object.
</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 class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-get-error"></a><h3>brasero_session_cfg_get_error ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError" title="enum BraseroSessionError"><span class="returnvalue">BraseroSessionError</span></a> brasero_session_cfg_get_error (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
<p>
This function returns the current status and if
autoconfiguration is/was successful.
</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 class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError" title="enum BraseroSessionError"><span class="type">BraseroSessionError</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-add-flags"></a><h3>brasero_session_cfg_add_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> brasero_session_cfg_add_flags (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);</pre>
<p>
Adds all flags from <em class="parameter"><code>flags</code></em> that are supported.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-remove-flags"></a><h3>brasero_session_cfg_remove_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> brasero_session_cfg_remove_flags (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flags</code></em>);</pre>
<p>
Removes all flags that are not compulsory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-is-supported"></a><h3>brasero_session_cfg_is_supported ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> brasero_session_cfg_is_supported (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);</pre>
<p>
Checks whether a particular flag is supported.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a>
</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>. TRUE if it is supported;
FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-is-compulsory"></a><h3>brasero_session_cfg_is_compulsory ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> brasero_session_cfg_is_compulsory (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a> flag</code></em>);</pre>
<p>
Checks whether a particular flag is compulsory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnFlag" title="enum BraseroBurnFlag"><span class="type">BraseroBurnFlag</span></a>
</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>. TRUE if it is compulsory;
FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-has-default-output-path"></a><h3>brasero_session_cfg_has_default_output_path ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> brasero_session_cfg_has_default_output_path
(<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
<p>
This function returns whether the path returned
by <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-output" title="brasero_burn_session_get_output ()"><code class="function">brasero_burn_session_get_output()</code></a> is an
automatically created one.
</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>. TRUE if the path(s)
creation is handled by <em class="parameter"><code>session</code></em>, FALSE if it was
set.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-enable"></a><h3>brasero_session_cfg_enable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> brasero_session_cfg_enable (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
<p>
This function (re)-enables autoconfiguration
</p>
</div>
<hr>
<div class="refsect2">
<a name="brasero-session-cfg-disable"></a><h3>brasero_session_cfg_disable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> brasero_session_cfg_disable (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg" title="BraseroSessionCfg"><span class="type">BraseroSessionCfg</span></a> *cfg</code></em>);</pre>
<p>
This function disables autoconfiguration
</p>
</div>
</div>
<div class="refsect1">
<a name="libbrasero-burn-BraseroSessionCfg.see-also"></a><h2>See Also</h2>
<a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>, <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|