rhythmbox-doc 3.4.2-4ubuntu1 / usr / share / gtk-doc / html / rhythmbox / rhythmbox-RBEncoder.html

This file is indexed.

/usr/share/gtk-doc/html/rhythmbox/rhythmbox-RBEncoder.html is in rhythmbox-doc 3.4.2-4ubuntu1.

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
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
<!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: Rhythmbox Development Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" 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.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="#rhythmbox-RBEncoder.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="RBPlayerGstTee.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="rhythmbox-RBEncoder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-RBEncoder.top_of_page"></a>RBEncoder</span></h2>
<p>RBEncoder — audio transcoder interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="rhythmbox-RBEncoder.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 href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBEncoder.html#rb-encoder-error-quark" title="rb_encoder_error_quark ()">rb_encoder_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">RBEncoderFactory</span> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBEncoder.html#rb-encoder-factory-get" title="rb_encoder_factory_get ()">rb_encoder_factory_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">RBEncoder</span> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBEncoder.html#rb-encoder-new" title="rb_encoder_new ()">rb_encoder_new</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="rhythmbox-RBEncoder.html#rb-encoder-encode" title="rb_encoder_encode ()">rb_encoder_encode</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="rhythmbox-RBEncoder.html#rb-encoder-cancel" title="rb_encoder_cancel ()">rb_encoder_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBEncoder.html#rb-encoder-get-missing-plugins" title="rb_encoder_get_missing_plugins ()">rb_encoder_get_missing_plugins</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBEncoder.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">enum</td>
<td class="function_name"><a class="link" href="rhythmbox-RBEncoder.html#RBEncoderError" title="enum RBEncoderError">RBEncoderError</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="rhythmbox-RBEncoder.html#RBEncoderIface" title="struct RBEncoderIface">RBEncoderIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="rhythmbox-RBEncoder.html#RBEncoderFactoryClass" title="struct RBEncoderFactoryClass">RBEncoderFactoryClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBEncoder.description"></a><h2>Description</h2>
<p>The RBEncoder interface provides transcoding between audio formats based on
encoding profiles.  The encoder implementation operates asynchronously and
provides status updates in the form of signals emitted on the main thread.
A new encoder instance should be created for each file that is transcoded
or copied.</p>
</div>
<div class="refsect1">
<a name="rhythmbox-RBEncoder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-encoder-error-quark"></a><h3>rb_encoder_error_quark ()</h3>
<pre class="programlisting"><a href="../glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
rb_encoder_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-factory-get"></a><h3>rb_encoder_factory_get ()</h3>
<pre class="programlisting"><span class="returnvalue">RBEncoderFactory</span> *
rb_encoder_factory_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <span class="type">RBEncoderFactory</span> instance.</p>
<div class="refsect3">
<a name="rb-encoder-factory-get.returns"></a><h4>Returns</h4>
<p>the <span class="type">RBEncoderFactory</span>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-new"></a><h3>rb_encoder_new ()</h3>
<pre class="programlisting"><span class="returnvalue">RBEncoder</span> *
rb_encoder_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <span class="type">RBEncoder</span> instance.</p>
<div class="refsect3">
<a name="rb-encoder-new.returns"></a><h4>Returns</h4>
<p>the new <span class="type">RBEncoder</span>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-encode"></a><h3>rb_encoder_encode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_encoder_encode (<em class="parameter"><code><span class="type">RBEncoder</span> *encoder</code></em>,
                   <em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
                   <em class="parameter"><code>const <span class="type">char</span> *dest</code></em>,
                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> overwrite</code></em>,
                   <em class="parameter"><code><a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingProfile-struct"><span class="type">GstEncodingProfile</span></a> *profile</code></em>);</pre>
<p>Initiates encoding, transcoding to the specified profile if specified.</p>
<p>Encoding and error reporting takes place asynchronously.  The caller should wait
for the 'completed' signal which indicates it has either completed or failed.</p>
<div class="refsect3">
<a name="rb-encoder-encode.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>encoder</p></td>
<td class="parameter_description"><p>the <span class="type">RBEncoder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the <span class="type">RhythmDBEntry</span> to transcode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>destination file URI</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>overwrite</p></td>
<td class="parameter_description"><p>if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, overwrite <em class="parameter"><code>dest</code></em>
if it already exists</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>profile</p></td>
<td class="parameter_description"><p>encoding profile to use, or NULL to just copy</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-cancel"></a><h3>rb_encoder_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_encoder_cancel (<em class="parameter"><code><span class="type">RBEncoder</span> *encoder</code></em>);</pre>
<p>Attempts to cancel any in progress encoding.  The encoder should
delete the destination file, if it created one, and emit the
'completed' signal.</p>
<div class="refsect3">
<a name="rb-encoder-cancel.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>encoder</p></td>
<td class="parameter_description"><p>a <span class="type">RBEncoder</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-get-missing-plugins"></a><h3>rb_encoder_get_missing_plugins ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_encoder_get_missing_plugins (<em class="parameter"><code><span class="type">RBEncoder</span> *encoder</code></em>,
                                <em class="parameter"><code><a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingProfile-struct"><span class="type">GstEncodingProfile</span></a> *profile</code></em>,
                                <em class="parameter"><code><span class="type">char</span> ***details</code></em>,
                                <em class="parameter"><code><span class="type">char</span> ***descriptions</code></em>);</pre>
<p>Retrieves the plugin installer detail strings and descriptions
for any missing plugins required to use the specified encoding profile.</p>
<div class="refsect3">
<a name="rb-encoder-get-missing-plugins.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>encoder</p></td>
<td class="parameter_description"><p>a <span class="type">RBEncoder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>profile</p></td>
<td class="parameter_description"><p>an encoding profile</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>details</p></td>
<td class="parameter_description"><p>returns plugin installer detail strings. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out%20callee-allocates"><span class="acronym">out callee-allocates</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>descriptions</p></td>
<td class="parameter_description"><p>returns plugin descriptions. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out%20callee-allocates"><span class="acronym">out callee-allocates</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-encoder-get-missing-plugins.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if some detail strings are returned, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBEncoder.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBEncoderError"></a><h3>enum RBEncoderError</h3>
<div class="refsect3">
<a name="RBEncoderError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-FORMAT-UNSUPPORTED:CAPS"></a>RB_ENCODER_ERROR_FORMAT_UNSUPPORTED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-INTERNAL:CAPS"></a>RB_ENCODER_ERROR_INTERNAL</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-FILE-ACCESS:CAPS"></a>RB_ENCODER_ERROR_FILE_ACCESS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-OUT-OF-SPACE:CAPS"></a>RB_ENCODER_ERROR_OUT_OF_SPACE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-DEST-READ-ONLY:CAPS"></a>RB_ENCODER_ERROR_DEST_READ_ONLY</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-ENCODER-ERROR-DEST-EXISTS:CAPS"></a>RB_ENCODER_ERROR_DEST_EXISTS</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RBEncoderIface"></a><h3>struct RBEncoderIface</h3>
<pre class="programlisting">struct RBEncoderIface {
	GTypeInterface g_iface;

	/* vtable */
	void		(*encode) (RBEncoder *encoder,
					 RhythmDBEntry *entry,
					 const char *dest,
					 gboolean overwrite,
					 GstEncodingProfile *profile);
	void		(*cancel) (RBEncoder *encoder);
	gboolean (*get_missing_plugins) (RBEncoder *encoder,
					 GstEncodingProfile *profile,
					 char ***details,
					 char ***descriptions);

	/* signals */
	void (*progress) (RBEncoder *encoder,  double fraction);
	void (*completed) (RBEncoder *encoder, guint64 dest_size, const char *mediatype, GError *error);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="RBEncoderFactoryClass"></a><h3>struct RBEncoderFactoryClass</h3>
<pre class="programlisting">struct RBEncoderFactoryClass {
	GObjectClass obj_class;

	/* signals */
	void (*prepare_source) (RBEncoderFactory *factory, const char *uri, GObject *source);
	void (*prepare_sink) (RBEncoderFactory *factory, const char *uri, GObject *sink);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.