/usr/share/gtk-doc/html/rhythmbox/RBPlayerGstTee.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBPlayerGstTee</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="RBPlayerGstFilter.html" title="RBPlayerGstFilter">
<link rel="next" href="RBEncoder.html" title="RBEncoder">
<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="RBPlayerGstFilter.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="RBEncoder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#RBPlayerGstTee.synopsis" class="shortcut">Top</a>
|
<a href="#RBPlayerGstTee.description" class="shortcut">Description</a>
|
<a href="#RBPlayerGstTee.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#RBPlayerGstTee.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="RBPlayerGstTee"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBPlayerGstTee.top_of_page"></a>RBPlayerGstTee</span></h2>
<p>RBPlayerGstTee — player interface for inserting additional sinks</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="RBPlayerGstTee.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <rb-player-gst-tee.h>
<a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-struct" title="RBPlayerGstTee">RBPlayerGstTee</a>;
struct <a class="link" href="RBPlayerGstTee.html#RBPlayerGstTeeIface" title="struct RBPlayerGstTeeIface">RBPlayerGstTeeIface</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="RBPlayerGstTee.html#rb-player-gst-tee-add-tee" title="rb_player_gst_tee_add_tee ()">rb_player_gst_tee_add_tee</a> (<em class="parameter"><code><a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a> *element</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="RBPlayerGstTee.html#rb-player-gst-tee-remove-tee" title="rb_player_gst_tee_remove_tee ()">rb_player_gst_tee_remove_tee</a> (<em class="parameter"><code><a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="RBPlayerGstTee.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----RBPlayerGstTee
</pre>
</div>
<div class="refsect1">
<a name="RBPlayerGstTee.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-tee-inserted" title='The "tee-inserted" signal'>tee-inserted</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a>
"<a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-tee-pre-remove" title='The "tee-pre-remove" signal'>tee-pre-remove</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a>
</pre>
</div>
<div class="refsect1">
<a name="RBPlayerGstTee.description"></a><h2>Description</h2>
<p>
This interface allows a caller to add a new sink to the GStreamer playback
pipeline.
</p>
</div>
<div class="refsect1">
<a name="RBPlayerGstTee.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="RBPlayerGstTee-struct"></a><h3>RBPlayerGstTee</h3>
<pre class="programlisting">typedef struct _RBPlayerGstTee RBPlayerGstTee;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayerGstTeeIface"></a><h3>struct RBPlayerGstTeeIface</h3>
<pre class="programlisting">struct RBPlayerGstTeeIface {
GTypeInterface g_iface;
/* virtual functions */
gboolean (*add_tee) (RBPlayerGstTee *player, GstElement *element);
gboolean (*remove_tee) (RBPlayerGstTee *player, GstElement *element);
/* signals */
void (*tee_inserted) (RBPlayerGstTee *player, GstElement *tee);
void (*tee_pre_remove) (RBPlayerGstTee *player, GstElement *tee);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-gst-tee-add-tee"></a><h3>rb_player_gst_tee_add_tee ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_player_gst_tee_add_tee (<em class="parameter"><code><a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);</pre>
<p>
Adds a new sink to the playback pipeline. The sink may not be
inserted immediately. The 'tee-inserted' signal will be emitted
when this actually happens.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>
<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
<td>new sink element (or bin) to add</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the sink will be added</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-gst-tee-remove-tee"></a><h3>rb_player_gst_tee_remove_tee ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_player_gst_tee_remove_tee (<em class="parameter"><code><a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);</pre>
<p>
Removes a sink from the playback pipeline. The sink may not be
removed immediately. The 'tee-pre-remove' signal will be emitted
immediately before this actually happens.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>
<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
<td>the sink element (or bin) to remove</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the sink was found and will be removed</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="RBPlayerGstTee.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBPlayerGstTee-tee-inserted"></a><h3>The <code class="literal">"tee-inserted"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player,
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *tee,
<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-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a></pre>
<p>
The 'tee-inserted' signal is emitted when the tee element has been
inserted into the pipeline and fully linked
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>the <a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tee</code></em> :</span></p></td>
<td>the element which has been inserted</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="RBPlayerGstTee-tee-pre-remove"></a><h3>The <code class="literal">"tee-pre-remove"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> *player,
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *tee,
<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-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a></pre>
<p>
The 'tee-pre-remove' signal is emitted immediately before the element
is unlinked and removed from the pipeline
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>the <a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tee</code></em> :</span></p></td>
<td>the element which is about to be removed</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>
|