docs/plugins/html/gst-plugins-good-plugins-aasink.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>aasink</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-aacparse.html" title="aacparse">
  10 <link rel="next" href="gst-plugins-good-plugins-ac3parse.html" title="ac3parse">
  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-aacparse.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-ac3parse.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-aasink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-aasink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-aasink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-aasink.properties" class="shortcut">Properties</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-aasink.signals" class="shortcut">Signals</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-aasink"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-aasink.top_of_page"></a>aasink</span></h2>
  40 <p>aasink — An ASCII art videosink</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-good-plugins-aasink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstAASink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink-struct" title="struct GstAASink">GstAASink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-aasink.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/GstBaseSink.html">GstBaseSink</a>
  56                      +----GstAASink
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="gst-plugins-good-plugins-aasink.properties"></a><h2>Properties</h2>
  61 <pre class="synopsis">
  62   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--brightness" title='The "brightness" property'>brightness</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--contrast" title='The "contrast" property'>contrast</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="gst-plugins-good-plugins-aasink.html#GstAASink--dither" title='The "dither" property'>dither</a>"                   <span class="type">GstAASinkDitherers</span>    : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--driver" title='The "driver" property'>driver</a>"                   <span class="type">GstAASinkDrivers</span>      : Read / Write
  66   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--frame-time" title='The "frame-time" property'>frame-time</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  67   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--frames-displayed" title='The "frames-displayed" property'>frames-displayed</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
  68   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--gamma" title='The "gamma" property'>gamma</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  69   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--height" title='The "height" property'>height</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--inversion" title='The "inversion" property'>inversion</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--randomval" title='The "randomval" property'>randomval</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  72   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink--width" title='The "width" property'>width</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gst-plugins-good-plugins-aasink.signals"></a><h2>Signals</h2>
  77 <pre class="synopsis">
  78   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink-frame-displayed" title='The "frame-displayed" signal'>frame-displayed</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>
  79   "<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink-have-size" title='The "have-size" signal'>have-size</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>
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gst-plugins-good-plugins-aasink.description"></a><h2>Description</h2>
  84 <p>
  85 Displays video as b/w ascii art.
  86 </p>
  87 <p>
  88 </p>
  89 <div class="refsect2">
  90 <a name="idp7804576"></a><h3>Example launch line</h3>
  91 <div class="informalexample">
  92   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  93     <tbody>
  94       <tr>
  95         <td class="listing_lines" align="right"><pre>1</pre></td>
  96         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>avi <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> aasink</pre></td>
  97       </tr>
  98     </tbody>
  99   </table>
 100 </div>
 101  This pipeline renders a video to ascii art into a separate window.
 102 <div class="informalexample">
 103   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 104     <tbody>
 105       <tr>
 106         <td class="listing_lines" align="right"><pre>1</pre></td>
 107         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>avi <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> aasink driver<span class="gtkdoc opt">=</span>curses</pre></td>
 108       </tr>
 109     </tbody>
 110   </table>
 111 </div>
 112  This pipeline renders a video to ascii art into the current terminal.
 113 </div>
 114 <p>
 115 </p>
 116 <div class="refsynopsisdiv">
 117 <h2>Synopsis</h2>
 118 <div class="refsect2">
 119 <a name="idp6504048"></a><h3>Element Information</h3>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term">plugin</span></p></td>
 125 <td>
 126             <a class="link" href="gst-plugins-good-plugins-plugin-aasink.html#plugin-aasink">aasink</a>
 127           </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">author</span></p></td>
 131 <td>Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">class</span></p></td>
 135 <td>Sink/Video</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="idp6069824"></a><h3>Element Pads</h3>
 143 <div class="variablelist"><table border="0">
 144 <col align="left" valign="top">
 145 <tbody>
 146 <tr>
 147 <td><p><span class="term">name</span></p></td>
 148 <td>sink</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">direction</span></p></td>
 152 <td>sink</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term">presence</span></p></td>
 156 <td>always</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">details</span></p></td>
 160 <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 </div>
 166 <p>
 167 </p>
 168 </div>
 169 <div class="refsect1">
 170 <a name="gst-plugins-good-plugins-aasink.details"></a><h2>Details</h2>
 171 <div class="refsect2">
 172 <a name="GstAASink-struct"></a><h3>struct GstAASink</h3>
 173 <pre class="programlisting">struct GstAASink;</pre>
 174 <p>
 175 </p>
 176 </div>
 177 </div>
 178 <div class="refsect1">
 179 <a name="gst-plugins-good-plugins-aasink.property-details"></a><h2>Property Details</h2>
 180 <div class="refsect2">
 181 <a name="GstAASink--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
 182 <pre class="programlisting">  "brightness"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 183 <p>brightness.</p>
 184 <p>Default value: 0</p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="GstAASink--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
 189 <pre class="programlisting">  "contrast"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 190 <p>contrast.</p>
 191 <p>Default value: 0</p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="GstAASink--dither"></a><h3>The <code class="literal">"dither"</code> property</h3>
 196 <pre class="programlisting">  "dither"                   <span class="type">GstAASinkDitherers</span>    : Read / Write</pre>
 197 <p>dither.</p>
 198 <p>Default value: no dithering</p>
 199 </div>
 200 <hr>
 201 <div class="refsect2">
 202 <a name="GstAASink--driver"></a><h3>The <code class="literal">"driver"</code> property</h3>
 203 <pre class="programlisting">  "driver"                   <span class="type">GstAASinkDrivers</span>      : Read / Write</pre>
 204 <p>driver.</p>
 205 <p>Default value: X11 driver 1.1</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstAASink--frame-time"></a><h3>The <code class="literal">"frame-time"</code> property</h3>
 210 <pre class="programlisting">  "frame-time"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 211 <p>frame time.</p>
 212 <p>Default value: 0</p>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="GstAASink--frames-displayed"></a><h3>The <code class="literal">"frames-displayed"</code> property</h3>
 217 <pre class="programlisting">  "frames-displayed"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 218 <p>frames displayed.</p>
 219 <p>Default value: 0</p>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="GstAASink--gamma"></a><h3>The <code class="literal">"gamma"</code> property</h3>
 224 <pre class="programlisting">  "gamma"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 225 <p>gamma.</p>
 226 <p>Allowed values: [0,5]</p>
 227 <p>Default value: 1</p>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="GstAASink--height"></a><h3>The <code class="literal">"height"</code> property</h3>
 232 <pre class="programlisting">  "height"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 233 <p>height.</p>
 234 <p>Default value: 0</p>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="GstAASink--inversion"></a><h3>The <code class="literal">"inversion"</code> property</h3>
 239 <pre class="programlisting">  "inversion"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 240 <p>inversion.</p>
 241 <p>Default value: TRUE</p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="GstAASink--randomval"></a><h3>The <code class="literal">"randomval"</code> property</h3>
 246 <pre class="programlisting">  "randomval"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 247 <p>randomval.</p>
 248 <p>Default value: 0</p>
 249 </div>
 250 <hr>
 251 <div class="refsect2">
 252 <a name="GstAASink--width"></a><h3>The <code class="literal">"width"</code> property</h3>
 253 <pre class="programlisting">  "width"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 254 <p>width.</p>
 255 <p>Default value: 0</p>
 256 </div>
 257 </div>
 258 <div class="refsect1">
 259 <a name="gst-plugins-good-plugins-aasink.signal-details"></a><h2>Signal Details</h2>
 260 <div class="refsect2">
 261 <a name="GstAASink-frame-displayed"></a><h3>The <code class="literal">"frame-displayed"</code> signal</h3>
 262 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink"><span class="type">GstAASink</span></a> *gstaasink,
 263                                                         <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>
 264 <p>
 265 </p>
 266 <div class="variablelist"><table border="0">
 267 <col align="left" valign="top">
 268 <tbody>
 269 <tr>
 270 <td><p><span class="term"><em class="parameter"><code>gstaasink</code></em> :</span></p></td>
 271 <td>the object which received the signal.</td>
 272 </tr>
 273 <tr>
 274 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 275 <td>user data set when the signal handler was connected.</td>
 276 </tr>
 277 </tbody>
 278 </table></div>
 279 </div>
 280 <hr>
 281 <div class="refsect2">
 282 <a name="GstAASink-have-size"></a><h3>The <code class="literal">"have-size"</code> signal</h3>
 283 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gst-plugins-good-plugins-aasink.html#GstAASink"><span class="type">GstAASink</span></a> *gstaasink,
 284                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      arg1,
 285                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      arg2,
 286                                                         <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>
 287 <p>
 288 </p>
 289 <div class="variablelist"><table border="0">
 290 <col align="left" valign="top">
 291 <tbody>
 292 <tr>
 293 <td><p><span class="term"><em class="parameter"><code>gstaasink</code></em> :</span></p></td>
 294 <td>the object which received the signal.</td>
 295 </tr>
 296 <tr>
 297 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 298 <td>user data set when the signal handler was connected.</td>
 299 </tr>
 300 </tbody>
 301 </table></div>
 302 </div>
 303 </div>
 304 <div class="refsect1">
 305 <a name="gst-plugins-good-plugins-aasink.see-also"></a><h2>See Also</h2>
 306 <a class="link" href="gst-plugins-good-plugins-cacasink.html#GstCACASink"><span class="type">GstCACASink</span></a>
 307 </div>
 308 </div>
 309 <div class="footer">
 310 <hr>
 311           Generated by GTK-Doc V1.17</div>
 312 </body>
 313 </html>