<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>clockoverlay</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-cdparanoiasrc.html" title="cdparanoiasrc">
<link rel="next" href="gst-plugins-base-plugins-ffmpegcolorspace.html" title="ffmpegcolorspace">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-base Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-base Plugins">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-base-plugins-cdparanoiasrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-base-plugins-ffmpegcolorspace.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2593562" class="shortcut">Top</a>
 | 
<a href="#id2593487" class="shortcut">Description</a>
 | 
<a href="#id2593521" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-plugins-clockoverlay"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2593562"></a><span class="refentrytitle">clockoverlay</span>
</h2>
<p>clockoverlay — Overlays the current clock time on a video stream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstClockOverlay"></a><pre class="synopsis">
<a href="gst-plugins-base-plugins-clockoverlay.html#GstClockOverlay-struct">GstClockOverlay</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2593521"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstElement
+----<a href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay">GstTextOverlay</a>
+----GstClockOverlay
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2593487"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id2598474"></a><p>
This element overlays the current clock time on top of a video
stream. You can position the text and configure the font details
using the properties of the <a href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a> class. By default, the
time is displayed in the top left corner of the picture, with some
padding to the left and to the top.
</p>
<p>
Here is a simple pipeline that displays the current time in the top left
corner of the video picture:
</p>
<pre class="programlisting">
gst-launch -v videotestsrc ! clockoverlay ! xvimagesink
</pre>
<p>
</p>
<p>
Here is another pipeline that displays the current time with some leading
text in the bottom right corner of the video picture, with the background
of the text being shaded in order to make it more legible on top of a
bright video background:
</p>
<pre class="programlisting">
gst-launch -v videotestsrc ! clockoverlay halign=right valign=bottom text="Edge City" shaded-background=true ! ffmpegcolorspace ! ximagesink
</pre>
<p>
</p>
</div>
<div class="refsect2" lang="en">
<a name="id2588136"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">plugin</span></td>
<td>
<a href="gst-plugins-base-plugins-plugin-pango.html#plugin-pango">pango</a>
</td>
</tr>
<tr>
<td><span class="term">author</span></td>
<td>Tim-Philipp Müller <tim@centricular.net></td>
</tr>
<tr>
<td><span class="term">class</span></td>
<td>Filter/Editor/Video</td>
</tr>
</tbody>
</table></div>
<h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>src</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>source</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term">name</span></td>
<td>video_sink</td>
</tr>
<tr>
<td><span class="term">direction</span></td>
<td>sink</td>
</tr>
<tr>
<td><span class="term">presence</span></td>
<td>always</td>
</tr>
<tr>
<td><span class="term">details</span></td>
<td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2600724"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2600734"></a><h3>
<a name="GstClockOverlay-struct"></a>GstClockOverlay</h3>
<a class="indexterm" name="id2600746"></a><pre class="programlisting">typedef struct _GstClockOverlay GstClockOverlay;</pre>
<p>
Opaque clockoverlay data structure.</p>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2600767"></a><h2>See Also</h2>
<a href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a>, <a href="gst-plugins-base-plugins-timeoverlay.html#GstTimeOverlay"><span class="type">GstTimeOverlay</span></a>
</div>
</div>
</body>
</html>
