← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/html/RBPlayerGstDataTee.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/RBPlayerGstDataTee.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>RBPlayerGstDataTee</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="RBPlayer.html" title="RBPlayer">
 
10
<link rel="next" href="RBPlayerGstFilter.html" title="RBPlayerGstFilter">
 
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="RBPlayer.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="RBPlayerGstFilter.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="#RBPlayerGstDataTee.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBPlayerGstDataTee.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBPlayerGstDataTee.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBPlayerGstDataTee.signals" class="shortcut">Signals</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry">
 
34
<a name="RBPlayerGstDataTee"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="RBPlayerGstDataTee.top_of_page"></a>RBPlayerGstDataTee</span></h2>
 
38
<p>RBPlayerGstDataTee — player interface for processing raw data</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="RBPlayerGstDataTee.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">
 
45
#include &lt;rb-player-gst-data-tee.h&gt;
 
46
 
 
47
                    <a class="link" href="RBPlayerGstDataTee.html#RBPlayerGstDataTee-struct" title="RBPlayerGstDataTee">RBPlayerGstDataTee</a>;
 
48
struct              <a class="link" href="RBPlayerGstDataTee.html#RBPlayerGstDataTeeIface" title="struct RBPlayerGstDataTeeIface">RBPlayerGstDataTeeIface</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="RBPlayerGstDataTee.html#rb-player-gst-data-tee-add-data-tee" title="rb_player_gst_data_tee_add_data_tee ()">rb_player_gst_data_tee_add_data_tee</a> (<em class="parameter"><code><a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</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="RBPlayerGstDataTee.html#rb-player-gst-data-tee-remove-data-tee" title="rb_player_gst_data_tee_remove_data_tee ()">rb_player_gst_data_tee_remove_data_tee</a>
 
52
                                                        (<em class="parameter"><code><a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> *player</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);
 
54
</pre>
 
55
</div>
 
56
<div class="refsect1">
 
57
<a name="RBPlayerGstDataTee.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
58
<pre class="synopsis">
 
59
  GInterface
 
60
   +----RBPlayerGstDataTee
 
61
</pre>
 
62
</div>
 
63
<div class="refsect1">
 
64
<a name="RBPlayerGstDataTee.signals"></a><h2>Signals</h2>
 
65
<pre class="synopsis">
 
66
  "<a class="link" href="RBPlayerGstDataTee.html#RBPlayerGstDataTee-data-tee-inserted" title='The "data-tee-inserted" signal'>data-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>
 
67
  "<a class="link" href="RBPlayerGstDataTee.html#RBPlayerGstDataTee-data-tee-pre-remove" title='The "data-tee-pre-remove" signal'>data-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>
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1">
 
71
<a name="RBPlayerGstDataTee.description"></a><h2>Description</h2>
 
72
<p>
 
73
This interface allows a caller to add a branch to the GStreamer playback
 
74
pipeline that receives a copy of the raw data from the playback source
 
75
element.
 
76
</p>
 
77
<p>
 
78
This interface is not currently implemented by either playback backend.
 
79
</p>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="RBPlayerGstDataTee.details"></a><h2>Details</h2>
 
83
<div class="refsect2">
 
84
<a name="RBPlayerGstDataTee-struct"></a><h3>RBPlayerGstDataTee</h3>
 
85
<pre class="programlisting">typedef struct _RBPlayerGstDataTee RBPlayerGstDataTee;</pre>
 
86
<p>
 
87
</p>
 
88
</div>
 
89
<hr>
 
90
<div class="refsect2">
 
91
<a name="RBPlayerGstDataTeeIface"></a><h3>struct RBPlayerGstDataTeeIface</h3>
 
92
<pre class="programlisting">struct RBPlayerGstDataTeeIface {
 
93
        GTypeInterface g_iface;
 
94
 
 
95
        /* virtual functions */
 
96
        gboolean (*add_data_tee)                (RBPlayerGstDataTee *player, GstElement *element);
 
97
        gboolean (*remove_data_tee) (RBPlayerGstDataTee *player, GstElement *element);
 
98
 
 
99
        /* signals */
 
100
        void            (*data_tee_inserted) (RBPlayerGstDataTee *player, GstElement *data_tee);
 
101
        void            (*data_tee_pre_remove) (RBPlayerGstDataTee *player, GstElement *data_tee);
 
102
};
 
103
</pre>
 
104
<p>
 
105
</p>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2">
 
109
<a name="rb-player-gst-data-tee-add-data-tee"></a><h3>rb_player_gst_data_tee_add_data_tee ()</h3>
 
110
<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_data_tee_add_data_tee (<em class="parameter"><code><a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> *player</code></em>,
 
111
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);</pre>
 
112
<p>
 
113
Adds a raw data tee branch to the playback pipeline.
 
114
</p>
 
115
<div class="variablelist"><table border="0">
 
116
<col align="left" valign="top">
 
117
<tbody>
 
118
<tr>
 
119
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
120
<td>a <a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> implementation</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
 
124
<td>data tee branch to add</td>
 
125
</tr>
 
126
<tr>
 
127
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
128
<td>TRUE if the tee branch was added successfully</td>
 
129
</tr>
 
130
</tbody>
 
131
</table></div>
 
132
</div>
 
133
<hr>
 
134
<div class="refsect2">
 
135
<a name="rb-player-gst-data-tee-remove-data-tee"></a><h3>rb_player_gst_data_tee_remove_data_tee ()</h3>
 
136
<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_data_tee_remove_data_tee
 
137
                                                        (<em class="parameter"><code><a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> *player</code></em>,
 
138
                                                         <em class="parameter"><code><span class="type">GstElement</span> *element</code></em>);</pre>
 
139
<p>
 
140
Removes a raw data tee branch.
 
141
</p>
 
142
<div class="variablelist"><table border="0">
 
143
<col align="left" valign="top">
 
144
<tbody>
 
145
<tr>
 
146
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
 
147
<td>a <a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</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>data tee branch to add</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 tee branch was found and removed</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
</div>
 
160
</div>
 
161
<div class="refsect1">
 
162
<a name="RBPlayerGstDataTee.signal-details"></a><h2>Signal Details</h2>
 
163
<div class="refsect2">
 
164
<a name="RBPlayerGstDataTee-data-tee-inserted"></a><h3>The <code class="literal">"data-tee-inserted"</code> signal</h3>
 
165
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</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>            *data_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 'data_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="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> implementation</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><span class="term"><em class="parameter"><code>data_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="RBPlayerGstDataTee-data-tee-pre-remove"></a><h3>The <code class="literal">"data-tee-pre-remove"</code> signal</h3>
 
193
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</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>            *data_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 'data_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="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee"><span class="type">RBPlayerGstDataTee</span></a> implementation</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><span class="term"><em class="parameter"><code>data_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'