1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>BraseroSessionCfg</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
7
<link rel="home" href="index.html" title="Libbrasero-burn Reference Manual">
8
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
9
<link rel="prev" href="libbrasero-burn-BraseroSessionSpan.html" title="BraseroSessionSpan">
10
<link rel="next" href="libbrasero-burn-BraseroBurnOptions.html" title="BraseroBurnOptions">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
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">
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
20
<td><a accesskey="p" href="libbrasero-burn-BraseroSessionSpan.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23
<th width="100%" align="center">Libbrasero-burn Reference Manual</th>
24
<td><a accesskey="n" href="libbrasero-burn-BraseroBurnOptions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
<tr><td colspan="5" class="shortcuts">
27
<a href="#libbrasero-burn-BraseroSessionCfg.synopsis" class="shortcut">Top</a>
29
<a href="#libbrasero-burn-BraseroSessionCfg.description" class="shortcut">Description</a>
32
<div class="refentry" lang="en">
33
<a name="libbrasero-burn-BraseroSessionCfg"></a><div class="titlepage"></div>
34
<div class="refnamediv"><table width="100%"><tr>
36
<h2><span class="refentrytitle"><a name="libbrasero-burn-BraseroSessionCfg.top_of_page"></a>BraseroSessionCfg</span></h2>
37
<p>BraseroSessionCfg — Configure automatically a <a
38
href="../libbrasero-burn/libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession"
39
><span class="type">BraseroBurnSession</span></a> object</p>
41
<td valign="top" align="right"></td>
43
<div class="refsynopsisdiv">
44
<a name="libbrasero-burn-BraseroSessionCfg.synopsis"></a><h2>Synopsis</h2>
45
<pre class="synopsis">
47
#include <brasero-session-cfg.h>
50
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
51
>BraseroSessionCfg</a>;
53
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BRASERO-DRIVE-PROPERTIES-FLAGS--CAPS"
54
>BRASERO_DRIVE_PROPERTIES_FLAGS</a>
56
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError"
57
>BraseroSessionError</a>;
59
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BRASERO-SESSION-IS-VALID--CAPS"
60
>BRASERO_SESSION_IS_VALID</a> (result_MACRO)
62
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
63
>BraseroSessionCfg</a> * <a
64
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-new"
65
>brasero_session_cfg_new</a> (void);
67
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError"
68
>BraseroSessionError</a> <a
69
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-get-error"
70
>brasero_session_cfg_get_error</a> (<a
71
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
72
>BraseroSessionCfg</a> *cfg);
74
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-add-flags"
75
>brasero_session_cfg_add_flags</a> (<a
76
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
77
>BraseroSessionCfg</a> *cfg,
79
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
80
>BraseroBurnFlag</a> flags);
82
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-remove-flags"
83
>brasero_session_cfg_remove_flags</a> (<a
84
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
85
>BraseroSessionCfg</a> *cfg,
87
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
88
>BraseroBurnFlag</a> flags);
90
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
92
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-supported"
93
>brasero_session_cfg_is_supported</a> (<a
94
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
95
>BraseroSessionCfg</a> *cfg,
97
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
98
>BraseroBurnFlag</a> flag);
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
102
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-is-compulsory"
103
>brasero_session_cfg_is_compulsory</a> (<a
104
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
105
>BraseroSessionCfg</a> *cfg,
107
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
108
>BraseroBurnFlag</a> flag);
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
112
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-has-default-output-path"
113
>brasero_session_cfg_has_default_output_path</a>
115
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
116
>BraseroSessionCfg</a> *cfg);
118
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-enable"
119
>brasero_session_cfg_enable</a> (<a
120
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
121
>BraseroSessionCfg</a> *cfg);
123
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#brasero-session-cfg-disable"
124
>brasero_session_cfg_disable</a> (<a
125
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
126
>BraseroSessionCfg</a> *cfg);
129
<div class="refsect1" lang="en">
130
<a name="libbrasero-burn-BraseroSessionCfg.description"></a><h2>Description</h2>
132
This object configures automatically a session reacting to any change
133
made to the various parameters.</p>
137
<div class="refsect1" lang="en">
138
<a name="libbrasero-burn-BraseroSessionCfg.details"></a><h2>Details</h2>
139
<div class="refsect2" lang="en">
140
<a name="BraseroSessionCfg"></a><h3>BraseroSessionCfg</h3>
141
<pre class="programlisting">typedef struct {
142
BraseroSessionSpan parent_instance;
149
<div class="refsect2" lang="en">
150
<a name="BRASERO-DRIVE-PROPERTIES-FLAGS--CAPS"></a><h3>BRASERO_DRIVE_PROPERTIES_FLAGS</h3>
151
<pre class="programlisting">#define BRASERO_DRIVE_PROPERTIES_FLAGS</pre>
156
<div class="refsect2" lang="en">
157
<a name="BraseroSessionError"></a><h3>enum BraseroSessionError</h3>
158
<pre class="programlisting">typedef enum {
159
BRASERO_SESSION_VALID = 0,
160
BRASERO_SESSION_NO_CD_TEXT = 1,
161
BRASERO_SESSION_NOT_READY,
162
BRASERO_SESSION_EMPTY,
163
BRASERO_SESSION_NO_INPUT_IMAGE,
164
BRASERO_SESSION_UNKNOWN_IMAGE,
165
BRASERO_SESSION_NO_INPUT_MEDIUM,
166
BRASERO_SESSION_NO_OUTPUT,
167
BRASERO_SESSION_INSUFFICIENT_SPACE,
168
BRASERO_SESSION_OVERBURN_NECESSARY,
169
BRASERO_SESSION_NOT_SUPPORTED,
170
BRASERO_SESSION_DISC_PROTECTED
171
} BraseroSessionError;
177
<div class="refsect2" lang="en">
178
<a name="BRASERO-SESSION-IS-VALID--CAPS"></a><h3>BRASERO_SESSION_IS_VALID()</h3>
179
<pre class="programlisting">#define BRASERO_SESSION_IS_VALID(result_MACRO)</pre>
182
<div class="variablelist"><table border="0">
183
<col align="left" valign="top">
185
<td><p><span class="term"><em class="parameter"><code>result_MACRO</code></em> :</span></p></td>
192
<div class="refsect2" lang="en">
193
<a name="brasero-session-cfg-new"></a><h3>brasero_session_cfg_new ()</h3>
194
<pre class="programlisting"><a
195
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
196
>BraseroSessionCfg</a> * brasero_session_cfg_new (void);</pre>
199
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
200
><span class="type">BraseroSessionCfg</span></a> object.</p>
203
<div class="variablelist"><table border="0">
204
<col align="left" valign="top">
206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
208
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
209
><span class="type">BraseroSessionCfg</span></a> object.
215
<div class="refsect2" lang="en">
216
<a name="brasero-session-cfg-get-error"></a><h3>brasero_session_cfg_get_error ()</h3>
217
<pre class="programlisting"><a
218
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError"
219
>BraseroSessionError</a> brasero_session_cfg_get_error (<a
220
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
221
>BraseroSessionCfg</a> *cfg);</pre>
223
This function returns the current status and if
224
autoconfiguration is/was successful.</p>
227
<div class="variablelist"><table border="0">
228
<col align="left" valign="top">
231
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
233
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
234
><span class="type">BraseroSessionCfg</span></a>
238
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
240
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionError"
241
><span class="type">BraseroSessionError</span></a>.
248
<div class="refsect2" lang="en">
249
<a name="brasero-session-cfg-add-flags"></a><h3>brasero_session_cfg_add_flags ()</h3>
250
<pre class="programlisting">void brasero_session_cfg_add_flags (<a
251
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
252
>BraseroSessionCfg</a> *cfg,
254
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
255
>BraseroBurnFlag</a> flags);</pre>
257
Adds all flags from <em class="parameter"><code>flags</code></em> that are supported.</p>
260
<div class="variablelist"><table border="0">
261
<col align="left" valign="top">
264
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
266
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
267
><span class="type">BraseroSessionCfg</span></a>
271
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
273
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
274
><span class="type">BraseroBurnFlag</span></a>
281
<div class="refsect2" lang="en">
282
<a name="brasero-session-cfg-remove-flags"></a><h3>brasero_session_cfg_remove_flags ()</h3>
283
<pre class="programlisting">void brasero_session_cfg_remove_flags (<a
284
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
285
>BraseroSessionCfg</a> *cfg,
287
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
288
>BraseroBurnFlag</a> flags);</pre>
290
Removes all flags that are not compulsory.</p>
293
<div class="variablelist"><table border="0">
294
<col align="left" valign="top">
297
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
299
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
300
><span class="type">BraseroSessionCfg</span></a>
304
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
306
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
307
><span class="type">BraseroBurnFlag</span></a>
314
<div class="refsect2" lang="en">
315
<a name="brasero-session-cfg-is-supported"></a><h3>brasero_session_cfg_is_supported ()</h3>
316
<pre class="programlisting"><a
317
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
318
>gboolean</a> brasero_session_cfg_is_supported (<a
319
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
320
>BraseroSessionCfg</a> *cfg,
322
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
323
>BraseroBurnFlag</a> flag);</pre>
325
Checks whether a particular flag is supported.</p>
328
<div class="variablelist"><table border="0">
329
<col align="left" valign="top">
332
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
334
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
335
><span class="type">BraseroSessionCfg</span></a>
339
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
341
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
342
><span class="type">BraseroBurnFlag</span></a>
346
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
348
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
349
><span class="type">gboolean</span></a>. TRUE if it is supported;
357
<div class="refsect2" lang="en">
358
<a name="brasero-session-cfg-is-compulsory"></a><h3>brasero_session_cfg_is_compulsory ()</h3>
359
<pre class="programlisting"><a
360
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
361
>gboolean</a> brasero_session_cfg_is_compulsory (<a
362
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
363
>BraseroSessionCfg</a> *cfg,
365
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
366
>BraseroBurnFlag</a> flag);</pre>
368
Checks whether a particular flag is compulsory.</p>
371
<div class="variablelist"><table border="0">
372
<col align="left" valign="top">
375
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
377
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
378
><span class="type">BraseroSessionCfg</span></a>
382
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
384
href="../libbrasero-burn/libbrasero-burn-brasero-enums.html#BraseroBurnFlag"
385
><span class="type">BraseroBurnFlag</span></a>
389
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
391
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
392
><span class="type">gboolean</span></a>. TRUE if it is compulsory;
400
<div class="refsect2" lang="en">
401
<a name="brasero-session-cfg-has-default-output-path"></a><h3>brasero_session_cfg_has_default_output_path ()</h3>
402
<pre class="programlisting"><a
403
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
404
>gboolean</a> brasero_session_cfg_has_default_output_path
406
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
407
>BraseroSessionCfg</a> *cfg);</pre>
409
This function returns whether the path returned
411
href="../libbrasero-burn/libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-output"
412
><code class="function">brasero_burn_session_get_output()</code></a> is an
413
automatically created one.</p>
416
<div class="variablelist"><table border="0">
417
<col align="left" valign="top">
420
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
422
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
423
><span class="type">BraseroSessionCfg</span></a>
427
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
429
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
430
><span class="type">gboolean</span></a>. TRUE if the path(s)
431
creation is handled by <em class="parameter"><code>session</code></em>, FALSE if it was
439
<div class="refsect2" lang="en">
440
<a name="brasero-session-cfg-enable"></a><h3>brasero_session_cfg_enable ()</h3>
441
<pre class="programlisting">void brasero_session_cfg_enable (<a
442
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
443
>BraseroSessionCfg</a> *cfg);</pre>
445
This function (re)-enables autoconfiguration</p>
448
<div class="variablelist"><table border="0">
449
<col align="left" valign="top">
451
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
453
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
454
><span class="type">BraseroSessionCfg</span></a>
460
<div class="refsect2" lang="en">
461
<a name="brasero-session-cfg-disable"></a><h3>brasero_session_cfg_disable ()</h3>
462
<pre class="programlisting">void brasero_session_cfg_disable (<a
463
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
464
>BraseroSessionCfg</a> *cfg);</pre>
466
This function disables autoconfiguration</p>
469
<div class="variablelist"><table border="0">
470
<col align="left" valign="top">
472
<td><p><span class="term"><em class="parameter"><code>cfg</code></em> :</span></p></td>
474
href="../libbrasero-burn/libbrasero-burn-BraseroSessionCfg.html#BraseroSessionCfg"
475
><span class="type">BraseroSessionCfg</span></a>
481
<div class="refsect1" lang="en">
482
<a name="libbrasero-burn-BraseroSessionCfg.see-also"></a><h2>See Also</h2>
484
href="../libbrasero-burn/libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession"
485
><span class="type">BraseroBurnSession</span></a>
490
Generated by GTK-Doc V1.11</div>