Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / 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.76.1">
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.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="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 <div class="refsynopsisdiv">
85 <h2>Synopsis</h2>
86 <div class="refsect2">
87 <a name="idp8758688"></a><h3>Element Information</h3>
88 <div class="variablelist"><table border="0">
89 <col align="left" valign="top">
90 <tbody>
91 <tr>
92 <td><p><span class="term">plugin</span></p></td>
93 <td>
94             <a class="link" href="gst-plugins-good-plugins-plugin-aasink.html#plugin-aasink">aasink</a>
95           </td>
96 </tr>
97 <tr>
98 <td><p><span class="term">author</span></p></td>
99 <td>Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
100 </tr>
101 <tr>
102 <td><p><span class="term">class</span></p></td>
103 <td>Sink/Video</td>
104 </tr>
105 </tbody>
106 </table></div>
107 </div>
108 <hr>
109 <div class="refsect2">
110 <a name="idp9206736"></a><h3>Element Pads</h3>
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
113 <tbody>
114 <tr>
115 <td><p><span class="term">name</span></p></td>
116 <td>sink</td>
117 </tr>
118 <tr>
119 <td><p><span class="term">direction</span></p></td>
120 <td>sink</td>
121 </tr>
122 <tr>
123 <td><p><span class="term">presence</span></p></td>
124 <td>always</td>
125 </tr>
126 <tr>
127 <td><p><span class="term">details</span></p></td>
128 <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
129 </tr>
130 </tbody>
131 </table></div>
132 </div>
133 </div>
134 <p>
135 </p>
136 </div>
137 <div class="refsect1">
138 <a name="gst-plugins-good-plugins-aasink.details"></a><h2>Details</h2>
139 <div class="refsect2">
140 <a name="GstAASink-struct"></a><h3>struct GstAASink</h3>
141 <pre class="programlisting">struct GstAASink;</pre>
142 <p>
143 </p>
144 </div>
145 </div>
146 <div class="refsect1">
147 <a name="gst-plugins-good-plugins-aasink.property-details"></a><h2>Property Details</h2>
148 <div class="refsect2">
149 <a name="GstAASink--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
150 <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>
151 <p>brightness.</p>
152 <p>Default value: 0</p>
153 </div>
154 <hr>
155 <div class="refsect2">
156 <a name="GstAASink--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
157 <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>
158 <p>contrast.</p>
159 <p>Default value: 0</p>
160 </div>
161 <hr>
162 <div class="refsect2">
163 <a name="GstAASink--dither"></a><h3>The <code class="literal">"dither"</code> property</h3>
164 <pre class="programlisting">  "dither"                   <span class="type">GstAASinkDitherers</span>    : Read / Write</pre>
165 <p>dither.</p>
166 <p>Default value: no dithering</p>
167 </div>
168 <hr>
169 <div class="refsect2">
170 <a name="GstAASink--driver"></a><h3>The <code class="literal">"driver"</code> property</h3>
171 <pre class="programlisting">  "driver"                   <span class="type">GstAASinkDrivers</span>      : Read / Write</pre>
172 <p>driver.</p>
173 <p>Default value: X11 driver 1.1</p>
174 </div>
175 <hr>
176 <div class="refsect2">
177 <a name="GstAASink--frame-time"></a><h3>The <code class="literal">"frame-time"</code> property</h3>
178 <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>
179 <p>frame time.</p>
180 <p>Default value: 0</p>
181 </div>
182 <hr>
183 <div class="refsect2">
184 <a name="GstAASink--frames-displayed"></a><h3>The <code class="literal">"frames-displayed"</code> property</h3>
185 <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>
186 <p>frames displayed.</p>
187 <p>Default value: 0</p>
188 </div>
189 <hr>
190 <div class="refsect2">
191 <a name="GstAASink--gamma"></a><h3>The <code class="literal">"gamma"</code> property</h3>
192 <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>
193 <p>gamma.</p>
194 <p>Allowed values: [0,5]</p>
195 <p>Default value: 1</p>
196 </div>
197 <hr>
198 <div class="refsect2">
199 <a name="GstAASink--height"></a><h3>The <code class="literal">"height"</code> property</h3>
200 <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>
201 <p>height.</p>
202 <p>Default value: 0</p>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="GstAASink--inversion"></a><h3>The <code class="literal">"inversion"</code> property</h3>
207 <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>
208 <p>inversion.</p>
209 <p>Default value: TRUE</p>
210 </div>
211 <hr>
212 <div class="refsect2">
213 <a name="GstAASink--randomval"></a><h3>The <code class="literal">"randomval"</code> property</h3>
214 <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>
215 <p>randomval.</p>
216 <p>Default value: 0</p>
217 </div>
218 <hr>
219 <div class="refsect2">
220 <a name="GstAASink--width"></a><h3>The <code class="literal">"width"</code> property</h3>
221 <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>
222 <p>width.</p>
223 <p>Default value: 0</p>
224 </div>
225 </div>
226 <div class="refsect1">
227 <a name="gst-plugins-good-plugins-aasink.signal-details"></a><h2>Signal Details</h2>
228 <div class="refsect2">
229 <a name="GstAASink-frame-displayed"></a><h3>The <code class="literal">"frame-displayed"</code> signal</h3>
230 <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,
231                                                         <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>
232 <p>
233 </p>
234 <div class="variablelist"><table border="0">
235 <col align="left" valign="top">
236 <tbody>
237 <tr>
238 <td><p><span class="term"><em class="parameter"><code>gstaasink</code></em> :</span></p></td>
239 <td>the object which received the signal.</td>
240 </tr>
241 <tr>
242 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
243 <td>user data set when the signal handler was connected.</td>
244 </tr>
245 </tbody>
246 </table></div>
247 </div>
248 <hr>
249 <div class="refsect2">
250 <a name="GstAASink-have-size"></a><h3>The <code class="literal">"have-size"</code> signal</h3>
251 <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,
252                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      arg1,
253                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      arg2,
254                                                         <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>
255 <p>
256 </p>
257 <div class="variablelist"><table border="0">
258 <col align="left" valign="top">
259 <tbody>
260 <tr>
261 <td><p><span class="term"><em class="parameter"><code>gstaasink</code></em> :</span></p></td>
262 <td>the object which received the signal.</td>
263 </tr>
264 <tr>
265 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
266 <td>user data set when the signal handler was connected.</td>
267 </tr>
268 </tbody>
269 </table></div>
270 </div>
271 </div>
272 </div>
273 <div class="footer">
274 <hr>
275           Generated by GTK-Doc V1.18</div>
276 </body>
277 </html>