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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBEncoder</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch01.html" title="Backends">
<link rel="prev" href="RBPlayerGstTee.html" title="RBPlayerGstTee">
<link rel="next" href="ch02.html" title="Lib">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Backends">
<link rel="chapter" href="ch02.html" title="Lib">
<link rel="chapter" href="ch03.html" title="Metadata">
<link rel="chapter" href="ch04.html" title="RhythmDB">
<link rel="chapter" href="ch05.html" title="Shell">
<link rel="chapter" href="ch06.html" title="Sources">
<link rel="chapter" href="ch07.html" title="Widgets">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="RBPlayerGstTee.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#RBEncoder.synopsis" class="shortcut">Top</a>
|
<a href="#RBEncoder.description" class="shortcut">Description</a>
|
<a href="#RBEncoder.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBEncoder.signals" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="RBEncoder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBEncoder.top_of_page"></a>RBEncoder</span></h2>
<p>RBEncoder — audio transcoder interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBEncoder.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="RBEncoder.html#RBEncoder-struct" title="RBEncoder">RBEncoder</a>;
<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a>* <a class="link" href="RBEncoder.html#rb-encoder-new" title="rb_encoder_new ()">rb_encoder_new</a> (void);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="RBEncoder.html#rb-encoder-encode" title="rb_encoder_encode ()">rb_encoder_encode</a> (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry">RhythmDBEntry</a> *entry,
const char *dest,
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *mime_types);
void <a class="link" href="RBEncoder.html#rb-encoder-cancel" title="rb_encoder_cancel ()">rb_encoder_cancel</a> (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="RBEncoder.html#rb-encoder-get-preferred-mimetype" title="rb_encoder_get_preferred_mimetype ()">rb_encoder_get_preferred_mimetype</a> (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *mime_types,
char **mime,
char **extension);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBEncoder.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----RBEncoder
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBEncoder.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="RBEncoder.html#RBEncoder-completed" title='The "completed" signal'>completed</a>" : Run Last
"<a class="link" href="RBEncoder.html#RBEncoder-error" title='The "error" signal'>error</a>" : Run Last
"<a class="link" href="RBEncoder.html#RBEncoder-progress" title='The "progress" signal'>progress</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="RBEncoder.description"></a><h2>Description</h2>
<p>
The RBEncoder interface provides transcoding between audio formats based on
MIME types.
</p>
<p>
The encoder picks the output format from a list provided by the caller,
limited by the available codecs. It operatees asynchronously and provides
status updates in the form of signals.
</p>
<p>
A new encoder instance should be created for each file that is transcoded.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="RBEncoder.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="RBEncoder-struct"></a><h3>RBEncoder</h3>
<pre class="programlisting">typedef struct _RBEncoder RBEncoder;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-encoder-new"></a><h3>rb_encoder_new ()</h3>
<pre class="programlisting"><a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a>* rb_encoder_new (void);</pre>
<p>
Creates a new <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> instance.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-encoder-encode"></a><h3>rb_encoder_encode ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> rb_encoder_encode (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry">RhythmDBEntry</a> *entry,
const char *dest,
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *mime_types);</pre>
<p>
Initiates encoding. A target MIME type will be selected from the list
given. If the source format is in the list, that will be chosen regardless
of order. Otherwise, the first type in the list that the encoder can produce
will be selected.
</p>
<p>
Encoding takes places asynchronously. If the return value is TRUE, the caller
should wait for a 'completed' or 'error' signal to indicate that it has finished.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> the <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td> the <a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> to transcode
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td> destination file URI
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_types</code></em> :</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> of target MIME types in order of preference
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if encoding has started
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-encoder-cancel"></a><h3>rb_encoder_cancel ()</h3>
<pre class="programlisting">void rb_encoder_cancel (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder);</pre>
<p>
Attempts to cancel any in progress encoding. The encoder should
delete the destination file, if it created one.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> a <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rb-encoder-get-preferred-mimetype"></a><h3>rb_encoder_get_preferred_mimetype ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> rb_encoder_get_preferred_mimetype (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a> *mime_types,
char **mime,
char **extension);</pre>
<p>
Identifies the first MIME type in the list that the encoder can actually encode to.
The file extension (eg. '.mp3' for audio/mpeg) associated with the selected type is
also returned.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> a <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_types</code></em> :</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> of MIME type strings in order of preference
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime</code></em> :</span></p></td>
<td> returns the selected MIME type, if any
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>extension</code></em> :</span></p></td>
<td> returns the file extension associated with the selected MIME type, if any
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a format was identified
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="RBEncoder.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="RBEncoder-completed"></a><h3>The <code class="literal">"completed"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
>guint64</a> arg1,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
Emitted when the encoding process is complete. The destination file
will be closed and flushed to disk when this occurs.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> the <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="RBEncoder-error"></a><h3>The <code class="literal">"error"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> error,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
Emitted when an error occurs during encoding.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> the <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> describing the error
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="RBEncoder-progress"></a><h3>The <code class="literal">"progress"</code> signal</h3>
<pre class="programlisting">void user_function (<a class="link" href="RBEncoder.html" title="RBEncoder">RBEncoder</a> *encoder,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</a> fraction,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run Last</pre>
<p>
Emitted regularly during the encoding process to provide progress updates.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>encoder</code></em> :</span></p></td>
<td> the <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> instance
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
<td> progress as a fraction (0..1)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
