← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBPlayerGstTee.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBPlayerGstTee.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>RBPlayerGstTee</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch01.html" title="Backends">
 
9
<link rel="prev" href="RBPlayerGstFilter.html" title="RBPlayerGstFilter">
 
10
<link rel="next" href="RBEncoder.html" title="RBEncoder">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="RBPlayerGstFilter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="RBEncoder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#RBPlayerGstTee.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBPlayerGstTee.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBPlayerGstTee.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBPlayerGstTee.signals" class="shortcut">Signals</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry">
 
34
<a name="RBPlayerGstTee"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="RBPlayerGstTee.top_of_page"></a>RBPlayerGstTee</span></h2>
 
38
<p>RBPlayerGstTee — player interface for inserting additional sinks</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="RBPlayerGstTee.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">
 
45
#include &lt;rb-player-gst-tee.h&gt;
 
46
 
 
47
                    <a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-struct" title="RBPlayerGstTee">RBPlayerGstTee</a>;
 
48
struct              <a class="link" href="RBPlayerGstTee.html#RBPlayerGstTeeIface" title="struct RBPlayerGstTeeIface">RBPlayerGstTeeIface</a>;
 
49
<a href="http://library.gnome.org/devel/glib/unstable/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>,
 
50
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/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>,
 
52
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="RBPlayerGstTee.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  GInterface
 
59
   +----RBPlayerGstTee
 
60
</pre>
 
61
</div>
 
62
<div class="refsect1">
 
63
<a name="RBPlayerGstTee.signals"></a><h2>Signals</h2>
 
64
<pre class="synopsis">
 
65
  "<a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-tee-inserted" title='The "tee-inserted" signal'>tee-inserted</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a>
 
66
  "<a class="link" href="RBPlayerGstTee.html#RBPlayerGstTee-tee-pre-remove" title='The "tee-pre-remove" signal'>tee-pre-remove</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a>
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1">
 
70
<a name="RBPlayerGstTee.description"></a><h2>Description</h2>
 
71
<p>
 
72
This interface allows a caller to add a new sink to the GStreamer playback
 
73
pipeline.
 
74
</p>
 
75
</div>
 
76
<div class="refsect1">
 
77
<a name="RBPlayerGstTee.details"></a><h2>Details</h2>
 
78
<div class="refsect2">
 
79
<a name="RBPlayerGstTee-struct"></a><h3>RBPlayerGstTee</h3>
 
80
<pre class="programlisting">typedef struct _RBPlayerGstTee RBPlayerGstTee;</pre>
 
81
<p>
 
82
</p>
 
83
</div>
 
84
<hr>
 
85
<div class="refsect2">
 
86
<a name="RBPlayerGstTeeIface"></a><h3>struct RBPlayerGstTeeIface</h3>
 
87
<pre class="programlisting">struct RBPlayerGstTeeIface {
 
88
        GTypeInterface g_iface;
 
89
 
 
90
        /* virtual functions */
 
91
        gboolean (*add_tee)             (RBPlayerGstTee *player, GstElement *element);
 
92
        gboolean (*remove_tee)          (RBPlayerGstTee *player, GstElement *element);
 
93
 
 
94
        /* signals */
 
95
        void            (*tee_inserted)         (RBPlayerGstTee *player, GstElement *tee);
 
96
        void            (*tee_pre_remove) (RBPlayerGstTee *player, GstElement *tee);
 
97
};
 
98
</pre>
 
99
<p>
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2">
 
104
<a name="rb-player-gst-tee-add-tee"></a><h3>rb_player_gst_tee_add_tee ()</h3>
 
105
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>,
 
106
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);</pre>
 
107
<p>
 
108
Adds a new sink to the playback pipeline.  The sink may not be
 
109
inserted immediately.  The 'tee-inserted' signal will be emitted
 
110
when this actually happens.
 
111
</p>
 
112
<div class="variablelist"><table border="0">
 
113
<col align="left" valign="top">
 
114
<tbody>
 
115
<tr>
 
116
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
117
<td>
 
118
<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
 
119
</tr>
 
120
<tr>
 
121
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
 
122
<td>new sink element (or bin) to add</td>
 
123
</tr>
 
124
<tr>
 
125
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
126
<td>TRUE if the sink will be added</td>
 
127
</tr>
 
128
</tbody>
 
129
</table></div>
 
130
</div>
 
131
<hr>
 
132
<div class="refsect2">
 
133
<a name="rb-player-gst-tee-remove-tee"></a><h3>rb_player_gst_tee_remove_tee ()</h3>
 
134
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>,
 
135
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);</pre>
 
136
<p>
 
137
Removes a sink from the playback pipeline.  The sink may not be
 
138
removed immediately.  The 'tee-pre-remove' signal will be emitted
 
139
immediately before this actually happens.
 
140
</p>
 
141
<div class="variablelist"><table border="0">
 
142
<col align="left" valign="top">
 
143
<tbody>
 
144
<tr>
 
145
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
146
<td>
 
147
<a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
 
151
<td>the sink element (or bin) to remove</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
155
<td>TRUE if the sink was found and will be removed</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
</div>
 
160
</div>
 
161
<div class="refsect1">
 
162
<a name="RBPlayerGstTee.signal-details"></a><h2>Signal Details</h2>
 
163
<div class="refsect2">
 
164
<a name="RBPlayerGstTee-tee-inserted"></a><h3>The <code class="literal">"tee-inserted"</code> signal</h3>
 
165
<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,
 
166
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>        *tee,
 
167
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a></pre>
 
168
<p>
 
169
The 'tee-inserted' signal is emitted when the tee element has been
 
170
inserted into the pipeline and fully linked
 
171
</p>
 
172
<div class="variablelist"><table border="0">
 
173
<col align="left" valign="top">
 
174
<tbody>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
177
<td>the <a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><span class="term"><em class="parameter"><code>tee</code></em> :</span></p></td>
 
181
<td>the element which has been inserted</td>
 
182
</tr>
 
183
<tr>
 
184
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
185
<td>user data set when the signal handler was connected.</td>
 
186
</tr>
 
187
</tbody>
 
188
</table></div>
 
189
</div>
 
190
<hr>
 
191
<div class="refsect2">
 
192
<a name="RBPlayerGstTee-tee-pre-remove"></a><h3>The <code class="literal">"tee-pre-remove"</code> signal</h3>
 
193
<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,
 
194
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>        *tee,
 
195
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a></pre>
 
196
<p>
 
197
The 'tee-pre-remove' signal is emitted immediately before the element
 
198
is unlinked and removed from the pipeline
 
199
</p>
 
200
<div class="variablelist"><table border="0">
 
201
<col align="left" valign="top">
 
202
<tbody>
 
203
<tr>
 
204
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
205
<td>the <a class="link" href="RBPlayerGstTee.html" title="RBPlayerGstTee"><span class="type">RBPlayerGstTee</span></a> implementation</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><span class="term"><em class="parameter"><code>tee</code></em> :</span></p></td>
 
209
<td>the element which is about to be removed</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
213
<td>user data set when the signal handler was connected.</td>
 
214
</tr>
 
215
</tbody>
 
216
</table></div>
 
217
</div>
 
218
</div>
 
219
</div>
 
220
<div class="footer">
 
221
<hr>
 
222
          Generated by GTK-Doc V1.17</div>
 
223
</body>
 
224
</html>
 
 
b'\\ No newline at end of file'