libburner-media3-dev 3.0.4-0ubuntu1 / usr / share / gtk-doc / html / libburner-burn / libburner-burn-BurnerSessionSpan.html

This file is indexed.

/usr/share/gtk-doc/html/libburner-burn/libburner-burn-BurnerSessionSpan.html is in libburner-media3-dev 3.0.4-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
265
266
267
268
269
270
271
272
273
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BurnerSessionSpan: Libburner-burn Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libburner-burn Reference Manual">
<link rel="up" href="ch01.html" title="API Reference for Libburner-burn">
<link rel="prev" href="libburner-burn-BurnerBurnSession.html" title="BurnerBurnSession">
<link rel="next" href="libburner-burn-BurnerSessionCfg.html" title="BurnerSessionCfg">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libburner-burn-BurnerSessionSpan.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libburner-burn-BurnerBurnSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libburner-burn-BurnerSessionCfg.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libburner-burn-BurnerSessionSpan"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libburner-burn-BurnerSessionSpan.top_of_page"></a>BurnerSessionSpan</span></h2>
<p>BurnerSessionSpan</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libburner-burn-BurnerSessionSpan.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="returnvalue">BurnerSessionSpan</span></a> *
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-new" title="burner_session_span_new ()">burner_session_span_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-again" title="burner_session_span_again ()">burner_session_span_again</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-possible" title="burner_session_span_possible ()">burner_session_span_possible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-start" title="burner_session_span_start ()">burner_session_span_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-next" title="burner_session_span_next ()">burner_session_span_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-stop" title="burner_session_span_stop ()">burner_session_span_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libburner-burn-BurnerSessionSpan.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan">BurnerSessionSpan</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libburner-burn-BurnerSessionSpan.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libburner-burn-BurnerSessionSpan.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="burner-session-span-new"></a><h3>burner_session_span_new ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="returnvalue">BurnerSessionSpan</span></a> *
burner_session_span_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> object.</p>
<div class="refsect3">
<a name="burner-session-span-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-session-span-again"></a><h3>burner_session_span_again ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
burner_session_span_again (<em class="parameter"><code><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> *session</code></em>);</pre>
<p>Checks whether some data were not included during calls to <a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-next" title="burner_session_span_next ()"><code class="function">burner_session_span_next()</code></a>.</p>
<div class="refsect3">
<a name="burner-session-span-again.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-session-span-again.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="type">BurnerBurnResult</span></a>. BURNER_BURN_OK if there is not anymore data.
BURNER_BURN_RETRY if the operation was successful and a new <a class="link" href="libburner-burn-burner-track-data-cfg.html#BurnerTrackDataCfg" title="struct BurnerTrackDataCfg"><span class="type">BurnerTrackDataCfg</span></a> was created.
BURNER_BURN_ERR otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-session-span-possible"></a><h3>burner_session_span_possible ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
burner_session_span_possible (<em class="parameter"><code><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> *session</code></em>);</pre>
<p>Checks if a new <a class="link" href="libburner-burn-burner-track-data.html#BurnerTrackData" title="struct BurnerTrackData"><span class="type">BurnerTrackData</span></a> can be created from the files remaining in the tree 
after calls to <a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-next" title="burner_session_span_next ()"><code class="function">burner_session_span_next()</code></a>. The maximum size of the data will be the one
of the medium inserted in the <a href="../html/libburner-media-burner-drive.html#BurnerDrive"><span class="type">BurnerDrive</span></a> set for <em class="parameter"><code>session</code></em>
 (see <a class="link" href="libburner-burn-BurnerBurnSession.html#burner-burn-session-set-burner" title="burner_burn_session_set_burner ()"><code class="function">burner_burn_session_set_burner()</code></a>).</p>
<div class="refsect3">
<a name="burner-session-span-possible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-session-span-possible.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="type">BurnerBurnResult</span></a>. BURNER_BURN_OK if there is not anymore data.
BURNER_BURN_RETRY if the operation was successful and a new <a class="link" href="libburner-burn-burner-track-data-cfg.html#BurnerTrackDataCfg" title="struct BurnerTrackDataCfg"><span class="type">BurnerTrackDataCfg</span></a> was created.
BURNER_BURN_ERR otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-session-span-start"></a><h3>burner_session_span_start ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
burner_session_span_start (<em class="parameter"><code><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> *session</code></em>);</pre>
<p>Get the object ready for spanning a <a class="link" href="libburner-burn-BurnerBurnSession.html#BurnerBurnSession" title="struct BurnerBurnSession"><span class="type">BurnerBurnSession</span></a> object. This function
must be called before <a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-next" title="burner_session_span_next ()"><code class="function">burner_session_span_next()</code></a>.</p>
<div class="refsect3">
<a name="burner-session-span-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-session-span-start.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="type">BurnerBurnResult</span></a>. BURNER_BURN_OK if successful.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-session-span-next"></a><h3>burner_session_span_next ()</h3>
<pre class="programlisting"><a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="returnvalue">BurnerBurnResult</span></a>
burner_session_span_next (<em class="parameter"><code><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> *session</code></em>);</pre>
<p>Sets the next batch of data to be burnt onto the medium inserted in the <a href="../html/libburner-media-burner-drive.html#BurnerDrive"><span class="type">BurnerDrive</span></a>
set for <em class="parameter"><code>session</code></em>
 (see <a class="link" href="libburner-burn-BurnerBurnSession.html#burner-burn-session-set-burner" title="burner_burn_session_set_burner ()"><code class="function">burner_burn_session_set_burner()</code></a>). Its free space or it capacity
will be used as the maximum amount of data to be burnt.</p>
<div class="refsect3">
<a name="burner-session-span-next.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="burner-session-span-next.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libburner-burn-burner-enums.html#BurnerBurnResult" title="enum BurnerBurnResult"><span class="type">BurnerBurnResult</span></a>. BURNER_BURN_OK if successful.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="burner-session-span-stop"></a><h3>burner_session_span_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
burner_session_span_stop (<em class="parameter"><code><a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a> *session</code></em>);</pre>
<p>Ends and cleans a spanning operation started with <a class="link" href="libburner-burn-BurnerSessionSpan.html#burner-session-span-start" title="burner_session_span_start ()"><code class="function">burner_session_span_start()</code></a>.</p>
<div class="refsect3">
<a name="burner-session-span-stop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>a <a class="link" href="libburner-burn-BurnerSessionSpan.html#BurnerSessionSpan" title="struct BurnerSessionSpan"><span class="type">BurnerSessionSpan</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libburner-burn-BurnerSessionSpan.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BurnerSessionSpan"></a><h3>struct BurnerSessionSpan</h3>
<pre class="programlisting">struct BurnerSessionSpan {
	BurnerBurnSession parent_instance;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.