Initialize Tizen 2.3
[framework/multimedia/gstreamer0.10.git] / mobile / docs / plugins / html / gstreamer-plugins-capsfilter.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>capsfilter</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Core Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gstreamer Elements">
9 <link rel="prev" href="ch01.html" title="gstreamer Elements">
10 <link rel="next" href="gstreamer-plugins-fakesrc.html" title="fakesrc">
11 <meta name="generator" content="GTK-Doc V1.18 (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="ch01.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">GStreamer Core Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gstreamer-plugins-fakesrc.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="#gstreamer-plugins-capsfilter.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gstreamer-plugins-capsfilter.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gstreamer-plugins-capsfilter.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gstreamer-plugins-capsfilter.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gstreamer-plugins-capsfilter"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gstreamer-plugins-capsfilter.top_of_page"></a>capsfilter</span></h2>
38 <p>capsfilter — Pass data without modification, limiting formats</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gstreamer-plugins-capsfilter.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstCapsFilter"></a><pre class="synopsis">struct              <a class="link" href="gstreamer-plugins-capsfilter.html#GstCapsFilter-struct" title="struct GstCapsFilter">GstCapsFilter</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gstreamer-plugins-capsfilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
49 <pre class="synopsis">
50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
54                      +----GstCapsFilter
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gstreamer-plugins-capsfilter.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gstreamer-plugins-capsfilter.html#GstCapsFilter--caps" title='The "caps" property'>caps</a>"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
61 </pre>
62 </div>
63 <div class="refsect1">
64 <a name="gstreamer-plugins-capsfilter.description"></a><h2>Description</h2>
65 <p>
66 The element does not modify data as such, but can enforce limitations on the
67 data format.
68 </p>
69 <p>
70 </p>
71 <div class="refsect2">
72 <a name="idp6413552"></a><h3>Example launch line</h3>
73 <div class="informalexample">
74   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
75     <tbody>
76       <tr>
77         <td class="listing_lines" align="right"><pre>1</pre></td>
78         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">-</span>gray <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> autovideosink</pre></td>
79       </tr>
80     </tbody>
81   </table>
82 </div>
83  Limits acceptable video from videotestsrc to be grayscale.
84 </div>
85 <p>
86 </p>
87 <div class="refsynopsisdiv">
88 <h2>Synopsis</h2>
89 <div class="refsect2">
90 <a name="idp7767936"></a><h3>Element Information</h3>
91 <div class="variablelist"><table border="0">
92 <col align="left" valign="top">
93 <tbody>
94 <tr>
95 <td><p><span class="term">plugin</span></p></td>
96 <td>
97             <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a>
98           </td>
99 </tr>
100 <tr>
101 <td><p><span class="term">author</span></p></td>
102 <td>David Schleef &lt;ds@schleef.org&gt;</td>
103 </tr>
104 <tr>
105 <td><p><span class="term">class</span></p></td>
106 <td>Generic</td>
107 </tr>
108 </tbody>
109 </table></div>
110 </div>
111 <hr>
112 <div class="refsect2">
113 <a name="idp88496"></a><h3>Element Pads</h3>
114 <div class="variablelist"><table border="0">
115 <col align="left" valign="top">
116 <tbody>
117 <tr>
118 <td><p><span class="term">name</span></p></td>
119 <td>sink</td>
120 </tr>
121 <tr>
122 <td><p><span class="term">direction</span></p></td>
123 <td>sink</td>
124 </tr>
125 <tr>
126 <td><p><span class="term">presence</span></p></td>
127 <td>always</td>
128 </tr>
129 <tr>
130 <td><p><span class="term">details</span></p></td>
131 <td>ANY</td>
132 </tr>
133 </tbody>
134 </table></div>
135 <div class="variablelist"><table border="0">
136 <col align="left" valign="top">
137 <tbody>
138 <tr>
139 <td><p><span class="term">name</span></p></td>
140 <td>src</td>
141 </tr>
142 <tr>
143 <td><p><span class="term">direction</span></p></td>
144 <td>source</td>
145 </tr>
146 <tr>
147 <td><p><span class="term">presence</span></p></td>
148 <td>always</td>
149 </tr>
150 <tr>
151 <td><p><span class="term">details</span></p></td>
152 <td>ANY</td>
153 </tr>
154 </tbody>
155 </table></div>
156 </div>
157 </div>
158 <p>
159 </p>
160 </div>
161 <div class="refsect1">
162 <a name="gstreamer-plugins-capsfilter.details"></a><h2>Details</h2>
163 <div class="refsect2">
164 <a name="GstCapsFilter-struct"></a><h3>struct GstCapsFilter</h3>
165 <pre class="programlisting">struct GstCapsFilter;</pre>
166 <p>
167 The opaque <a class="link" href="gstreamer-plugins-capsfilter.html#GstCapsFilter"><span class="type">GstCapsFilter</span></a> data structure.
168 </p>
169 </div>
170 </div>
171 <div class="refsect1">
172 <a name="gstreamer-plugins-capsfilter.property-details"></a><h2>Property Details</h2>
173 <div class="refsect2">
174 <a name="GstCapsFilter--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
175 <pre class="programlisting">  "caps"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
176 <p>Restrict the possible allowed capabilities (NULL means ANY). Setting this property takes a reference to the supplied GstCaps object.</p>
177 </div>
178 </div>
179 </div>
180 <div class="footer">
181 <hr>
182           Generated by GTK-Doc V1.18</div>
183 </body>
184 </html>