2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
5
<!ENTITY version SYSTEM "version.xml">
6
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
9
<refentry id="brasero-brasero-units">
11
<refentrytitle role="top_of_page" id="brasero-brasero-units.top_of_page">brasero-units</refentrytitle>
12
<manvolnum>3</manvolnum>
13
<refmiscinfo>BRASERO Library</refmiscinfo>
17
<refname>brasero-units</refname>
18
<refpurpose></refpurpose>
21
<refsynopsisdiv id="brasero-brasero-units.synopsis" role="synopsis">
22
<title role="synopsis.title">Synopsis</title>
25
#define <link linkend="CD-RATE--CAPS">CD_RATE</link>
26
#define <link linkend="DVD-RATE--CAPS">DVD_RATE</link>
27
#define <link linkend="BD-RATE--CAPS">BD_RATE</link>
28
#define <link linkend="BRASERO-SPEED-TO-RATE-CD--CAPS">BRASERO_SPEED_TO_RATE_CD</link> (speed)
29
#define <link linkend="BRASERO-SPEED-TO-RATE-DVD--CAPS">BRASERO_SPEED_TO_RATE_DVD</link> (speed)
30
#define <link linkend="BRASERO-SPEED-TO-RATE-BD--CAPS">BRASERO_SPEED_TO_RATE_BD</link> (speed)
31
#define <link linkend="BRASERO-RATE-TO-SPEED-CD--CAPS">BRASERO_RATE_TO_SPEED_CD</link> (rate)
32
#define <link linkend="BRASERO-RATE-TO-SPEED-DVD--CAPS">BRASERO_RATE_TO_SPEED_DVD</link> (rate)
33
#define <link linkend="BRASERO-RATE-TO-SPEED-BD--CAPS">BRASERO_RATE_TO_SPEED_BD</link> (rate)
34
#define <link linkend="BRASERO-DURATION-TO-BYTES--CAPS">BRASERO_DURATION_TO_BYTES</link> (duration)
35
#define <link linkend="BRASERO-DURATION-TO-SECTORS--CAPS">BRASERO_DURATION_TO_SECTORS</link> (duration)
36
#define <link linkend="BRASERO-BYTES-TO-SECTORS--CAPS">BRASERO_BYTES_TO_SECTORS</link> (size, secsize)
37
#define <link linkend="BRASERO-BYTES-TO-DURATION--CAPS">BRASERO_BYTES_TO_DURATION</link> (bytes)
38
<link linkend="gchar">gchar</link> * <link linkend="brasero-units-get-time-string">brasero_units_get_time_string</link> (<link linkend="guint64">guint64</link> time,
39
<link linkend="gboolean">gboolean</link> with_unit,
40
<link linkend="gboolean">gboolean</link> round);
41
<link linkend="gchar">gchar</link> * <link linkend="brasero-units-get-time-string-from-size">brasero_units_get_time_string_from_size</link>
42
(<link linkend="gint64">gint64</link> size,
43
<link linkend="gboolean">gboolean</link> with_unit,
44
<link linkend="gboolean">gboolean</link> round);
56
<refsect1 id="brasero-brasero-units.description" role="desc">
57
<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 sortas="CD_RATE">CD_RATE</primary></indexterm><programlisting>#define CD_RATE 176400 /* bytes by second */
70
<refsect2 id="DVD-RATE--CAPS" role="macro">
71
<title>DVD_RATE</title>
72
<indexterm zone="DVD-RATE--CAPS"><primary sortas="DVD_RATE">DVD_RATE</primary></indexterm><programlisting>#define DVD_RATE 1387500 /* bytes by second */
76
<refsect2 id="BD-RATE--CAPS" role="macro">
77
<title>BD_RATE</title>
78
<indexterm zone="BD-RATE--CAPS"><primary sortas="BD_RATE">BD_RATE</primary></indexterm><programlisting>#define BD_RATE 4500000 /* bytes by second */
82
<refsect2 id="BRASERO-SPEED-TO-RATE-CD--CAPS" role="macro">
83
<title>BRASERO_SPEED_TO_RATE_CD()</title>
84
<indexterm zone="BRASERO-SPEED-TO-RATE-CD--CAPS"><primary sortas="BRASERO_SPEED_TO_RATE_CD">BRASERO_SPEED_TO_RATE_CD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_CD(speed)</programlisting>
86
</para><variablelist role="params">
87
<varlistentry><term><parameter>speed</parameter> :</term>
89
</simpara></listitem></varlistentry>
90
</variablelist></refsect2>
91
<refsect2 id="BRASERO-SPEED-TO-RATE-DVD--CAPS" role="macro">
92
<title>BRASERO_SPEED_TO_RATE_DVD()</title>
93
<indexterm zone="BRASERO-SPEED-TO-RATE-DVD--CAPS"><primary sortas="BRASERO_SPEED_TO_RATE_DVD">BRASERO_SPEED_TO_RATE_DVD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_DVD(speed)</programlisting>
95
</para><variablelist role="params">
96
<varlistentry><term><parameter>speed</parameter> :</term>
98
</simpara></listitem></varlistentry>
99
</variablelist></refsect2>
100
<refsect2 id="BRASERO-SPEED-TO-RATE-BD--CAPS" role="macro">
101
<title>BRASERO_SPEED_TO_RATE_BD()</title>
102
<indexterm zone="BRASERO-SPEED-TO-RATE-BD--CAPS"><primary sortas="BRASERO_SPEED_TO_RATE_BD">BRASERO_SPEED_TO_RATE_BD</primary></indexterm><programlisting>#define BRASERO_SPEED_TO_RATE_BD(speed)</programlisting>
104
</para><variablelist role="params">
105
<varlistentry><term><parameter>speed</parameter> :</term>
107
</simpara></listitem></varlistentry>
108
</variablelist></refsect2>
109
<refsect2 id="BRASERO-RATE-TO-SPEED-CD--CAPS" role="macro">
110
<title>BRASERO_RATE_TO_SPEED_CD()</title>
111
<indexterm zone="BRASERO-RATE-TO-SPEED-CD--CAPS"><primary sortas="BRASERO_RATE_TO_SPEED_CD">BRASERO_RATE_TO_SPEED_CD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_CD(rate)</programlisting>
113
</para><variablelist role="params">
114
<varlistentry><term><parameter>rate</parameter> :</term>
116
</simpara></listitem></varlistentry>
117
</variablelist></refsect2>
118
<refsect2 id="BRASERO-RATE-TO-SPEED-DVD--CAPS" role="macro">
119
<title>BRASERO_RATE_TO_SPEED_DVD()</title>
120
<indexterm zone="BRASERO-RATE-TO-SPEED-DVD--CAPS"><primary sortas="BRASERO_RATE_TO_SPEED_DVD">BRASERO_RATE_TO_SPEED_DVD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_DVD(rate)</programlisting>
122
</para><variablelist role="params">
123
<varlistentry><term><parameter>rate</parameter> :</term>
125
</simpara></listitem></varlistentry>
126
</variablelist></refsect2>
127
<refsect2 id="BRASERO-RATE-TO-SPEED-BD--CAPS" role="macro">
128
<title>BRASERO_RATE_TO_SPEED_BD()</title>
129
<indexterm zone="BRASERO-RATE-TO-SPEED-BD--CAPS"><primary sortas="BRASERO_RATE_TO_SPEED_BD">BRASERO_RATE_TO_SPEED_BD</primary></indexterm><programlisting>#define BRASERO_RATE_TO_SPEED_BD(rate)</programlisting>
131
</para><variablelist role="params">
132
<varlistentry><term><parameter>rate</parameter> :</term>
134
</simpara></listitem></varlistentry>
135
</variablelist></refsect2>
136
<refsect2 id="BRASERO-DURATION-TO-BYTES--CAPS" role="macro">
137
<title>BRASERO_DURATION_TO_BYTES()</title>
138
<indexterm zone="BRASERO-DURATION-TO-BYTES--CAPS"><primary sortas="BRASERO_DURATION_TO_BYTES">BRASERO_DURATION_TO_BYTES</primary></indexterm><programlisting>#define BRASERO_DURATION_TO_BYTES(duration)</programlisting>
140
</para><variablelist role="params">
141
<varlistentry><term><parameter>duration</parameter> :</term>
143
</simpara></listitem></varlistentry>
144
</variablelist></refsect2>
145
<refsect2 id="BRASERO-DURATION-TO-SECTORS--CAPS" role="macro">
146
<title>BRASERO_DURATION_TO_SECTORS()</title>
147
<indexterm zone="BRASERO-DURATION-TO-SECTORS--CAPS"><primary sortas="BRASERO_DURATION_TO_SECTORS">BRASERO_DURATION_TO_SECTORS</primary></indexterm><programlisting>#define BRASERO_DURATION_TO_SECTORS(duration)</programlisting>
149
</para><variablelist role="params">
150
<varlistentry><term><parameter>duration</parameter> :</term>
152
</simpara></listitem></varlistentry>
153
</variablelist></refsect2>
154
<refsect2 id="BRASERO-BYTES-TO-SECTORS--CAPS" role="macro">
155
<title>BRASERO_BYTES_TO_SECTORS()</title>
156
<indexterm zone="BRASERO-BYTES-TO-SECTORS--CAPS"><primary sortas="BRASERO_BYTES_TO_SECTORS">BRASERO_BYTES_TO_SECTORS</primary></indexterm><programlisting>#define BRASERO_BYTES_TO_SECTORS(size, secsize)</programlisting>
158
</para><variablelist role="params">
159
<varlistentry><term><parameter>size</parameter> :</term>
161
</simpara></listitem></varlistentry>
162
<varlistentry><term><parameter>secsize</parameter> :</term>
164
</simpara></listitem></varlistentry>
165
</variablelist></refsect2>
166
<refsect2 id="BRASERO-BYTES-TO-DURATION--CAPS" role="macro">
167
<title>BRASERO_BYTES_TO_DURATION()</title>
168
<indexterm zone="BRASERO-BYTES-TO-DURATION--CAPS"><primary sortas="BRASERO_BYTES_TO_DURATION">BRASERO_BYTES_TO_DURATION</primary></indexterm><programlisting>#define BRASERO_BYTES_TO_DURATION(bytes)</programlisting>
170
</para><variablelist role="params">
171
<varlistentry><term><parameter>bytes</parameter> :</term>
173
</simpara></listitem></varlistentry>
174
</variablelist></refsect2>
175
<refsect2 id="brasero-units-get-time-string" role="function">
176
<title>brasero_units_get_time_string ()</title>
177
<indexterm zone="brasero-units-get-time-string"><primary sortas="brasero_units_get_time_string">brasero_units_get_time_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * brasero_units_get_time_string (<link linkend="guint64">guint64</link> time,
178
<link linkend="gboolean">gboolean</link> with_unit,
179
<link linkend="gboolean">gboolean</link> round);</programlisting>
181
</para><variablelist role="params">
182
<varlistentry><term><parameter>time</parameter> :</term>
184
</simpara></listitem></varlistentry>
185
<varlistentry><term><parameter>with_unit</parameter> :</term>
187
</simpara></listitem></varlistentry>
188
<varlistentry><term><parameter>round</parameter> :</term>
190
</simpara></listitem></varlistentry>
191
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
192
</simpara></listitem></varlistentry>
193
</variablelist></refsect2>
194
<refsect2 id="brasero-units-get-time-string-from-size" role="function">
195
<title>brasero_units_get_time_string_from_size ()</title>
196
<indexterm zone="brasero-units-get-time-string-from-size"><primary sortas="brasero_units_get_time_string_from_size">brasero_units_get_time_string_from_size</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * brasero_units_get_time_string_from_size
197
(<link linkend="gint64">gint64</link> size,
198
<link linkend="gboolean">gboolean</link> with_unit,
199
<link linkend="gboolean">gboolean</link> round);</programlisting>
201
</para><variablelist role="params">
202
<varlistentry><term><parameter>size</parameter> :</term>
204
</simpara></listitem></varlistentry>
205
<varlistentry><term><parameter>with_unit</parameter> :</term>
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><parameter>round</parameter> :</term>
210
</simpara></listitem></varlistentry>
211
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
212
</simpara></listitem></varlistentry>
213
</variablelist></refsect2>