1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>capssetter</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-cairooverlay.html" title="cairooverlay">
10 <link rel="next" href="gst-plugins-good-plugins-cmmldec.html" title="cmmldec">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-cairooverlay.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 Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-cmmldec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-capssetter.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-good-plugins-capssetter.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-good-plugins-capssetter.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-good-plugins-capssetter.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-capssetter"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-capssetter.top_of_page"></a>capssetter</span></h2>
38 <p>capssetter — Set/merge caps on stream</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-good-plugins-capssetter.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstCapsSetter"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter-struct" title="struct GstCapsSetter">GstCapsSetter</a>;
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-capssetter.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>
57 <div class="refsect1">
58 <a name="gst-plugins-good-plugins-capssetter.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60 "<a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--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 "<a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--join" title='The "join" property'>join</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
62 "<a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--replace" title='The "replace" property'>replace</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
65 <div class="refsect1">
66 <a name="gst-plugins-good-plugins-capssetter.description"></a><h2>Description</h2>
69 <div class="refsect2">
70 <a name="idp11273184"></a><p>
71 Sets or merges caps on a stream's buffers.
72 That is, a buffer's caps are updated using (fields of)
73 <a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--caps" title='The "caps" property'>caps</a>. Note that this may
74 contain multiple structures (though not likely recommended), but each
75 of these must be fixed (or will otherwise be rejected).
78 If <a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--join" title='The "join" property'>join</a>
79 is TRUE, then the incoming caps' mime-type is compared to the mime-type(s)
80 of provided caps and only matching structure(s) are considered for updating.
83 If <a class="link" href="gst-plugins-good-plugins-capssetter.html#GstCapsSetter--replace" title='The "replace" property'>replace</a>
84 is TRUE, then any caps update is preceded by clearing existing fields,
85 making provided fields (as a whole) replace incoming ones.
86 Otherwise, no clearing is performed, in which case provided fields are
87 added/merged onto incoming caps
90 Although this element might mainly serve as debug helper,
91 it can also practically be used to correct a faulty pixel-aspect-ratio,
92 or to modify a yuv fourcc value to effectively swap chroma components or such
98 <div class="refsynopsisdiv">
100 <div class="refsect2">
101 <a name="idp11180304"></a><h3>Element Information</h3>
102 <div class="variablelist"><table border="0">
103 <col align="left" valign="top">
106 <td><p><span class="term">plugin</span></p></td>
108 <a class="link" href="gst-plugins-good-plugins-plugin-debug.html#plugin-debug">debug</a>
112 <td><p><span class="term">author</span></p></td>
113 <td>Mark Nauwelaerts <mnauw@users.sourceforge.net></td>
116 <td><p><span class="term">class</span></p></td>
123 <div class="refsect2">
124 <a name="idp8877056"></a><h3>Element Pads</h3>
125 <div class="variablelist"><table border="0">
126 <col align="left" valign="top">
129 <td><p><span class="term">name</span></p></td>
133 <td><p><span class="term">direction</span></p></td>
137 <td><p><span class="term">presence</span></p></td>
141 <td><p><span class="term">details</span></p></td>
146 <div class="variablelist"><table border="0">
147 <col align="left" valign="top">
150 <td><p><span class="term">name</span></p></td>
154 <td><p><span class="term">direction</span></p></td>
158 <td><p><span class="term">presence</span></p></td>
162 <td><p><span class="term">details</span></p></td>
172 <div class="refsect1">
173 <a name="gst-plugins-good-plugins-capssetter.details"></a><h2>Details</h2>
174 <div class="refsect2">
175 <a name="GstCapsSetter-struct"></a><h3>struct GstCapsSetter</h3>
176 <pre class="programlisting">struct GstCapsSetter;</pre>
181 <div class="refsect1">
182 <a name="gst-plugins-good-plugins-capssetter.property-details"></a><h2>Property Details</h2>
183 <div class="refsect2">
184 <a name="GstCapsSetter--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
185 <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>
186 <p>Merge these caps (thereby overwriting) in the stream.</p>
189 <div class="refsect2">
190 <a name="GstCapsSetter--join"></a><h3>The <code class="literal">"join"</code> property</h3>
191 <pre class="programlisting"> "join" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
192 <p>Match incoming caps' mime-type to mime-type of provided caps.</p>
193 <p>Default value: TRUE</p>
196 <div class="refsect2">
197 <a name="GstCapsSetter--replace"></a><h3>The <code class="literal">"replace"</code> property</h3>
198 <pre class="programlisting"> "replace" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
199 <p>Drop fields of incoming caps.</p>
200 <p>Default value: FALSE</p>
206 Generated by GTK-Doc V1.18</div>