docs/plugins/html/gstreamer-plugins-identity.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>identity</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="gstreamer-plugins-funnel.html" title="funnel">
  10 <link rel="next" href="gstreamer-plugins-input-selector.html" title="input-selector">
  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="gstreamer-plugins-funnel.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-input-selector.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-identity.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-plugins-identity.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gstreamer-plugins-identity.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gstreamer-plugins-identity.properties" class="shortcut">Properties</a>
  31                    |
  32                   <a href="#gstreamer-plugins-identity.signals" class="shortcut">Signals</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gstreamer-plugins-identity"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gstreamer-plugins-identity.top_of_page"></a>identity</span></h2>
  40 <p>identity — Pass data without modification</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gstreamer-plugins-identity.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstIdentity"></a><pre class="synopsis">struct              <a class="link" href="gstreamer-plugins-identity.html#GstIdentity-struct" title="struct GstIdentity">GstIdentity</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gstreamer-plugins-identity.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  56                      +----GstIdentity
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gstreamer-plugins-identity.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--check-perfect" title='The "check-perfect" property'>check-perfect</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  63   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--datarate" title='The "datarate" property'>datarate</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  64   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--drop-probability" title='The "drop-probability" property'>drop-probability</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  65   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--dump" title='The "dump" property'>dump</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  66   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--error-after" title='The "error-after" property'>error-after</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  67   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--last-message" title='The "last-message" property'>last-message</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  68   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  69   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--single-segment" title='The "single-segment" property'>single-segment</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--sleep-time" title='The "sleep-time" property'>sleep-time</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  71   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--sync" title='The "sync" property'>sync</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  72   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--check-imperfect-offset" title='The "check-imperfect-offset" property'>check-imperfect-offset</a>"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  73   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--check-imperfect-timestamp" title='The "check-imperfect-timestamp" property'>check-imperfect-timestamp</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  74   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity--signal-handoffs" title='The "signal-handoffs" property'>signal-handoffs</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  75 </pre>
  76 </div>
  77 <div class="refsect1">
  78 <a name="gstreamer-plugins-identity.signals"></a><h2>Signals</h2>
  79 <pre class="synopsis">
  80   "<a class="link" href="gstreamer-plugins-identity.html#GstIdentity-handoff" title='The "handoff" signal'>handoff</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="gstreamer-plugins-identity.description"></a><h2>Description</h2>
  85 <p>
  86 Dummy element that passes incoming data through unmodified. It has some
  87 useful diagnostic functions, such as offset and timestamp checking.
  88 </p>
  89 <div class="refsynopsisdiv">
  90 <h2>Synopsis</h2>
  91 <div class="refsect2">
  92 <a name="idp10037808"></a><h3>Element Information</h3>
  93 <div class="variablelist"><table border="0">
  94 <col align="left" valign="top">
  95 <tbody>
  96 <tr>
  97 <td><p><span class="term">plugin</span></p></td>
  98 <td>
  99             <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a>
 100           </td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term">author</span></p></td>
 104 <td>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term">class</span></p></td>
 108 <td>Generic</td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="idp10045264"></a><h3>Element Pads</h3>
 116 <div class="variablelist"><table border="0">
 117 <col align="left" valign="top">
 118 <tbody>
 119 <tr>
 120 <td><p><span class="term">name</span></p></td>
 121 <td>sink</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">direction</span></p></td>
 125 <td>sink</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term">presence</span></p></td>
 129 <td>always</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term">details</span></p></td>
 133 <td>ANY</td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term">name</span></p></td>
 142 <td>src</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">direction</span></p></td>
 146 <td>source</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">presence</span></p></td>
 150 <td>always</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term">details</span></p></td>
 154 <td>ANY</td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 </div>
 159 </div>
 160 <p>
 161 </p>
 162 </div>
 163 <div class="refsect1">
 164 <a name="gstreamer-plugins-identity.details"></a><h2>Details</h2>
 165 <div class="refsect2">
 166 <a name="GstIdentity-struct"></a><h3>struct GstIdentity</h3>
 167 <pre class="programlisting">struct GstIdentity;</pre>
 168 <p>
 169 Opaque <a class="link" href="gstreamer-plugins-identity.html#GstIdentity"><span class="type">GstIdentity</span></a> data structure
 170 </p>
 171 </div>
 172 </div>
 173 <div class="refsect1">
 174 <a name="gstreamer-plugins-identity.property-details"></a><h2>Property Details</h2>
 175 <div class="refsect2">
 176 <a name="GstIdentity--check-perfect"></a><h3>The <code class="literal">"check-perfect"</code> property</h3>
 177 <pre class="programlisting">  "check-perfect"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 178 <p>Verify that the stream is time- and data-contiguous. This only logs in the debug log.  This will be deprecated in favor of the check-imperfect-timestamp/offset properties.</p>
 179 <p>Default value: FALSE</p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="GstIdentity--datarate"></a><h3>The <code class="literal">"datarate"</code> property</h3>
 184 <pre class="programlisting">  "datarate"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 185 <p>(Re)timestamps buffers with number of bytes per second (0 = inactive).</p>
 186 <p>Allowed values: &gt;= 0</p>
 187 <p>Default value: 0</p>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="GstIdentity--drop-probability"></a><h3>The <code class="literal">"drop-probability"</code> property</h3>
 192 <pre class="programlisting">  "drop-probability"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 193 <p>The Probability a buffer is dropped.</p>
 194 <p>Allowed values: [0,1]</p>
 195 <p>Default value: 0</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="GstIdentity--dump"></a><h3>The <code class="literal">"dump"</code> property</h3>
 200 <pre class="programlisting">  "dump"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 201 <p>Dump buffer contents to stdout.</p>
 202 <p>Default value: FALSE</p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="GstIdentity--error-after"></a><h3>The <code class="literal">"error-after"</code> property</h3>
 207 <pre class="programlisting">  "error-after"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 208 <p>Error after N buffers.</p>
 209 <p>Default value: -1</p>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="GstIdentity--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3>
 214 <pre class="programlisting">  "last-message"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 215 <p>last-message.</p>
 216 <p>Default value: NULL</p>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="GstIdentity--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
 221 <pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 222 <p>silent.</p>
 223 <p>Default value: FALSE</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="GstIdentity--single-segment"></a><h3>The <code class="literal">"single-segment"</code> property</h3>
 228 <pre class="programlisting">  "single-segment"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 229 <p>Timestamp buffers and eat newsegments so as to appear as one segment.</p>
 230 <p>Default value: FALSE</p>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="GstIdentity--sleep-time"></a><h3>The <code class="literal">"sleep-time"</code> property</h3>
 235 <pre class="programlisting">  "sleep-time"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 236 <p>Microseconds to sleep between processing.</p>
 237 <p>Default value: 0</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstIdentity--sync"></a><h3>The <code class="literal">"sync"</code> property</h3>
 242 <pre class="programlisting">  "sync"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 243 <p>Synchronize to pipeline clock.</p>
 244 <p>Default value: FALSE</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="GstIdentity--check-imperfect-offset"></a><h3>The <code class="literal">"check-imperfect-offset"</code> property</h3>
 249 <pre class="programlisting">  "check-imperfect-offset"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 250 <p>Send element messages if offset and offset_end do not match up.</p>
 251 <p>Default value: FALSE</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="GstIdentity--check-imperfect-timestamp"></a><h3>The <code class="literal">"check-imperfect-timestamp"</code> property</h3>
 256 <pre class="programlisting">  "check-imperfect-timestamp" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 257 <p>Send element messages if timestamps and durations do not match up.</p>
 258 <p>Default value: FALSE</p>
 259 </div>
 260 <hr>
 261 <div class="refsect2">
 262 <a name="GstIdentity--signal-handoffs"></a><h3>The <code class="literal">"signal-handoffs"</code> property</h3>
 263 <pre class="programlisting">  "signal-handoffs"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 264 <p>
 265 If set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, the identity will emit a handoff signal when handling a buffer.
 266 When set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>, no signal will be emited, which might improve performance.
 267 </p>
 268 <p>Default value: TRUE</p>
 269 <p class="since">Since 0.10.16</p>
 270 </div>
 271 </div>
 272 <div class="refsect1">
 273 <a name="gstreamer-plugins-identity.signal-details"></a><h2>Signal Details</h2>
 274 <div class="refsect2">
 275 <a name="GstIdentity-handoff"></a><h3>The <code class="literal">"handoff"</code> signal</h3>
 276 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gstreamer-plugins-identity.html#GstIdentity"><span class="type">GstIdentity</span></a> *identity,
 277                                                         <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>   *buffer,
 278                                                         <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-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 279 <p>
 280 This signal gets emitted before passing the buffer downstream.
 281 </p>
 282 <div class="variablelist"><table border="0">
 283 <col align="left" valign="top">
 284 <tbody>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>identity</code></em> :</span></p></td>
 287 <td>the identity instance</td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 291 <td>the buffer that just has been received</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
 295 <td>the pad that received it</td>
 296 </tr>
 297 <tr>
 298 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 299 <td>user data set when the signal handler was connected.</td>
 300 </tr>
 301 </tbody>
 302 </table></div>
 303 </div>
 304 </div>
 305 </div>
 306 <div class="footer">
 307 <hr>
 308           Generated by GTK-Doc V1.18</div>
 309 </body>
 310 </html>