/usr/share/gtk-doc/html/rhythmbox/RBEncoder.html is in rhythmbox-doc 2.96-0ubuntu4.1.
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 | <!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.76.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.18 (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="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">
<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>
</td></tr>
</table>
<div class="refentry">
<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>;
struct <a class="link" href="RBEncoder.html#RBEncoderIface" title="struct RBEncoderIface">RBEncoderIface</a>;
<a class="link" href="RBEncoder.html" title="RBEncoder"><span class="returnvalue">RBEncoder</span></a> * <a class="link" href="RBEncoder.html#rb-encoder-new" title="rb_encoder_new ()">rb_encoder_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBEncoder.html#rb-encoder-encode" title="rb_encoder_encode ()">rb_encoder_encode</a> (<em class="parameter"><code><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *dest</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> overwrite</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><span class="type">GstEncodingProfile</span></a> *profile</code></em>);
<span class="returnvalue">void</span> <a class="link" href="RBEncoder.html#rb-encoder-cancel" title="rb_encoder_cancel ()">rb_encoder_cancel</a> (<em class="parameter"><code><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBEncoder.html#rb-encoder-get-missing-plugins" title="rb_encoder_get_missing_plugins ()">rb_encoder_get_missing_plugins</a> (<em class="parameter"><code><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><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>
</div>
<div class="refsect1">
<a name="RBEncoder.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----RBEncoder
</pre>
</div>
<div class="refsect1">
<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>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="RBEncoder.html#RBEncoder-progress" title='The "progress" signal'>progress</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="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="RBEncoder.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBEncoder-struct"></a><h3>RBEncoder</h3>
<pre class="programlisting">typedef struct _RBEncoder RBEncoder;</pre>
<p>
</p>
</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>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-encoder-new"></a><h3>rb_encoder_new ()</h3>
<pre class="programlisting"><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="returnvalue">RBEncoder</span></a> * rb_encoder_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> instance.
</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>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr></tbody>
</table></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><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *dest</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> overwrite</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><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="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"><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>overwrite</code></em> :</span></p></td>
<td>if <a href="/usr/share/gtk-doc/html/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</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>profile</code></em> :</span></p></td>
<td>encoding profile to use, or NULL to just copy</td>
</tr>
</tbody>
</table></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><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *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="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">
<a name="rb-encoder-get-missing-plugins"></a><h3>rb_encoder_get_missing_plugins ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_encoder_get_missing_plugins (<em class="parameter"><code><a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-0.10/gst-plugins-base-libs-encoding-profile.html#GstEncodingProfile"><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="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>profile</code></em> :</span></p></td>
<td>an encoding profile</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>returns plugin installer detail strings. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a> callee-allocates]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>descriptions</code></em> :</span></p></td>
<td>returns plugin descriptions. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a> callee-allocates]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if some detail strings are returned, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBEncoder.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBEncoder-completed"></a><h3>The <code class="literal">"completed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder,
<span class="type">guint64</span> dest_size,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mediatype,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the encoding process is complete, or when a fatal error
has occurred. The destination file, if one exists, will be closed
and flushed to disk before this signal is emitted.
</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>dest_size</code></em> :</span></p></td>
<td>size of the output file</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mediatype</code></em> :</span></p></td>
<td>output media type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>encoding error, or NULL if successful</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">
<a name="RBEncoder-progress"></a><h3>The <code class="literal">"progress"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBEncoder.html" title="RBEncoder"><span class="type">RBEncoder</span></a> *encoder,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted regularly during the encoding process to provide progress updates.
</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.18</div>
</body>
</html>
|