<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>textrender</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-textoverlay.html" title="textoverlay">
<link rel="next" href="gst-plugins-base-plugins-timeoverlay.html" title="timeoverlay">
<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-textoverlay.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-timeoverlay.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="#id2606143" class="shortcut">Top</a>
 | 
<a href="#id2567447" class="shortcut">Description</a>
 | 
<a href="#id2606102" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2563715" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gst-plugins-base-plugins-textrender"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2606143"></a><span class="refentrytitle">textrender</span>
</h2>
<p>textrender — Renders a text string to an image bitmap</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GstTextRender"></a><pre class="synopsis">
<a href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct">GstTextRender</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2606102"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GstObject
+----GstElement
+----GstTextRender
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2563715"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gst-plugins-base-plugins-textrender.html#GstTextRender--font-desc">font-desc</a>" gchar* : Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2567447"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" lang="en">
<a name="id2564818"></a><p>
This plugin renders text received on the text sink pad to a video
buffer (retaining the alpha channel), so it can later be overlayed
on top of video streams using other elements.
</p>
<p>
The text can contain newline characters. (FIXME: What about text
wrapping? It does not make sense in this context)
</p>
<p>
Example pipeline:
</p>
<pre class="programlisting">
gst-launch -v filesrc location=subtitles.srt ! subparse ! textrender ! xvimagesink
</pre>
<p>
</p>
</div>
<div class="refsect2" lang="en">
<a name="id2578504"></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>David Schleef <ds@schleef.org>, Ronald S. Bultje <rbultje@ronald.bitfreak.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)AYUV, 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>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>text/x-pango-markup; text/plain</td>
</tr>
</tbody>
</table></div>
</div>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2572879"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2572890"></a><h3>
<a name="GstTextRender-struct"></a>GstTextRender</h3>
<a class="indexterm" name="id2572901"></a><pre class="programlisting">typedef struct _GstTextRender GstTextRender;</pre>
<p>
Opaque textrender data structure.</p>
<p>
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2572922"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2613154"></a><h3>
<a name="GstTextRender--font-desc"></a>The "<code class="literal">font-desc</code>" property</h3>
<a class="indexterm" name="id2613168"></a><pre class="programlisting"> "font-desc" gchar* : Write</pre>
<p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2613196"></a><h2>See Also</h2>
<a href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay"><span class="type">GstTextOverlay</span></a>
</div>
</div>
</body>
</html>
