docs/plugins/html/gst-plugins-good-plugins-capssetter.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>capssetter</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   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.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="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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-capssetter.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-capssetter.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-capssetter.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-capssetter.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  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>
  36 <td valign="top">
  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>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  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>;
  45 </pre>
  46 </div>
  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>
  54                      +----GstCapsSetter
  55 </pre>
  56 </div>
  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
  63 </pre>
  64 </div>
  65 <div class="refsect1">
  66 <a name="gst-plugins-good-plugins-capssetter.description"></a><h2>Description</h2>
  67 <p>
  68 </p>
  69 <div class="refsect2">
  70 <a name="idp6591504"></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).
  76 </p>
  77 <p>
  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.
  81 </p>
  82 <p>
  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
  88 </p>
  89 <p>
  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
  93 alike.
  94 </p>
  95 </div>
  96 <p>
  97 </p>
  98 <div class="refsynopsisdiv">
  99 <h2>Synopsis</h2>
 100 <div class="refsect2">
 101 <a name="idp11350464"></a><h3>Element Information</h3>
 102 <div class="variablelist"><table border="0">
 103 <col align="left" valign="top">
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term">plugin</span></p></td>
 107 <td>
 108             <a class="link" href="gst-plugins-good-plugins-plugin-debug.html#plugin-debug">debug</a>
 109           </td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term">author</span></p></td>
 113 <td>Mark Nauwelaerts &lt;mnauw@users.sourceforge.net&gt;</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">class</span></p></td>
 117 <td>Generic</td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2">
 124 <a name="idp5174800"></a><h3>Element Pads</h3>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term">name</span></p></td>
 130 <td>sink</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">direction</span></p></td>
 134 <td>sink</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">presence</span></p></td>
 138 <td>always</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">details</span></p></td>
 142 <td>ANY</td>
 143 </tr>
 144 </tbody>
 145 </table></div>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term">name</span></p></td>
 151 <td>src</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">direction</span></p></td>
 155 <td>source</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">presence</span></p></td>
 159 <td>always</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">details</span></p></td>
 163 <td>ANY</td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 </div>
 169 <p>
 170 </p>
 171 </div>
 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>
 177 <p>
 178 </p>
 179 </div>
 180 </div>
 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>
 187 </div>
 188 <hr>
 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>
 194 </div>
 195 <hr>
 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>
 201 </div>
 202 </div>
 203 </div>
 204 <div class="footer">
 205 <hr>
 206           Generated by GTK-Doc V1.17</div>
 207 </body>
 208 </html>