2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
<!ENTITY version SYSTEM "version.xml">
7
<refentry id="BraseroMedium">
9
<refentrytitle role="top_of_page" id="BraseroMedium.top_of_page">BraseroMedium</refentrytitle>
10
<manvolnum>3</manvolnum>
11
<refmiscinfo>BRASERO Library</refmiscinfo>
15
<refname>BraseroMedium</refname>
16
<refpurpose></refpurpose>
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
20
<refsynopsisdiv id="BraseroMedium.synopsis" role="synopsis">
21
<title role="synopsis.title">Synopsis</title>
22
<anchor id="BraseroDrive"/>
24
<link linkend="BraseroDrive-struct">BraseroDrive</link>;
25
<link linkend="BraseroMedium-struct">BraseroMedium</link>;
26
<link linkend="BraseroMedia">BraseroMedia</link> <link linkend="brasero-medium-get-status">brasero_medium_get_status</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
27
<link linkend="guint64">guint64</link> <link linkend="brasero-medium-get-max-write-speed">brasero_medium_get_max_write_speed</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
28
<link linkend="guint64">guint64</link>* <link linkend="brasero-medium-get-write-speeds">brasero_medium_get_write_speeds</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
29
<link linkend="void">void</link> <link linkend="brasero-medium-get-free-space">brasero_medium_get_free_space</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
30
<link linkend="gint64">gint64</link> *size,
31
<link linkend="gint64">gint64</link> *blocks);
32
<link linkend="void">void</link> <link linkend="brasero-medium-get-capacity">brasero_medium_get_capacity</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
33
<link linkend="gint64">gint64</link> *size,
34
<link linkend="gint64">gint64</link> *blocks);
35
<link linkend="void">void</link> <link linkend="brasero-medium-get-data-size">brasero_medium_get_data_size</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
36
<link linkend="gint64">gint64</link> *size,
37
<link linkend="gint64">gint64</link> *blocks);
38
<link linkend="gint64">gint64</link> <link linkend="brasero-medium-get-next-writable-address">brasero_medium_get_next_writable_address</link>
39
(<link linkend="BraseroMedium">BraseroMedium</link> *medium);
40
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-can-be-rewritten">brasero_medium_can_be_rewritten</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
41
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-can-be-written">brasero_medium_can_be_written</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
42
const <link linkend="gchar">gchar</link>* <link linkend="brasero-medium-get-CD-TEXT-title">brasero_medium_get_CD_TEXT_title</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
43
const <link linkend="gchar">gchar</link>* <link linkend="brasero-medium-get-type-string">brasero_medium_get_type_string</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
44
<link linkend="gchar">gchar</link>* <link linkend="brasero-medium-get-tooltip">brasero_medium_get_tooltip</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
45
<link linkend="BraseroDrive">BraseroDrive</link>* <link linkend="brasero-medium-get-drive">brasero_medium_get_drive</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
46
<link linkend="guint">guint</link> <link linkend="brasero-medium-get-track-num">brasero_medium_get_track_num</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium);
47
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-get-last-data-track-space">brasero_medium_get_last_data_track_space</link>
48
(<link linkend="BraseroMedium">BraseroMedium</link> *medium,
49
<link linkend="gint64">gint64</link> *size,
50
<link linkend="gint64">gint64</link> *blocks);
51
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-get-last-data-track-address">brasero_medium_get_last_data_track_address</link>
52
(<link linkend="BraseroMedium">BraseroMedium</link> *medium,
53
<link linkend="gint64">gint64</link> *byte,
54
<link linkend="gint64">gint64</link> *sector);
55
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-get-track-space">brasero_medium_get_track_space</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
56
<link linkend="guint">guint</link> num,
57
<link linkend="gint64">gint64</link> *size,
58
<link linkend="gint64">gint64</link> *blocks);
59
<link linkend="gboolean">gboolean</link> <link linkend="brasero-medium-get-track-address">brasero_medium_get_track_address</link> (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
60
<link linkend="guint">guint</link> num,
61
<link linkend="gint64">gint64</link> *byte,
62
<link linkend="gint64">gint64</link> *sector);
66
<refsect1 id="BraseroMedium.object-hierarchy" role="object_hierarchy">
67
<title role="object_hierarchy.title">Object Hierarchy</title>
69
<link linkend="GObject">GObject</link>
73
<link linkend="GObject">GObject</link>
75
+----<link linkend="BraseroVolume">BraseroVolume</link>
84
<refsect1 id="BraseroMedium.properties" role="properties">
85
<title role="properties.title">Properties</title>
87
"<link linkend="BraseroDrive--udi">udi</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
88
"<link linkend="BraseroMedium--drive">drive</link>" <link linkend="BraseroDrive">BraseroDrive</link>* : Read / Write / Construct Only
92
<refsect1 id="BraseroMedium.signals" role="signal_proto">
93
<title role="signal_proto.title">Signals</title>
95
"<link linkend="BraseroDrive-medium-added">medium-added</link>" : Run Last / No Recursion
96
"<link linkend="BraseroDrive-medium-removed">medium-removed</link>" : Run Last / No Recursion
97
"<link linkend="BraseroMedium-probed">probed</link>" : Run Last / No Recursion
102
<refsect1 id="BraseroMedium.description" role="desc">
103
<title role="desc.title">Description</title>
109
<refsect1 id="BraseroMedium.details" role="details">
110
<title role="details.title">Details</title>
111
<refsect2 id="BraseroDrive-struct" role="struct">
112
<title>BraseroDrive</title>
113
<indexterm zone="BraseroDrive-struct"><primary>BraseroDrive</primary></indexterm><programlisting>typedef struct _BraseroDrive BraseroDrive;</programlisting>
117
<refsect2 id="BraseroMedium-struct" role="struct">
118
<title>BraseroMedium</title>
119
<indexterm zone="BraseroMedium-struct"><primary>BraseroMedium</primary></indexterm><programlisting>typedef struct _BraseroMedium BraseroMedium;</programlisting>
123
<refsect2 id="brasero-medium-get-status" role="function">
124
<title>brasero_medium_get_status ()</title>
125
<indexterm zone="brasero-medium-get-status"><primary>brasero_medium_get_status</primary></indexterm><programlisting><link linkend="BraseroMedia">BraseroMedia</link> brasero_medium_get_status (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
127
Gets the medium type and state.</para>
130
</para><variablelist role="params">
131
<varlistentry><term><parameter>medium</parameter> :</term>
132
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
133
</simpara></listitem></varlistentry>
134
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="BraseroMedia"><type>BraseroMedia</type></link>.
136
</simpara></listitem></varlistentry>
137
</variablelist></refsect2>
138
<refsect2 id="brasero-medium-get-max-write-speed" role="function">
139
<title>brasero_medium_get_max_write_speed ()</title>
140
<indexterm zone="brasero-medium-get-max-write-speed"><primary>brasero_medium_get_max_write_speed</primary></indexterm><programlisting><link linkend="guint64">guint64</link> brasero_medium_get_max_write_speed (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
142
Gets the maximum speed that can be used to write to <parameter>medium</parameter>.
143
Note: the speed are in B/sec.</para>
146
</para><variablelist role="params">
147
<varlistentry><term><parameter>medium</parameter> :</term>
148
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
149
</simpara></listitem></varlistentry>
150
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gint64"><type>gint64</type></link>.
152
</simpara></listitem></varlistentry>
153
</variablelist></refsect2>
154
<refsect2 id="brasero-medium-get-write-speeds" role="function">
155
<title>brasero_medium_get_write_speeds ()</title>
156
<indexterm zone="brasero-medium-get-write-speeds"><primary>brasero_medium_get_write_speeds</primary></indexterm><programlisting><link linkend="guint64">guint64</link>* brasero_medium_get_write_speeds (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
158
Gets an array holding all possible speeds to write to <parameter>medium</parameter>.
159
Note: the speed are in B/sec.</para>
162
</para><variablelist role="params">
163
<varlistentry><term><parameter>medium</parameter> :</term>
164
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
165
</simpara></listitem></varlistentry>
166
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> *.
168
</simpara></listitem></varlistentry>
169
</variablelist></refsect2>
170
<refsect2 id="brasero-medium-get-free-space" role="function">
171
<title>brasero_medium_get_free_space ()</title>
172
<indexterm zone="brasero-medium-get-free-space"><primary>brasero_medium_get_free_space</primary></indexterm><programlisting><link linkend="void">void</link> brasero_medium_get_free_space (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
173
<link linkend="gint64">gint64</link> *size,
174
<link linkend="gint64">gint64</link> *blocks);</programlisting>
176
Stores in either <parameter>size</parameter> (in bytes) or <parameter>blocks</parameter> (the number of blocks) the space
177
on the disc that can be used for writing.</para>
180
</para><variablelist role="params">
181
<varlistentry><term><parameter>medium</parameter> :</term>
182
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><parameter>size</parameter> :</term>
185
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
186
</simpara></listitem></varlistentry>
187
<varlistentry><term><parameter>blocks</parameter> :</term>
188
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
189
</simpara></listitem></varlistentry>
190
</variablelist></refsect2>
191
<refsect2 id="brasero-medium-get-capacity" role="function">
192
<title>brasero_medium_get_capacity ()</title>
193
<indexterm zone="brasero-medium-get-capacity"><primary>brasero_medium_get_capacity</primary></indexterm><programlisting><link linkend="void">void</link> brasero_medium_get_capacity (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
194
<link linkend="gint64">gint64</link> *size,
195
<link linkend="gint64">gint64</link> *blocks);</programlisting>
197
Stores in either <parameter>size</parameter> (in bytes) or <parameter>blocks</parameter> (the number of blocks) the total
199
Note that when the disc is closed this space is the one occupied by data.
200
Otherwise it is the sum of free and used space.</para>
203
</para><variablelist role="params">
204
<varlistentry><term><parameter>medium</parameter> :</term>
205
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
206
</simpara></listitem></varlistentry>
207
<varlistentry><term><parameter>size</parameter> :</term>
208
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
209
</simpara></listitem></varlistentry>
210
<varlistentry><term><parameter>blocks</parameter> :</term>
211
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
212
</simpara></listitem></varlistentry>
213
</variablelist></refsect2>
214
<refsect2 id="brasero-medium-get-data-size" role="function">
215
<title>brasero_medium_get_data_size ()</title>
216
<indexterm zone="brasero-medium-get-data-size"><primary>brasero_medium_get_data_size</primary></indexterm><programlisting><link linkend="void">void</link> brasero_medium_get_data_size (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
217
<link linkend="gint64">gint64</link> *size,
218
<link linkend="gint64">gint64</link> *blocks);</programlisting>
220
Stores in either <parameter>size</parameter> (in bytes) or <parameter>blocks</parameter> (the number of blocks) the size
221
used to store data (including audio on CDs) on the disc.</para>
224
</para><variablelist role="params">
225
<varlistentry><term><parameter>medium</parameter> :</term>
226
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
227
</simpara></listitem></varlistentry>
228
<varlistentry><term><parameter>size</parameter> :</term>
229
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
230
</simpara></listitem></varlistentry>
231
<varlistentry><term><parameter>blocks</parameter> :</term>
232
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
233
</simpara></listitem></varlistentry>
234
</variablelist></refsect2>
235
<refsect2 id="brasero-medium-get-next-writable-address" role="function">
236
<title>brasero_medium_get_next_writable_address ()</title>
237
<indexterm zone="brasero-medium-get-next-writable-address"><primary>brasero_medium_get_next_writable_address</primary></indexterm><programlisting><link linkend="gint64">gint64</link> brasero_medium_get_next_writable_address
238
(<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
240
Gets the address (block number) that can be used to write a new session on <parameter>medium</parameter></para>
243
</para><variablelist role="params">
244
<varlistentry><term><parameter>medium</parameter> :</term>
245
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
246
</simpara></listitem></varlistentry>
247
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gint64"><type>gint64</type></link>.
249
</simpara></listitem></varlistentry>
250
</variablelist></refsect2>
251
<refsect2 id="brasero-medium-can-be-rewritten" role="function">
252
<title>brasero_medium_can_be_rewritten ()</title>
253
<indexterm zone="brasero-medium-can-be-rewritten"><primary>brasero_medium_can_be_rewritten</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_can_be_rewritten (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
255
Gets whether the medium can be rewritten. Note: it also checks that the drive
256
can rewrite the medium type.</para>
259
</para><variablelist role="params">
260
<varlistentry><term><parameter>medium</parameter> :</term>
261
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
262
</simpara></listitem></varlistentry>
263
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if the medium can be rewritten, FALSE otherwise.
265
</simpara></listitem></varlistentry>
266
</variablelist></refsect2>
267
<refsect2 id="brasero-medium-can-be-written" role="function">
268
<title>brasero_medium_can_be_written ()</title>
269
<indexterm zone="brasero-medium-can-be-written"><primary>brasero_medium_can_be_written</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_can_be_written (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
271
Gets whether the medium can be written. It also checks that the medium can
272
write the medium.</para>
275
</para><variablelist role="params">
276
<varlistentry><term><parameter>medium</parameter> :</term>
277
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
278
</simpara></listitem></varlistentry>
279
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. TRUE if the medium can be rewritten, FALSE otherwise.
281
</simpara></listitem></varlistentry>
282
</variablelist></refsect2>
283
<refsect2 id="brasero-medium-get-CD-TEXT-title" role="function">
284
<title>brasero_medium_get_CD_TEXT_title ()</title>
285
<indexterm zone="brasero-medium-get-CD-TEXT-title"><primary>brasero_medium_get_CD_TEXT_title</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* brasero_medium_get_CD_TEXT_title (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
287
Gets the CD-TEXT title for <parameter>Medium</parameter>.</para>
290
</para><variablelist role="params">
291
<varlistentry><term><parameter>medium</parameter> :</term>
292
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
293
</simpara></listitem></varlistentry>
294
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> *.
296
</simpara></listitem></varlistentry>
297
</variablelist></refsect2>
298
<refsect2 id="brasero-medium-get-type-string" role="function">
299
<title>brasero_medium_get_type_string ()</title>
300
<indexterm zone="brasero-medium-get-type-string"><primary>brasero_medium_get_type_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* brasero_medium_get_type_string (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
302
Returns the medium type as a string to be displayed in a UI.</para>
305
</para><variablelist role="params">
306
<varlistentry><term><parameter>medium</parameter> :</term>
307
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
308
</simpara></listitem></varlistentry>
309
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> *.
311
</simpara></listitem></varlistentry>
312
</variablelist></refsect2>
313
<refsect2 id="brasero-medium-get-tooltip" role="function">
314
<title>brasero_medium_get_tooltip ()</title>
315
<indexterm zone="brasero-medium-get-tooltip"><primary>brasero_medium_get_tooltip</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* brasero_medium_get_tooltip (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
317
Returns a tooltip to be displayed in the UI.
318
It is of the form {content type} {disc type} in {drive name}.</para>
321
</para><variablelist role="params">
322
<varlistentry><term><parameter>medium</parameter> :</term>
323
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
324
</simpara></listitem></varlistentry>
325
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> *.
327
</simpara></listitem></varlistentry>
328
</variablelist></refsect2>
329
<refsect2 id="brasero-medium-get-drive" role="function">
330
<title>brasero_medium_get_drive ()</title>
331
<indexterm zone="brasero-medium-get-drive"><primary>brasero_medium_get_drive</primary></indexterm><programlisting><link linkend="BraseroDrive">BraseroDrive</link>* brasero_medium_get_drive (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
333
Gets the <link linkend="BraseroDrive"><type>BraseroDrive</type></link> in which the medium is inserted.</para>
336
</para><variablelist role="params">
337
<varlistentry><term><parameter>medium</parameter> :</term>
338
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
339
</simpara></listitem></varlistentry>
340
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="BraseroDrive"><type>BraseroDrive</type></link>. No need to unref after use.
342
</simpara></listitem></varlistentry>
343
</variablelist></refsect2>
344
<refsect2 id="brasero-medium-get-track-num" role="function">
345
<title>brasero_medium_get_track_num ()</title>
346
<indexterm zone="brasero-medium-get-track-num"><primary>brasero_medium_get_track_num</primary></indexterm><programlisting><link linkend="guint">guint</link> brasero_medium_get_track_num (<link linkend="BraseroMedium">BraseroMedium</link> *medium);</programlisting>
348
Gets the number of tracks on the medium.</para>
351
</para><variablelist role="params">
352
<varlistentry><term><parameter>medium</parameter> :</term>
353
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
354
</simpara></listitem></varlistentry>
355
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="guint"><type>guint</type></link>.
357
</simpara></listitem></varlistentry>
358
</variablelist></refsect2>
359
<refsect2 id="brasero-medium-get-last-data-track-space" role="function">
360
<title>brasero_medium_get_last_data_track_space ()</title>
361
<indexterm zone="brasero-medium-get-last-data-track-space"><primary>brasero_medium_get_last_data_track_space</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_get_last_data_track_space
362
(<link linkend="BraseroMedium">BraseroMedium</link> *medium,
363
<link linkend="gint64">gint64</link> *size,
364
<link linkend="gint64">gint64</link> *blocks);</programlisting>
366
Stores in either <parameter>size</parameter> (in bytes) or in <parameter>blocks</parameter> (in blocks) the space used by
367
the last track on the medium.</para>
370
</para><variablelist role="params">
371
<varlistentry><term><parameter>medium</parameter> :</term>
372
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
373
</simpara></listitem></varlistentry>
374
<varlistentry><term><parameter>size</parameter> :</term>
375
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
376
</simpara></listitem></varlistentry>
377
<varlistentry><term><parameter>blocks</parameter> :</term>
378
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
379
</simpara></listitem></varlistentry>
380
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
383
</simpara></listitem></varlistentry>
384
</variablelist></refsect2>
385
<refsect2 id="brasero-medium-get-last-data-track-address" role="function">
386
<title>brasero_medium_get_last_data_track_address ()</title>
387
<indexterm zone="brasero-medium-get-last-data-track-address"><primary>brasero_medium_get_last_data_track_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_get_last_data_track_address
388
(<link linkend="BraseroMedium">BraseroMedium</link> *medium,
389
<link linkend="gint64">gint64</link> *byte,
390
<link linkend="gint64">gint64</link> *sector);</programlisting>
392
Stores in either <parameter>byte</parameter> (in bytes) or in <parameter>sector</parameter> (in blocks) the address where
393
the last session starts. This is useful when creating a multisession image or
394
when reading the contents of this last track.</para>
397
</para><variablelist role="params">
398
<varlistentry><term><parameter>medium</parameter> :</term>
399
<listitem><simpara> <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
400
</simpara></listitem></varlistentry>
401
<varlistentry><term><parameter>byte</parameter> :</term>
402
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
403
</simpara></listitem></varlistentry>
404
<varlistentry><term><parameter>sector</parameter> :</term>
405
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
406
</simpara></listitem></varlistentry>
407
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
410
</simpara></listitem></varlistentry>
411
</variablelist></refsect2>
412
<refsect2 id="brasero-medium-get-track-space" role="function">
413
<title>brasero_medium_get_track_space ()</title>
414
<indexterm zone="brasero-medium-get-track-space"><primary>brasero_medium_get_track_space</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_get_track_space (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
415
<link linkend="guint">guint</link> num,
416
<link linkend="gint64">gint64</link> *size,
417
<link linkend="gint64">gint64</link> *blocks);</programlisting>
419
Stores in either <parameter>size</parameter> (in bytes) or in <parameter>blocks</parameter> (in blocks) the space used
420
by session <parameter>num</parameter> on the disc.</para>
423
</para><variablelist role="params">
424
<varlistentry><term><parameter>medium</parameter> :</term>
425
<listitem><simpara> a <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
426
</simpara></listitem></varlistentry>
427
<varlistentry><term><parameter>num</parameter> :</term>
428
<listitem><simpara> a <link linkend="guint"><type>guint</type></link>
429
</simpara></listitem></varlistentry>
430
<varlistentry><term><parameter>size</parameter> :</term>
431
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
432
</simpara></listitem></varlistentry>
433
<varlistentry><term><parameter>blocks</parameter> :</term>
434
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
435
</simpara></listitem></varlistentry>
436
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. Returns TRUE if information could be retrieved;
437
FALSE otherwise (usually when track <parameter>num</parameter> doesn't exist).
439
</simpara></listitem></varlistentry>
440
</variablelist></refsect2>
441
<refsect2 id="brasero-medium-get-track-address" role="function">
442
<title>brasero_medium_get_track_address ()</title>
443
<indexterm zone="brasero-medium-get-track-address"><primary>brasero_medium_get_track_address</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> brasero_medium_get_track_address (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
444
<link linkend="guint">guint</link> num,
445
<link linkend="gint64">gint64</link> *byte,
446
<link linkend="gint64">gint64</link> *sector);</programlisting>
448
Stores in either <parameter>byte</parameter> (in bytes) or in <parameter>sector</parameter> (in blocks) the address at
449
which the session identified by <parameter>num</parameter> starts.</para>
452
</para><variablelist role="params">
453
<varlistentry><term><parameter>medium</parameter> :</term>
454
<listitem><simpara> a <link linkend="BraseroMedium"><type>BraseroMedium</type></link>
455
</simpara></listitem></varlistentry>
456
<varlistentry><term><parameter>num</parameter> :</term>
457
<listitem><simpara> a <link linkend="guint"><type>guint</type></link>
458
</simpara></listitem></varlistentry>
459
<varlistentry><term><parameter>byte</parameter> :</term>
460
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
461
</simpara></listitem></varlistentry>
462
<varlistentry><term><parameter>sector</parameter> :</term>
463
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> * or NULL
464
</simpara></listitem></varlistentry>
465
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>. Returns TRUE if information could be retrieved;
466
FALSE otherwise (usually when track <parameter>num</parameter> doesn't exist).
468
</simpara></listitem></varlistentry>
469
</variablelist></refsect2>
472
<refsect1 id="BraseroMedium.property-details" role="property_details">
473
<title role="property_details.title">Property Details</title>
474
<refsect2 id="BraseroDrive--udi"><title>The <literal>"udi"</literal> property</title>
475
<indexterm zone="BraseroDrive--udi"><primary>BraseroDrive:udi</primary></indexterm><programlisting> "udi" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
476
<para>HAL udi as a string.</para><para>Default value: NULL</para>
478
<refsect2 id="BraseroMedium--drive"><title>The <literal>"drive"</literal> property</title>
479
<indexterm zone="BraseroMedium--drive"><primary>BraseroMedium:drive</primary></indexterm><programlisting> "drive" <link linkend="BraseroDrive">BraseroDrive</link>* : Read / Write / Construct Only</programlisting>
480
<para>Drive in which medium is inserted.</para></refsect2>
484
<refsect1 id="BraseroMedium.signal-details" role="signals">
485
<title role="signals.title">Signal Details</title>
486
<refsect2 id="BraseroDrive-medium-added"><title>The <literal>"medium-added"</literal> signal</title>
487
<indexterm zone="BraseroDrive-medium-added"><primary>BraseroDrive::medium-added</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="BraseroDrive">BraseroDrive</link> *drive,
488
<link linkend="BraseroMedium">BraseroMedium</link> *medium,
489
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
491
This signal gets emitted when a new medium was detected</para>
494
</para><variablelist role="params">
495
<varlistentry><term><parameter>drive</parameter> :</term>
496
<listitem><simpara> the object which received the signal
497
</simpara></listitem></varlistentry>
498
<varlistentry><term><parameter>medium</parameter> :</term>
499
<listitem><simpara> the new medium which was added
500
</simpara></listitem></varlistentry>
501
<varlistentry><term><parameter>user_data</parameter> :</term>
502
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
503
</variablelist></refsect2><refsect2 id="BraseroDrive-medium-removed"><title>The <literal>"medium-removed"</literal> signal</title>
504
<indexterm zone="BraseroDrive-medium-removed"><primary>BraseroDrive::medium-removed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="BraseroDrive">BraseroDrive</link> *drive,
505
<link linkend="BraseroMedium">BraseroMedium</link> *medium,
506
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
508
This signal gets emitted when a medium is not longer available</para>
511
</para><variablelist role="params">
512
<varlistentry><term><parameter>drive</parameter> :</term>
513
<listitem><simpara> the object which received the signal
514
</simpara></listitem></varlistentry>
515
<varlistentry><term><parameter>medium</parameter> :</term>
516
<listitem><simpara> the medium which was removed
517
</simpara></listitem></varlistentry>
518
<varlistentry><term><parameter>user_data</parameter> :</term>
519
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
520
</variablelist></refsect2><refsect2 id="BraseroMedium-probed"><title>The <literal>"probed"</literal> signal</title>
521
<indexterm zone="BraseroMedium-probed"><primary>BraseroMedium::probed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="BraseroMedium">BraseroMedium</link> *medium,
522
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
524
This signal gets emitted when the medium inside the drive has been
525
fully probed. This is mostly for internal use.</para>
528
</para><variablelist role="params">
529
<varlistentry><term><parameter>medium</parameter> :</term>
530
<listitem><simpara> the object which received the signal
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><parameter>user_data</parameter> :</term>
533
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
534
</variablelist></refsect2>
added
removed
docs/reference/xml/brasero-medium.xml
