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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBPlayerGstFilter">
<refmeta>
<refentrytitle role="top_of_page" id="RBPlayerGstFilter.top_of_page">RBPlayerGstFilter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBPlayerGstFilter</refname>
<refpurpose>player interface for inserting filter elements</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBPlayerGstFilter.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <rb-player-gst-filter.h>
<link linkend="RBPlayerGstFilter-struct">RBPlayerGstFilter</link>;
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-gst-filter-add-filter">rb_player_gst_filter_add_filter</link> (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GstElement">GstElement</link> *element);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-gst-filter-remove-filter">rb_player_gst_filter_remove_filter</link> (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GstElement">GstElement</link> *element);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBPlayerGstFilter.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----RBPlayerGstFilter
</synopsis>
</refsect1>
<refsect1 id="RBPlayerGstFilter.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBPlayerGstFilter-filter-inserted">filter-inserted</link>" : Run Last / No Recursion
"<link linkend="RBPlayerGstFilter-filter-pre-remove">filter-pre-remove</link>" : Run Last / No Recursion
</synopsis>
</refsect1>
<refsect1 id="RBPlayerGstFilter.description" role="desc">
<title role="desc.title">Description</title>
<para>
This interface allows a caller to add filter elements to the GStreamer playback
pipeline.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBPlayerGstFilter.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBPlayerGstFilter-struct" role="struct">
<title>RBPlayerGstFilter</title>
<indexterm zone="RBPlayerGstFilter-struct"><primary>RBPlayerGstFilter</primary></indexterm><programlisting>typedef struct _RBPlayerGstFilter RBPlayerGstFilter;</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-player-gst-filter-add-filter" role="function">
<title>rb_player_gst_filter_add_filter ()</title>
<indexterm zone="rb-player-gst-filter-add-filter"><primary>rb_player_gst_filter_add_filter</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_gst_filter_add_filter (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GstElement">GstElement</link> *element);</programlisting>
<para>
Adds a new filter to the playback pipeline. The filter may not be
inserted immediately. The 'filter-inserted' signal will be emitted
when this actually happens.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> <link linkend="RBPlayerGstFilter"><type>RBPlayerGstFilter</type></link> implementation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element</parameter> :</term>
<listitem><simpara> new filter element (or bin) to add
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the filter will be added
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-gst-filter-remove-filter" role="function">
<title>rb_player_gst_filter_remove_filter ()</title>
<indexterm zone="rb-player-gst-filter-remove-filter"><primary>rb_player_gst_filter_remove_filter</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_gst_filter_remove_filter (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GstElement">GstElement</link> *element);</programlisting>
<para>
Removes a filter from the playback pipeline. The filter may not be
removed immediately. The 'filter-pre-remove' signal will be emitted
immediately before this actually happens.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> <link linkend="RBPlayerGstFilter"><type>RBPlayerGstFilter</type></link> implementation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element</parameter> :</term>
<listitem><simpara> the filter element (or bin) to remove
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the filter was found and will be removed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBPlayerGstFilter.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBPlayerGstFilter-filter-inserted"><title>The <literal>"filter-inserted"</literal> signal</title>
<indexterm zone="RBPlayerGstFilter-filter-inserted"><primary>RBPlayerGstFilter::filter-inserted</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GObject">GObject</link> *filter,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
<para>
The 'filter-inserted' signal is emitted when the tee element has been
inserted into the pipeline and fully linked</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayerGstFilter"><type>RBPlayerGstFilter</type></link> implementation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> the element which has been inserted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayerGstFilter-filter-pre-remove"><title>The <literal>"filter-pre-remove"</literal> signal</title>
<indexterm zone="RBPlayerGstFilter-filter-pre-remove"><primary>RBPlayerGstFilter::filter-pre-remove</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayerGstFilter">RBPlayerGstFilter</link> *player,
<link linkend="GObject">GObject</link> *filter,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
<para>
The 'filter-pre-remove' signal is emitted immediately before the element
is unlinked and removed from the pipeline</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayerGstFilter"><type>RBPlayerGstFilter</type></link> implementation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> the element which is about to be removed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
