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>playsink: GStreamer Base Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-playbin3.html" title="playbin3"> 10<link rel="next" href="gst-plugins-base-plugins-rawaudioparse.html" title="rawaudioparse"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-base-plugins-playsink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-playsink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-playsink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-playsink.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 22 <a href="#gst-plugins-base-plugins-playsink.signals" class="shortcut">Signals</a></span> 23</td> 24<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 25<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 26<td><a accesskey="p" href="gst-plugins-base-plugins-playbin3.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 27<td><a accesskey="n" href="gst-plugins-base-plugins-rawaudioparse.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 28</tr></table> 29<div class="refentry"> 30<a name="gst-plugins-base-plugins-playsink"></a><div class="titlepage"></div> 31<div class="refnamediv"><table width="100%"><tr> 32<td valign="top"> 33<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-playsink.top_of_page"></a>playsink</span></h2> 34<p>playsink</p> 35</td> 36<td class="gallery_image" valign="top" align="right"></td> 37</tr></table></div> 38<div class="refsect1"> 39<a name="gst-plugins-base-plugins-playsink.properties"></a><h2>Properties</h2> 40<div class="informaltable"><table class="informaltable" border="0"> 41<colgroup> 42<col width="150px" class="properties_type"> 43<col width="300px" class="properties_name"> 44<col width="200px" class="properties_flags"> 45</colgroup> 46<tbody> 47<tr> 48<td class="property_type"> 49<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 50<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--audio-sink" title="The “audio-sink” property">audio-sink</a></td> 51<td class="property_flags">Read / Write</td> 52</tr> 53<tr> 54<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td> 55<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--av-offset" title="The “av-offset” property">av-offset</a></td> 56<td class="property_flags">Read / Write</td> 57</tr> 58<tr> 59<td class="property_type"><span class="type">GstPlayFlags</span></td> 60<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--flags" title="The “flags” property">flags</a></td> 61<td class="property_flags">Read / Write</td> 62</tr> 63<tr> 64<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 65<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--force-aspect-ratio" title="The “force-aspect-ratio” property">force-aspect-ratio</a></td> 66<td class="property_flags">Read / Write</td> 67</tr> 68<tr> 69<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 70<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--mute" title="The “mute” property">mute</a></td> 71<td class="property_flags">Read / Write</td> 72</tr> 73<tr> 74<td class="property_type"> 75<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSample.html#GstSample-struct"><span class="type">GstSample</span></a> *</td> 76<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--sample" title="The “sample” property">sample</a></td> 77<td class="property_flags">Read</td> 78</tr> 79<tr> 80<td class="property_type"><span class="type">GstPlaySinkSendEventMode</span></td> 81<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--send-event-mode" title="The “send-event-mode” property">send-event-mode</a></td> 82<td class="property_flags">Read / Write</td> 83</tr> 84<tr> 85<td class="property_type"> 86<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 87<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--subtitle-encoding" title="The “subtitle-encoding” property">subtitle-encoding</a></td> 88<td class="property_flags">Read / Write</td> 89</tr> 90<tr> 91<td class="property_type"> 92<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 93<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--subtitle-font-desc" title="The “subtitle-font-desc” property">subtitle-font-desc</a></td> 94<td class="property_flags">Write</td> 95</tr> 96<tr> 97<td class="property_type"> 98<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 99<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--text-sink" title="The “text-sink” property">text-sink</a></td> 100<td class="property_flags">Read / Write</td> 101</tr> 102<tr> 103<td class="property_type"> 104<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 105<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--video-sink" title="The “video-sink” property">video-sink</a></td> 106<td class="property_flags">Read / Write</td> 107</tr> 108<tr> 109<td class="property_type"> 110<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 111<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--vis-plugin" title="The “vis-plugin” property">vis-plugin</a></td> 112<td class="property_flags">Read / Write</td> 113</tr> 114<tr> 115<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 116<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--volume" title="The “volume” property">volume</a></td> 117<td class="property_flags">Read / Write</td> 118</tr> 119<tr> 120<td class="property_type"> 121<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 122<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--audio-filter" title="The “audio-filter” property">audio-filter</a></td> 123<td class="property_flags">Read / Write</td> 124</tr> 125<tr> 126<td class="property_type"> 127<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td> 128<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--video-filter" title="The “video-filter” property">video-filter</a></td> 129<td class="property_flags">Read / Write</td> 130</tr> 131<tr> 132<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td> 133<td class="property_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink--text-offset" title="The “text-offset” property">text-offset</a></td> 134<td class="property_flags">Read / Write</td> 135</tr> 136</tbody> 137</table></div> 138</div> 139<div class="refsect1"> 140<a name="gst-plugins-base-plugins-playsink.signals"></a><h2>Signals</h2> 141<div class="informaltable"><table class="informaltable" border="0"> 142<colgroup> 143<col width="150px" class="signals_return"> 144<col width="300px" class="signals_name"> 145<col width="200px" class="signals_flags"> 146</colgroup> 147<tbody> 148<tr> 149<td class="signal_type"> 150<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSample.html#GstSample-struct"><span class="returnvalue">GstSample</span></a>*</td> 151<td class="signal_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink-convert-sample" title="The “convert-sample” signal">convert-sample</a></td> 152<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 153</tr> 154<tr> 155<td class="signal_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td> 156<td class="signal_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink-reconfigure" title="The “reconfigure” signal">reconfigure</a></td> 157<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td> 158</tr> 159</tbody> 160</table></div> 161</div> 162<a name="GstPlaySink"></a><div class="refsect1"> 163<a name="gst-plugins-base-plugins-playsink.other"></a><h2>Types and Values</h2> 164<div class="informaltable"><table class="informaltable" width="100%" border="0"> 165<colgroup> 166<col width="150px" class="name"> 167<col class="description"> 168</colgroup> 169<tbody><tr> 170<td class="datatype_keyword"> </td> 171<td class="function_name"><a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink-struct" title="GstPlaySink">GstPlaySink</a></td> 172</tr></tbody> 173</table></div> 174</div> 175<div class="refsect1"> 176<a name="gst-plugins-base-plugins-playsink.object-hierarchy"></a><h2>Object Hierarchy</h2> 177<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 178 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 179 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 180 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 181 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct">GstBin</a> 182 <span class="lineart">╰──</span> GstPlaySink 183</pre> 184</div> 185<div class="refsect1"> 186<a name="gst-plugins-base-plugins-playsink.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 187<p> 188GstPlaySink implements 189 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>, <a href="../html/GstStreamVolume.html#GstStreamVolume-struct">GstStreamVolume</a>, <a href="../html/GstVideoOverlay.html#GstVideoOverlay-struct">GstVideoOverlay</a>, <a href="../html/GstNavigation.html#GstNavigation-struct">GstNavigation</a> and <a href="../html/GstColorBalance.html#GstColorBalance-struct">GstColorBalance</a>.</p> 190</div> 191<div class="refsect1"> 192<a name="gst-plugins-base-plugins-playsink.description"></a><h2>Description</h2> 193<div class="refsynopsisdiv"> 194<h2>Synopsis</h2> 195<div class="refsect2"> 196<a name="id-1.2.85.9.2.1"></a><h3>Element Information</h3> 197<div class="variablelist"><table border="0" class="variablelist"> 198<colgroup> 199<col align="left" valign="top"> 200<col> 201</colgroup> 202<tbody> 203<tr> 204<td><p><span class="term">plugin</span></p></td> 205<td> 206 <a class="link" href="gst-plugins-base-plugins-plugin-playback.html#plugin-playback">playback</a> 207 </td> 208</tr> 209<tr> 210<td><p><span class="term">author</span></p></td> 211<td>Wim Taymans <wim.taymans@gmail.com></td> 212</tr> 213<tr> 214<td><p><span class="term">class</span></p></td> 215<td>Generic/Bin/Sink</td> 216</tr> 217</tbody> 218</table></div> 219</div> 220<hr> 221<div class="refsect2"> 222<a name="id-1.2.85.9.2.2"></a><h3>Element Pads</h3> 223<div class="variablelist"><table border="0" class="variablelist"> 224<colgroup> 225<col align="left" valign="top"> 226<col> 227</colgroup> 228<tbody> 229<tr> 230<td><p><span class="term">name</span></p></td> 231<td>audio_raw_sink</td> 232</tr> 233<tr> 234<td><p><span class="term">direction</span></p></td> 235<td>sink</td> 236</tr> 237<tr> 238<td><p><span class="term">presence</span></p></td> 239<td>request</td> 240</tr> 241<tr> 242<td><p><span class="term">details</span></p></td> 243<td>ANY</td> 244</tr> 245</tbody> 246</table></div> 247<div class="variablelist"><table border="0" class="variablelist"> 248<colgroup> 249<col align="left" valign="top"> 250<col> 251</colgroup> 252<tbody> 253<tr> 254<td><p><span class="term">name</span></p></td> 255<td>audio_sink</td> 256</tr> 257<tr> 258<td><p><span class="term">direction</span></p></td> 259<td>sink</td> 260</tr> 261<tr> 262<td><p><span class="term">presence</span></p></td> 263<td>request</td> 264</tr> 265<tr> 266<td><p><span class="term">details</span></p></td> 267<td>ANY</td> 268</tr> 269</tbody> 270</table></div> 271<div class="variablelist"><table border="0" class="variablelist"> 272<colgroup> 273<col align="left" valign="top"> 274<col> 275</colgroup> 276<tbody> 277<tr> 278<td><p><span class="term">name</span></p></td> 279<td>text_sink</td> 280</tr> 281<tr> 282<td><p><span class="term">direction</span></p></td> 283<td>sink</td> 284</tr> 285<tr> 286<td><p><span class="term">presence</span></p></td> 287<td>request</td> 288</tr> 289<tr> 290<td><p><span class="term">details</span></p></td> 291<td>ANY</td> 292</tr> 293</tbody> 294</table></div> 295<div class="variablelist"><table border="0" class="variablelist"> 296<colgroup> 297<col align="left" valign="top"> 298<col> 299</colgroup> 300<tbody> 301<tr> 302<td><p><span class="term">name</span></p></td> 303<td>video_raw_sink</td> 304</tr> 305<tr> 306<td><p><span class="term">direction</span></p></td> 307<td>sink</td> 308</tr> 309<tr> 310<td><p><span class="term">presence</span></p></td> 311<td>request</td> 312</tr> 313<tr> 314<td><p><span class="term">details</span></p></td> 315<td>ANY</td> 316</tr> 317</tbody> 318</table></div> 319<div class="variablelist"><table border="0" class="variablelist"> 320<colgroup> 321<col align="left" valign="top"> 322<col> 323</colgroup> 324<tbody> 325<tr> 326<td><p><span class="term">name</span></p></td> 327<td>video_sink</td> 328</tr> 329<tr> 330<td><p><span class="term">direction</span></p></td> 331<td>sink</td> 332</tr> 333<tr> 334<td><p><span class="term">presence</span></p></td> 335<td>request</td> 336</tr> 337<tr> 338<td><p><span class="term">details</span></p></td> 339<td>ANY</td> 340</tr> 341</tbody> 342</table></div> 343</div> 344</div> 345</div> 346<div class="refsect1"> 347<a name="gst-plugins-base-plugins-playsink.functions_details"></a><h2>Functions</h2> 348<p></p> 349</div> 350<div class="refsect1"> 351<a name="gst-plugins-base-plugins-playsink.other_details"></a><h2>Types and Values</h2> 352<div class="refsect2"> 353<a name="GstPlaySink-struct"></a><h3>GstPlaySink</h3> 354<pre class="programlisting">typedef struct _GstPlaySink GstPlaySink;</pre> 355</div> 356</div> 357<div class="refsect1"> 358<a name="gst-plugins-base-plugins-playsink.property-details"></a><h2>Property Details</h2> 359<div class="refsect2"> 360<a name="GstPlaySink--audio-sink"></a><h3>The <code class="literal">“audio-sink”</code> property</h3> 361<pre class="programlisting"> “audio-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 362<p>Set the used audio sink element. NULL will use the default sink. playsink 363must be in <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GST-STATE-NULL:CAPS"><code class="literal">GST_STATE_NULL</code></a></p> 364<p>Flags: Read / Write</p> 365</div> 366<hr> 367<div class="refsect2"> 368<a name="GstPlaySink--av-offset"></a><h3>The <code class="literal">“av-offset”</code> property</h3> 369<pre class="programlisting"> “av-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> 370<p>Control the synchronisation offset between the audio and video streams. 371Positive values make the audio ahead of the video and negative values make 372the audio go behind the video.</p> 373<p>Flags: Read / Write</p> 374<p>Default value: 0</p> 375</div> 376<hr> 377<div class="refsect2"> 378<a name="GstPlaySink--flags"></a><h3>The <code class="literal">“flags”</code> property</h3> 379<pre class="programlisting"> “flags” <span class="type">GstPlayFlags</span></pre> 380<p>Control the behaviour of playsink.</p> 381<p>Flags: Read / Write</p> 382<p>Default value: Render the video stream|Render the audio stream|Render subtitles|Use software volume|Use software color balance</p> 383</div> 384<hr> 385<div class="refsect2"> 386<a name="GstPlaySink--force-aspect-ratio"></a><h3>The <code class="literal">“force-aspect-ratio”</code> property</h3> 387<pre class="programlisting"> “force-aspect-ratio” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 388<p>When enabled, scaling will respect original aspect ratio.</p> 389<p>Flags: Read / Write</p> 390<p>Default value: TRUE</p> 391</div> 392<hr> 393<div class="refsect2"> 394<a name="GstPlaySink--mute"></a><h3>The <code class="literal">“mute”</code> property</h3> 395<pre class="programlisting"> “mute” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 396<p>Mute the audio channel without changing the volume.</p> 397<p>Flags: Read / Write</p> 398<p>Default value: FALSE</p> 399</div> 400<hr> 401<div class="refsect2"> 402<a name="GstPlaySink--sample"></a><h3>The <code class="literal">“sample”</code> property</h3> 403<pre class="programlisting"> “sample” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSample.html#GstSample-struct"><span class="type">GstSample</span></a> *</pre> 404<p>Get the currently rendered or prerolled sample in the video sink. 405The <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> in the sample will describe the format of the buffer.</p> 406<p>Flags: Read</p> 407</div> 408<hr> 409<div class="refsect2"> 410<a name="GstPlaySink--send-event-mode"></a><h3>The <code class="literal">“send-event-mode”</code> property</h3> 411<pre class="programlisting"> “send-event-mode” <span class="type">GstPlaySinkSendEventMode</span></pre> 412<p>How to send events received in send_event function.</p> 413<p>Flags: Read / Write</p> 414<p>Default value: Default GstBin's send_event handling (default)</p> 415</div> 416<hr> 417<div class="refsect2"> 418<a name="GstPlaySink--subtitle-encoding"></a><h3>The <code class="literal">“subtitle-encoding”</code> property</h3> 419<pre class="programlisting"> “subtitle-encoding” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 420<p>Encoding to assume if input subtitles are not in UTF-8 encoding. If not set, the GST_SUBTITLE_ENCODING environment variable will be checked for an encoding to use. If that is not set either, ISO-8859-15 will be assumed.</p> 421<p>Flags: Read / Write</p> 422<p>Default value: NULL</p> 423</div> 424<hr> 425<div class="refsect2"> 426<a name="GstPlaySink--subtitle-font-desc"></a><h3>The <code class="literal">“subtitle-font-desc”</code> property</h3> 427<pre class="programlisting"> “subtitle-font-desc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 428<p>Pango font description of font to be used for subtitle rendering.</p> 429<p>Flags: Write</p> 430<p>Default value: NULL</p> 431</div> 432<hr> 433<div class="refsect2"> 434<a name="GstPlaySink--text-sink"></a><h3>The <code class="literal">“text-sink”</code> property</h3> 435<pre class="programlisting"> “text-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 436<p>Set the used text sink element. NULL will use the default sink. playsink 437must be in <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GST-STATE-NULL:CAPS"><code class="literal">GST_STATE_NULL</code></a></p> 438<p>Flags: Read / Write</p> 439</div> 440<hr> 441<div class="refsect2"> 442<a name="GstPlaySink--video-sink"></a><h3>The <code class="literal">“video-sink”</code> property</h3> 443<pre class="programlisting"> “video-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 444<p>Set the used video sink element. NULL will use the default sink. playsink 445must be in <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GST-STATE-NULL:CAPS"><code class="literal">GST_STATE_NULL</code></a></p> 446<p>Flags: Read / Write</p> 447</div> 448<hr> 449<div class="refsect2"> 450<a name="GstPlaySink--vis-plugin"></a><h3>The <code class="literal">“vis-plugin”</code> property</h3> 451<pre class="programlisting"> “vis-plugin” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 452<p>the visualization element to use (NULL = default).</p> 453<p>Flags: Read / Write</p> 454</div> 455<hr> 456<div class="refsect2"> 457<a name="GstPlaySink--volume"></a><h3>The <code class="literal">“volume”</code> property</h3> 458<pre class="programlisting"> “volume” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 459<p>Get or set the current audio stream volume. 1.0 means 100%, 4600.0 means mute. This uses a linear volume scale.</p> 461<p>Flags: Read / Write</p> 462<p>Allowed values: [0,10]</p> 463<p>Default value: 1</p> 464</div> 465<hr> 466<div class="refsect2"> 467<a name="GstPlaySink--audio-filter"></a><h3>The <code class="literal">“audio-filter”</code> property</h3> 468<pre class="programlisting"> “audio-filter” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 469<p>Set the audio filter element/bin to use. Will apply on a best-effort basis 470unless GST_PLAY_FLAG_FORCE_FILTERS is set. playsink must be in 471<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GST-STATE-NULL:CAPS"><code class="literal">GST_STATE_NULL</code></a></p> 472<p>Flags: Read / Write</p> 473</div> 474<hr> 475<div class="refsect2"> 476<a name="GstPlaySink--video-filter"></a><h3>The <code class="literal">“video-filter”</code> property</h3> 477<pre class="programlisting"> “video-filter” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre> 478<p>Set the video filter element/bin to use. Will apply on a best-effort basis 479unless GST_PLAY_FLAG_FORCE_FILTERS is set. playsink must be in 480<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GST-STATE-NULL:CAPS"><code class="literal">GST_STATE_NULL</code></a></p> 481<p>Flags: Read / Write</p> 482</div> 483<hr> 484<div class="refsect2"> 485<a name="GstPlaySink--text-offset"></a><h3>The <code class="literal">“text-offset”</code> property</h3> 486<pre class="programlisting"> “text-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> 487<p>Control the synchronisation offset between the text and video streams. 488Positive values make the text ahead of the video and negative values make 489the text go behind the video.</p> 490<p>Flags: Read / Write</p> 491<p>Default value: 0</p> 492</div> 493</div> 494<div class="refsect1"> 495<a name="gst-plugins-base-plugins-playsink.signal-details"></a><h2>Signal Details</h2> 496<div class="refsect2"> 497<a name="GstPlaySink-convert-sample"></a><h3>The <code class="literal">“convert-sample”</code> signal</h3> 498<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSample.html#GstSample-struct"><span class="returnvalue">GstSample</span></a>* 499user_function (<a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink"><span class="type">GstPlaySink</span></a> *playsink, 500 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *caps, 501 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 502<p>Action signal to retrieve the currently playing video sample in the format 503specified by <em class="parameter"><code>caps</code></em> 504. 505If <em class="parameter"><code>caps</code></em> 506 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, no conversion will be performed and this function is 507equivalent to the <span class="type">“sample”</span> property.</p> 508<div class="refsect3"> 509<a name="GstPlaySink-convert-sample.parameters"></a><h4>Parameters</h4> 510<div class="informaltable"><table class="informaltable" width="100%" border="0"> 511<colgroup> 512<col width="150px" class="parameters_name"> 513<col class="parameters_description"> 514<col width="200px" class="parameters_annotations"> 515</colgroup> 516<tbody> 517<tr> 518<td class="parameter_name"><p>playsink</p></td> 519<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink"><span class="type">GstPlaySink</span></a></p></td> 520<td class="parameter_annotations"> </td> 521</tr> 522<tr> 523<td class="parameter_name"><p>caps</p></td> 524<td class="parameter_description"><p>the target format of the sample</p></td> 525<td class="parameter_annotations"> </td> 526</tr> 527<tr> 528<td class="parameter_name"><p>user_data</p></td> 529<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> 530<td class="parameter_annotations"> </td> 531</tr> 532</tbody> 533</table></div> 534</div> 535<div class="refsect3"> 536<a name="GstPlaySink-convert-sample.returns"></a><h4>Returns</h4> 537<p> a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstSample.html#GstSample-struct"><span class="type">GstSample</span></a> of the current video sample converted to <span class="type">caps</span>. 538The caps in the sample will describe the final layout of the buffer data. 539<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned when no current sample can be retrieved or when the 540conversion failed.</p> 541</div> 542<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 543</div> 544<hr> 545<div class="refsect2"> 546<a name="GstPlaySink-reconfigure"></a><h3>The <code class="literal">“reconfigure”</code> signal</h3> 547<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 548user_function (<a class="link" href="gst-plugins-base-plugins-playsink.html#GstPlaySink"><span class="type">GstPlaySink</span></a> *gstplaysink, 549 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 550<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p> 551</div> 552</div> 553</div> 554<div class="footer"> 555<hr>Generated by GTK-Doc V1.28</div> 556</body> 557</html>
