docs/plugins/html/gst-plugins-good-plugins-ximagesrc.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>ximagesrc</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-webmmux.html" title="webmmux">
  10 <link rel="next" href="gst-plugins-good-plugins-y4menc.html" title="y4menc">
  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-webmmux.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-y4menc.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-ximagesrc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-ximagesrc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-ximagesrc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-ximagesrc.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-ximagesrc"></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-ximagesrc.top_of_page"></a>ximagesrc</span></h2>
  38 <p>ximagesrc — Creates a screenshot video 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-ximagesrc.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstXImageSrc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc-struct" title="struct GstXImageSrc">GstXImageSrc</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-ximagesrc.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/GstBaseSrc.html">GstBaseSrc</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
  55                            +----GstXImageSrc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-ximagesrc.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--display-name" title='The "display-name" property'>display-name</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--screen-num" title='The "screen-num" property'>screen-num</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--show-pointer" title='The "show-pointer" property'>show-pointer</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--endx" title='The "endx" property'>endx</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--endy" title='The "endy" property'>endy</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  66   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--startx" title='The "startx" property'>startx</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  67   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--starty" title='The "starty" property'>starty</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  68   "<a class="link" href="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--use-damage" title='The "use-damage" property'>use-damage</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="gst-plugins-good-plugins-ximagesrc.html#GstXImageSrc--remote" title='The "remote" property'>remote</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="gst-plugins-good-plugins-ximagesrc.description"></a><h2>Description</h2>
  74 <p>
  75 This element captures your X Display and creates raw RGB video.  It uses
  76 the XDamage extension if available to only capture areas of the screen that
  77 have changed since the last frame.  It uses the XFixes extension if
  78 available to also capture your mouse pointer.  By default it will fixate to
  79 25 frames per second.
  80 </p>
  81 <p>
  82 </p>
  83 <div class="refsect2">
  84 <a name="idp21049840"></a><h3>Example pipelines</h3>
  85 <div class="informalexample">
  86   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  87     <tbody>
  88       <tr>
  89         <td class="listing_lines" align="right"><pre>1</pre></td>
  90         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch ximagesrc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">-</span>rgb<span class="gtkdoc opt">,</span>framerate<span class="gtkdoc opt">=</span><span class="number">5</span><span class="gtkdoc opt">/</span><span class="number">1</span> <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> theoraenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>desktop<span class="gtkdoc opt">.</span>ogg</pre></td>
  91       </tr>
  92     </tbody>
  93   </table>
  94 </div>
  95  Encodes your X display to an Ogg theora video at 5 frames per second.
  96 </div>
  97 <p>
  98 </p>
  99 <div class="refsynopsisdiv">
 100 <h2>Synopsis</h2>
 101 <div class="refsect2">
 102 <a name="idp23077008"></a><h3>Element Information</h3>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody>
 106 <tr>
 107 <td><p><span class="term">plugin</span></p></td>
 108 <td>
 109             <a class="link" href="gst-plugins-good-plugins-plugin-ximagesrc.html#plugin-ximagesrc">ximagesrc</a>
 110           </td>
 111 </tr>
 112 <tr>
 113 <td><p><span class="term">author</span></p></td>
 114 <td>Lutz Mueller &lt;lutz@users.sourceforge.net&gt;, Jan Schmidt &lt;thaytan@mad.scientist.com&gt;, Zaheer Merali &lt;zaheerabbas at merali dot org&gt;</td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term">class</span></p></td>
 118 <td>Source/Video</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="idp24864192"></a><h3>Element Pads</h3>
 126 <div class="variablelist"><table border="0">
 127 <col align="left" valign="top">
 128 <tbody>
 129 <tr>
 130 <td><p><span class="term">name</span></p></td>
 131 <td>src</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">direction</span></p></td>
 135 <td>source</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term">presence</span></p></td>
 139 <td>always</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term">details</span></p></td>
 143 <td>video/x-raw-rgb, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], pixel-aspect-ratio=(fraction)[ 0/1, 2147483647/1 ]</td>
 144 </tr>
 145 </tbody>
 146 </table></div>
 147 </div>
 148 </div>
 149 <p>
 150 </p>
 151 </div>
 152 <div class="refsect1">
 153 <a name="gst-plugins-good-plugins-ximagesrc.details"></a><h2>Details</h2>
 154 <div class="refsect2">
 155 <a name="GstXImageSrc-struct"></a><h3>struct GstXImageSrc</h3>
 156 <pre class="programlisting">struct GstXImageSrc;</pre>
 157 <p>
 158 </p>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="gst-plugins-good-plugins-ximagesrc.property-details"></a><h2>Property Details</h2>
 163 <div class="refsect2">
 164 <a name="GstXImageSrc--display-name"></a><h3>The <code class="literal">"display-name"</code> property</h3>
 165 <pre class="programlisting">  "display-name"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 166 <p>X Display Name.</p>
 167 <p>Default value: NULL</p>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="GstXImageSrc--screen-num"></a><h3>The <code class="literal">"screen-num"</code> property</h3>
 172 <pre class="programlisting">  "screen-num"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 173 <p>X Screen Number.</p>
 174 <p>Allowed values: &lt;= G_MAXINT</p>
 175 <p>Default value: 0</p>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="GstXImageSrc--show-pointer"></a><h3>The <code class="literal">"show-pointer"</code> property</h3>
 180 <pre class="programlisting">  "show-pointer"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 181 <p>Show mouse pointer (if XFixes extension enabled).</p>
 182 <p>Default value: TRUE</p>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="GstXImageSrc--endx"></a><h3>The <code class="literal">"endx"</code> property</h3>
 187 <pre class="programlisting">  "endx"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 188 <p>
 189 X coordinate of bottom right corner of area to be recorded
 190 (0 for bottom right of screen)
 191 </p>
 192 <p>Allowed values: &lt;= G_MAXINT</p>
 193 <p>Default value: 0</p>
 194 <p class="since">Since 0.10.4</p>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="GstXImageSrc--endy"></a><h3>The <code class="literal">"endy"</code> property</h3>
 199 <pre class="programlisting">  "endy"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 200 <p>
 201 Y coordinate of bottom right corner of area to be recorded
 202 (0 for bottom right of screen)
 203 </p>
 204 <p>Allowed values: &lt;= G_MAXINT</p>
 205 <p>Default value: 0</p>
 206 <p class="since">Since 0.10.4</p>
 207 </div>
 208 <hr>
 209 <div class="refsect2">
 210 <a name="GstXImageSrc--startx"></a><h3>The <code class="literal">"startx"</code> property</h3>
 211 <pre class="programlisting">  "startx"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 212 <p>
 213 X coordinate of top left corner of area to be recorded
 214 (0 for top left of screen)
 215 </p>
 216 <p>Allowed values: &lt;= G_MAXINT</p>
 217 <p>Default value: 0</p>
 218 <p class="since">Since 0.10.4</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstXImageSrc--starty"></a><h3>The <code class="literal">"starty"</code> property</h3>
 223 <pre class="programlisting">  "starty"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 224 <p>
 225 Y coordinate of top left corner of area to be recorded
 226 (0 for top left of screen)
 227 </p>
 228 <p>Allowed values: &lt;= G_MAXINT</p>
 229 <p>Default value: 0</p>
 230 <p class="since">Since 0.10.4</p>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="GstXImageSrc--use-damage"></a><h3>The <code class="literal">"use-damage"</code> property</h3>
 235 <pre class="programlisting">  "use-damage"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 236 <p>
 237 Use XDamage (if the XDamage extension is enabled)
 238 </p>
 239 <p>Default value: TRUE</p>
 240 <p class="since">Since 0.10.4</p>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="GstXImageSrc--remote"></a><h3>The <code class="literal">"remote"</code> property</h3>
 245 <pre class="programlisting">  "remote"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 246 <p>
 247 Whether the X display is remote. The element will try to use alternate calls
 248 known to work better with remote displays.
 249 </p>
 250 <p>Default value: FALSE</p>
 251 <p class="since">Since 0.10.26</p>
 252 </div>
 253 </div>
 254 </div>
 255 <div class="footer">
 256 <hr>
 257           Generated by GTK-Doc V1.17</div>
 258 </body>
 259 </html>