docs/plugins/html/gst-plugins-base-plugins-timeoverlay.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>timeoverlay</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-theoraparse.html" title="theoraparse">
  10 <link rel="next" href="gst-plugins-base-plugins-uridecodebin.html" title="uridecodebin">
  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-base-plugins-theoraparse.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-uridecodebin.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-base-plugins-timeoverlay.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-timeoverlay.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-timeoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gst-plugins-base-plugins-timeoverlay"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-timeoverlay.top_of_page"></a>timeoverlay</span></h2>
  36 <p>timeoverlay — Overlays buffer time stamps on a video stream</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gst-plugins-base-plugins-timeoverlay.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GstTimeOverlay"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-timeoverlay.html#GstTimeOverlay-struct" title="struct GstTimeOverlay">GstTimeOverlay</a>;
  43 </pre>
  44 </div>
  45 <div class="refsect1">
  46 <a name="gst-plugins-base-plugins-timeoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2>
  47 <pre class="synopsis">
  48   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  49    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  50          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  51                +----<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay">GstTextOverlay</a>
  52                      +----GstTimeOverlay
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="gst-plugins-base-plugins-timeoverlay.description"></a><h2>Description</h2>
  57 <p>
  58 This element overlays the buffer time stamps of a video stream on
  59 top of itself. You can position the text and configure the font details
  60 using the properties of the <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a> class. By default, the
  61 time stamp is displayed in the top left corner of the picture, with some
  62 padding to the left and to the top.
  63 </p>
  64 <p>
  65 </p>
  66 <div class="refsect2">
  67 <a name="idp14194400"></a><div class="informalexample">
  68   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  69     <tbody>
  70       <tr>
  71         <td class="listing_lines" align="right"><pre>1</pre></td>
  72         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> timeoverlay <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
  73       </tr>
  74     </tbody>
  75   </table>
  76 </div>
  77  Display the time stamps in the top left
  78 corner of the video picture.
  79 <div class="informalexample">
  80   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  81     <tbody>
  82       <tr>
  83         <td class="listing_lines" align="right"><pre>1</pre></td>
  84         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> timeoverlay halign<span class="gtkdoc opt">=</span>right valign<span class="gtkdoc opt">=</span>bottom text<span class="gtkdoc opt">=</span><span class="string">&quot;Stream time:&quot;</span> shaded<span class="gtkdoc opt">-</span>background<span class="gtkdoc opt">=</span><span class="keyword">true</span> <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
  85       </tr>
  86     </tbody>
  87   </table>
  88 </div>
  89  Another pipeline that displays the time stamps with some leading
  90 text in the bottom right corner of the video picture, with the background
  91 of the text being shaded in order to make it more legible on top of a
  92 bright video background.
  93 </div>
  94 <p>
  95 </p>
  96 <div class="refsynopsisdiv">
  97 <h2>Synopsis</h2>
  98 <div class="refsect2">
  99 <a name="idp14192224"></a><h3>Element Information</h3>
 100 <div class="variablelist"><table border="0">
 101 <col align="left" valign="top">
 102 <tbody>
 103 <tr>
 104 <td><p><span class="term">plugin</span></p></td>
 105 <td>
 106             <a class="link" href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
 107           </td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term">author</span></p></td>
 111 <td>Tim-Philipp Müller &lt;tim@centricular.net&gt;</td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term">class</span></p></td>
 115 <td>Filter/Editor/Video</td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 </div>
 120 <hr>
 121 <div class="refsect2">
 122 <a name="idp13857408"></a><h3>Element Pads</h3>
 123 <div class="variablelist"><table border="0">
 124 <col align="left" valign="top">
 125 <tbody>
 126 <tr>
 127 <td><p><span class="term">name</span></p></td>
 128 <td>video_sink</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">direction</span></p></td>
 132 <td>sink</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term">presence</span></p></td>
 136 <td>always</td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term">details</span></p></td>
 140 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"></span></p></td>
 144 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term"></span></p></td>
 148 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term"></span></p></td>
 152 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term"></span></p></td>
 156 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"></span></p></td>
 160 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"></span></p></td>
 164 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"></span></p></td>
 168 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term"></span></p></td>
 172 <td> video/x-raw-yuv, format=(fourcc){ AYUV, I420, UYVY, NV12, NV21 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 <div class="variablelist"><table border="0">
 177 <col align="left" valign="top">
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term">name</span></p></td>
 181 <td>src</td>
 182 </tr>
 183 <tr>
 184 <td><p><span class="term">direction</span></p></td>
 185 <td>source</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term">presence</span></p></td>
 189 <td>always</td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term">details</span></p></td>
 193 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"></span></p></td>
 197 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"></span></p></td>
 201 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"></span></p></td>
 205 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"></span></p></td>
 209 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"></span></p></td>
 213 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"></span></p></td>
 217 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"></span></p></td>
 221 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 222 </tr>
 223 <tr>
 224 <td><p><span class="term"></span></p></td>
 225 <td> video/x-raw-yuv, format=(fourcc){ AYUV, I420, UYVY, NV12, NV21 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 226 </tr>
 227 </tbody>
 228 </table></div>
 229 </div>
 230 </div>
 231 <p>
 232 </p>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gst-plugins-base-plugins-timeoverlay.details"></a><h2>Details</h2>
 236 <div class="refsect2">
 237 <a name="GstTimeOverlay-struct"></a><h3>struct GstTimeOverlay</h3>
 238 <pre class="programlisting">struct GstTimeOverlay;</pre>
 239 <p>
 240 Opaque timeoverlay data structure.
 241 </p>
 242 </div>
 243 </div>
 244 <div class="refsect1">
 245 <a name="gst-plugins-base-plugins-timeoverlay.see-also"></a><h2>See Also</h2>
 246 <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a>, <a class="link" href="gst-plugins-base-plugins-clockoverlay.html#GstClockOverlay"><span class="type">GstClockOverlay</span></a>
 247 </div>
 248 </div>
 249 <div class="footer">
 250 <hr>
 251           Generated by GTK-Doc V1.17</div>
 252 </body>
 253 </html>