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="brasero-brasero-units">
9
<refentrytitle role="top_of_page" id="brasero-brasero-units.top_of_page">brasero-units</refentrytitle>
10
<manvolnum>3</manvolnum>
11
<refmiscinfo>BRASERO Library</refmiscinfo>
15
<refname>brasero-units</refname>
16
<refpurpose></refpurpose>
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
20
<refsynopsisdiv id="brasero-brasero-units.synopsis" role="synopsis">
21
<title role="synopsis.title">Synopsis</title>
24
#define <link linkend="CD-RATE:CAPS">CD_RATE</link>
25
#define <link linkend="DVD-RATE:CAPS">DVD_RATE</link>
26
#define <link linkend="BD-RATE:CAPS">BD_RATE</link>
27
#define <link linkend="BRASERO-SPEED-TO-RATE-CD:CAPS">BRASERO_SPEED_TO_RATE_CD</link> (speed)
28
#define <link linkend="BRASERO-SPEED-TO-RATE-DVD:CAPS">BRASERO_SPEED_TO_RATE_DVD</link> (speed)
29
#define <link linkend="BRASERO-SPEED-TO-RATE-BD:CAPS">BRASERO_SPEED_TO_RATE_BD</link> (speed)
30
#define <link linkend="BRASERO-RATE-TO-SPEED-CD:CAPS">BRASERO_RATE_TO_SPEED_CD</link> (rate)
31
#define <link linkend="BRASERO-RATE-TO-SPEED-DVD:CAPS">BRASERO_RATE_TO_SPEED_DVD</link> (rate)
32
#define <link linkend="BRASERO-RATE-TO-SPEED-BD:CAPS">BRASERO_RATE_TO_SPEED_BD</link> (rate)
33
#define <link linkend="BRASERO-DURATION-TO-BYTES:CAPS">BRASERO_DURATION_TO_BYTES</link> (duration)
34
#define <link linkend="BRASERO-DURATION-TO-SECTORS:CAPS">BRASERO_DURATION_TO_SECTORS</link> (duration)
35
#define <link linkend="BRASERO-BYTES-TO-SECTORS:CAPS">BRASERO_BYTES_TO_SECTORS</link> (size, secsize)
36
#define <link linkend="BRASERO-BYTES-TO-DURATION:CAPS">BRASERO_BYTES_TO_DURATION</link> (bytes)
37
<link linkend="gchar">gchar</link>* <link linkend="brasero-units-get-time-string">brasero_units_get_time_string</link> (<link linkend="guint64">guint64</link> time,
38
<link linkend="gboolean">gboolean</link> with_unit,
39
<link linkend="gboolean">gboolean</link> round);
40
<link linkend="gchar">gchar</link>* <link linkend="brasero-units-get-time-string-from-size">brasero_units_get_time_string_from_size</link>
41
(<link linkend="gint64">gint64</link> size,
42
<link linkend="gboolean">gboolean</link> with_unit,
43
<link linkend="gboolean">gboolean</link> round);
55
<refsect1 id="brasero-brasero-units.description" role="desc">
56
<title role="desc.title">Description</title>
62
<refsect1 id="brasero-brasero-units.details" role="details">
63
<title role="details.title">Details</title>
64
<refsect2 id="CD-RATE:CAPS" role="macro">
65
<title>CD_RATE</title>
66
<indexterm zone="CD-RATE:CAPS"><primary>CD_RATE</primary></indexterm><programlisting>#define CD_RATE 176400 /* bytes by second */
71
<refsect2 id="DVD-RATE:CAPS" role="macro">
72
<title>DVD_RATE</title>
73
<indexterm zone="DVD-RATE:CAPS"><primary>DVD_RATE</primary></indexterm><programlisting>#define DVD_RATE 1387500 /* bytes by second */
78
<refsect2 id="BD-RATE:CAPS" role="macro">
79
<title>BD_RATE</title>
80
<indexterm zone="BD-RATE:CAPS"><primary>BD_RATE</primary></indexterm><programlisting>#define BD_RATE 4500000 /* bytes by second */
85
<refsect2 id="BRASERO-SPEED-TO-RATE-CD:CAPS" role="macro">
86
<title>BRASERO_SPEED_TO_RATE_CD()</title>
87
<indexterm zone="BRASERO-SPEED-TO-RATE-CD:CAPS"><primary>BRASERO_SPEED_TO_RATE_CD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_CD(speed)</programlisting>
90
</para><variablelist role="params">
91
<varlistentry><term><parameter>speed</parameter> :</term>
95
</simpara></listitem></varlistentry>
96
</variablelist></refsect2>
97
<refsect2 id="BRASERO-SPEED-TO-RATE-DVD:CAPS" role="macro">
98
<title>BRASERO_SPEED_TO_RATE_DVD()</title>
99
<indexterm zone="BRASERO-SPEED-TO-RATE-DVD:CAPS"><primary>BRASERO_SPEED_TO_RATE_DVD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_DVD(speed)</programlisting>
102
</para><variablelist role="params">
103
<varlistentry><term><parameter>speed</parameter> :</term>
107
</simpara></listitem></varlistentry>
108
</variablelist></refsect2>
109
<refsect2 id="BRASERO-SPEED-TO-RATE-BD:CAPS" role="macro">
110
<title>BRASERO_SPEED_TO_RATE_BD()</title>
111
<indexterm zone="BRASERO-SPEED-TO-RATE-BD:CAPS"><primary>BRASERO_SPEED_TO_RATE_BD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_BD(speed)</programlisting>
114
</para><variablelist role="params">
115
<varlistentry><term><parameter>speed</parameter> :</term>
119
</simpara></listitem></varlistentry>
120
</variablelist></refsect2>
121
<refsect2 id="BRASERO-RATE-TO-SPEED-CD:CAPS" role="macro">
122
<title>BRASERO_RATE_TO_SPEED_CD()</title>
123
<indexterm zone="BRASERO-RATE-TO-SPEED-CD:CAPS"><primary>BRASERO_RATE_TO_SPEED_CD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_CD(rate)</programlisting>
126
</para><variablelist role="params">
127
<varlistentry><term><parameter>rate</parameter> :</term>
131
</simpara></listitem></varlistentry>
132
</variablelist></refsect2>
133
<refsect2 id="BRASERO-RATE-TO-SPEED-DVD:CAPS" role="macro">
134
<title>BRASERO_RATE_TO_SPEED_DVD()</title>
135
<indexterm zone="BRASERO-RATE-TO-SPEED-DVD:CAPS"><primary>BRASERO_RATE_TO_SPEED_DVD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_DVD(rate)</programlisting>
138
</para><variablelist role="params">
139
<varlistentry><term><parameter>rate</parameter> :</term>
143
</simpara></listitem></varlistentry>
144
</variablelist></refsect2>
145
<refsect2 id="BRASERO-RATE-TO-SPEED-BD:CAPS" role="macro">
146
<title>BRASERO_RATE_TO_SPEED_BD()</title>
147
<indexterm zone="BRASERO-RATE-TO-SPEED-BD:CAPS"><primary>BRASERO_RATE_TO_SPEED_BD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_BD(rate)</programlisting>
150
</para><variablelist role="params">
151
<varlistentry><term><parameter>rate</parameter> :</term>
155
</simpara></listitem></varlistentry>
156
</variablelist></refsect2>
157
<refsect2 id="BRASERO-DURATION-TO-BYTES:CAPS" role="macro">
158
<title>BRASERO_DURATION_TO_BYTES()</title>
159
<indexterm zone="BRASERO-DURATION-TO-BYTES:CAPS"><primary>BRASERO_DURATION_TO_BYTES</primary></indexterm><programlisting>#define BRASERO_DURATION_TO_BYTES(duration)</programlisting>
162
</para><variablelist role="params">
163
<varlistentry><term><parameter>duration</parameter> :</term>
167
</simpara></listitem></varlistentry>
168
</variablelist></refsect2>
169
<refsect2 id="BRASERO-DURATION-TO-SECTORS:CAPS" role="macro">
170
<title>BRASERO_DURATION_TO_SECTORS()</title>
171
<indexterm zone="BRASERO-DURATION-TO-SECTORS:CAPS"><primary>BRASERO_DURATION_TO_SECTORS</primary></indexterm><programlisting>#define BRASERO_DURATION_TO_SECTORS(duration)</programlisting>
174
</para><variablelist role="params">
175
<varlistentry><term><parameter>duration</parameter> :</term>
179
</simpara></listitem></varlistentry>
180
</variablelist></refsect2>
181
<refsect2 id="BRASERO-BYTES-TO-SECTORS:CAPS" role="macro">
182
<title>BRASERO_BYTES_TO_SECTORS()</title>
183
<indexterm zone="BRASERO-BYTES-TO-SECTORS:CAPS"><primary>BRASERO_BYTES_TO_SECTORS</primary></indexterm><programlisting>#define BRASERO_BYTES_TO_SECTORS(size, secsize)</programlisting>
186
</para><variablelist role="params">
187
<varlistentry><term><parameter>size</parameter> :</term>
189
</simpara></listitem></varlistentry>
190
<varlistentry><term><parameter>secsize</parameter> :</term>
194
</simpara></listitem></varlistentry>
195
</variablelist></refsect2>
196
<refsect2 id="BRASERO-BYTES-TO-DURATION:CAPS" role="macro">
197
<title>BRASERO_BYTES_TO_DURATION()</title>
198
<indexterm zone="BRASERO-BYTES-TO-DURATION:CAPS"><primary>BRASERO_BYTES_TO_DURATION</primary></indexterm><programlisting>#define BRASERO_BYTES_TO_DURATION(bytes)</programlisting>
201
</para><variablelist role="params">
202
<varlistentry><term><parameter>bytes</parameter> :</term>
206
</simpara></listitem></varlistentry>
207
</variablelist></refsect2>
208
<refsect2 id="brasero-units-get-time-string" role="function">
209
<title>brasero_units_get_time_string ()</title>
210
<indexterm zone="brasero-units-get-time-string"><primary>brasero_units_get_time_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* brasero_units_get_time_string (<link linkend="guint64">guint64</link> time,
211
<link linkend="gboolean">gboolean</link> with_unit,
212
<link linkend="gboolean">gboolean</link> round);</programlisting>
215
</para><variablelist role="params">
216
<varlistentry><term><parameter>time</parameter> :</term>
218
</simpara></listitem></varlistentry>
219
<varlistentry><term><parameter>with_unit</parameter> :</term>
221
</simpara></listitem></varlistentry>
222
<varlistentry><term><parameter>round</parameter> :</term>
224
</simpara></listitem></varlistentry>
225
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
228
</simpara></listitem></varlistentry>
229
</variablelist></refsect2>
230
<refsect2 id="brasero-units-get-time-string-from-size" role="function">
231
<title>brasero_units_get_time_string_from_size ()</title>
232
<indexterm zone="brasero-units-get-time-string-from-size"><primary>brasero_units_get_time_string_from_size</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* brasero_units_get_time_string_from_size
233
(<link linkend="gint64">gint64</link> size,
234
<link linkend="gboolean">gboolean</link> with_unit,
235
<link linkend="gboolean">gboolean</link> round);</programlisting>
238
</para><variablelist role="params">
239
<varlistentry><term><parameter>size</parameter> :</term>
241
</simpara></listitem></varlistentry>
242
<varlistentry><term><parameter>with_unit</parameter> :</term>
244
</simpara></listitem></varlistentry>
245
<varlistentry><term><parameter>round</parameter> :</term>
247
</simpara></listitem></varlistentry>
248
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
251
</simpara></listitem></varlistentry>
252
</variablelist></refsect2>