← Back to branch summary

~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-base-plugins-textoverlay.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-base-plugins-textoverlay.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>textoverlay</title>
 
5
<title>GStreamer Base Plugins 1.0 Plugins Reference Manual: textoverlay</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9
9
<link rel="prev" href="gst-plugins-base-plugins-tcpserversink.html" title="tcpserversink">
10
10
<link rel="next" href="gst-plugins-base-plugins-textrender.html" title="textrender">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
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-base-plugins-tcpserversink.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 Base Plugins 1.0 Plugins Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-plugins-textrender.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-base-plugins-textoverlay.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-plugins-textoverlay.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#gst-plugins-base-plugins-textoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#gst-plugins-base-plugins-textoverlay.properties" class="shortcut">Properties</a>
31
 
</td></tr>
32
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><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-textoverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-plugins-textoverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
 
20
                  <a href="#gst-plugins-base-plugins-textoverlay.properties" class="shortcut">Properties</a></span>
 
21
</td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
23
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="p" href="gst-plugins-base-plugins-tcpserversink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="n" href="gst-plugins-base-plugins-textrender.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
26
</tr></table>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-plugins-textoverlay"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-textoverlay.top_of_page"></a>textoverlay</span></h2>
38
32
<p>textoverlay — Adds text strings on top of a video buffer</p>
39
33
</td>
40
 
<td valign="top" align="right"></td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="gst-plugins-base-plugins-textoverlay.synopsis"></a><h2>Synopsis</h2>
44
 
<a name="GstTextOverlay"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay-struct" title="struct GstTextOverlay">GstTextOverlay</a>;
45
 
</pre>
 
36
<div class="refsect1">
 
37
<a name="gst-plugins-base-plugins-textoverlay.properties"></a><h2>Properties</h2>
 
38
<div class="informaltable"><table border="0">
 
39
<colgroup>
 
40
<col width="150px" class="properties_type">
 
41
<col width="300px" class="properties_name">
 
42
<col width="200px" class="properties_flags">
 
43
</colgroup>
 
44
<tbody>
 
45
<tr>
 
46
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
47
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltax" title="The “deltax” property">deltax</a></td>
 
48
<td class="property_flags">Read / Write</td>
 
49
</tr>
 
50
<tr>
 
51
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
52
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltay" title="The “deltay” property">deltay</a></td>
 
53
<td class="property_flags">Read / Write</td>
 
54
</tr>
 
55
<tr>
 
56
<td class="property_type">
 
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
58
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--font-desc" title="The “font-desc” property">font-desc</a></td>
 
59
<td class="property_flags">Write</td>
 
60
</tr>
 
61
<tr>
 
62
<td class="property_type">
 
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
64
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halign" title="The “halign” property">halign</a></td>
 
65
<td class="property_flags">Write</td>
 
66
</tr>
 
67
<tr>
 
68
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
69
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--shaded-background" title="The “shaded-background” property">shaded-background</a></td>
 
70
<td class="property_flags">Read / Write</td>
 
71
</tr>
 
72
<tr>
 
73
<td class="property_type">
 
74
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
75
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--text" title="The “text” property">text</a></td>
 
76
<td class="property_flags">Read / Write</td>
 
77
</tr>
 
78
<tr>
 
79
<td class="property_type">
 
80
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
81
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valign" title="The “valign” property">valign</a></td>
 
82
<td class="property_flags">Write</td>
 
83
</tr>
 
84
<tr>
 
85
<td class="property_type"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a></td>
 
86
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wrap-mode" title="The “wrap-mode” property">wrap-mode</a></td>
 
87
<td class="property_flags">Read / Write</td>
 
88
</tr>
 
89
<tr>
 
90
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
91
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpad" title="The “xpad” property">xpad</a></td>
 
92
<td class="property_flags">Read / Write</td>
 
93
</tr>
 
94
<tr>
 
95
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
96
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypad" title="The “ypad” property">ypad</a></td>
 
97
<td class="property_flags">Read / Write</td>
 
98
</tr>
 
99
<tr>
 
100
<td class="property_type"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a></td>
 
101
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halignment" title="The “halignment” property">halignment</a></td>
 
102
<td class="property_flags">Read / Write</td>
 
103
</tr>
 
104
<tr>
 
105
<td class="property_type"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a></td>
 
106
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valignment" title="The “valignment” property">valignment</a></td>
 
107
<td class="property_flags">Read / Write</td>
 
108
</tr>
 
109
<tr>
 
110
<td class="property_type"><span class="type">GstTextOverlayLineAlign</span></td>
 
111
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--line-alignment" title="The “line-alignment” property">line-alignment</a></td>
 
112
<td class="property_flags">Read / Write</td>
 
113
</tr>
 
114
<tr>
 
115
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
116
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--silent" title="The “silent” property">silent</a></td>
 
117
<td class="property_flags">Read / Write</td>
 
118
</tr>
 
119
<tr>
 
120
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
121
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wait-text" title="The “wait-text” property">wait-text</a></td>
 
122
<td class="property_flags">Read / Write</td>
 
123
</tr>
 
124
<tr>
 
125
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
126
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--auto-resize" title="The “auto-resize” property">auto-resize</a></td>
 
127
<td class="property_flags">Read / Write</td>
 
128
</tr>
 
129
<tr>
 
130
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
 
131
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--vertical-render" title="The “vertical-render” property">vertical-render</a></td>
 
132
<td class="property_flags">Read / Write</td>
 
133
</tr>
 
134
<tr>
 
135
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
 
136
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--color" title="The “color” property">color</a></td>
 
137
<td class="property_flags">Read / Write</td>
 
138
</tr>
 
139
<tr>
 
140
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
 
141
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpos" title="The “xpos” property">xpos</a></td>
 
142
<td class="property_flags">Read / Write</td>
 
143
</tr>
 
144
<tr>
 
145
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
 
146
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypos" title="The “ypos” property">ypos</a></td>
 
147
<td class="property_flags">Read / Write</td>
 
148
</tr>
 
149
</tbody>
 
150
</table></div>
 
151
</div>
 
152
<a name="GstTextOverlay"></a><div class="refsect1">
 
153
<a name="gst-plugins-base-plugins-textoverlay.other"></a><h2>Types and Values</h2>
 
154
<div class="informaltable"><table width="100%" border="0">
 
155
<colgroup>
 
156
<col width="150px" class="name">
 
157
<col class="description">
 
158
</colgroup>
 
159
<tbody><tr>
 
160
<td class="datatype_keyword">struct</td>
 
161
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay-struct" title="struct GstTextOverlay">GstTextOverlay</a></td>
 
162
</tr></tbody>
 
163
</table></div>
46
164
</div>
47
165
<div class="refsect1">
48
166
<a name="gst-plugins-base-plugins-textoverlay.object-hierarchy"></a><h2>Object Hierarchy</h2>
49
 
<pre class="synopsis">
50
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
52
 
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
53
 
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
54
 
                     +----GstBaseTextOverlay
55
 
                           +----GstTextOverlay
56
 
</pre>
57
 
</div>
58
 
<div class="refsect1">
59
 
<a name="gst-plugins-base-plugins-textoverlay.properties"></a><h2>Properties</h2>
60
 
<pre class="synopsis">
61
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltax" title='The "deltax" property'>deltax</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
62
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--deltay" title='The "deltay" property'>deltay</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-base-plugins-textoverlay.html#GstTextOverlay--font-desc" title='The "font-desc" property'>font-desc</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
64
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halign" title='The "halign" property'>halign</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
65
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--shaded-background" title='The "shaded-background" property'>shaded-background</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
66
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--text" title='The "text" property'>text</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
67
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valign" title='The "valign" property'>valign</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
68
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wrap-mode" title='The "wrap-mode" property'>wrap-mode</a>"                <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a>  : Read / Write
69
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpad" title='The "xpad" property'>xpad</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-base-plugins-textoverlay.html#GstTextOverlay--ypad" title='The "ypad" property'>ypad</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
71
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--halignment" title='The "halignment" property'>halignment</a>"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a>  : Read / Write
72
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--valignment" title='The "valignment" property'>valignment</a>"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a>  : Read / Write
73
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">GstTextOverlayLineAlign</span>  : Read / Write
74
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--silent" title='The "silent" property'>silent</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
75
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--wait-text" title='The "wait-text" property'>wait-text</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
76
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--auto-resize" title='The "auto-resize" property'>auto-resize</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
77
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--vertical-render" title='The "vertical-render" property'>vertical-render</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
78
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--color" title='The "color" property'>color</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
79
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--xpos" title='The "xpos" property'>xpos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
80
 
  "<a class="link" href="gst-plugins-base-plugins-textoverlay.html#GstTextOverlay--ypos" title='The "ypos" property'>ypos</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
167
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
168
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
169
        <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
 
170
            <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
 
171
                <span class="lineart">╰──</span> GstBaseTextOverlay
 
172
                    <span class="lineart">╰──</span> GstTextOverlay
81
173
</pre>
82
174
</div>
83
175
<div class="refsect1">
85
177
<div class="refsynopsisdiv">
86
178
<h2>Synopsis</h2>
87
179
<div class="refsect2">
88
 
<a name="id-1.2.30.6.2.1"></a><h3>Element Information</h3>
 
180
<a name="id-1.2.30.7.2.1"></a><h3>Element Information</h3>
89
181
<div class="variablelist"><table border="0" class="variablelist">
90
182
<colgroup>
91
183
<col align="left" valign="top">
111
203
</div>
112
204
<hr>
113
205
<div class="refsect2">
114
 
<a name="id-1.2.30.6.2.2"></a><h3>Element Pads</h3>
 
206
<a name="id-1.2.30.7.2.2"></a><h3>Element Pads</h3>
115
207
<div class="variablelist"><table border="0" class="variablelist">
116
208
<colgroup>
117
209
<col align="left" valign="top">
190
282
</p>
191
283
</div>
192
284
<div class="refsect1">
193
 
<a name="gst-plugins-base-plugins-textoverlay.details"></a><h2>Details</h2>
 
285
<a name="gst-plugins-base-plugins-textoverlay.functions_details"></a><h2>Functions</h2>
 
286
</div>
 
287
<div class="refsect1">
 
288
<a name="gst-plugins-base-plugins-textoverlay.other_details"></a><h2>Types and Values</h2>
194
289
<div class="refsect2">
195
290
<a name="GstTextOverlay-struct"></a><h3>struct GstTextOverlay</h3>
196
291
<pre class="programlisting">struct GstTextOverlay;</pre>
201
296
<div class="refsect1">
202
297
<a name="gst-plugins-base-plugins-textoverlay.property-details"></a><h2>Property Details</h2>
203
298
<div class="refsect2">
204
 
<a name="GstTextOverlay--deltax"></a><h3>The <code class="literal">"deltax"</code> property</h3>
205
 
<pre class="programlisting">  "deltax"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
299
<a name="GstTextOverlay--deltax"></a><h3>The <code class="literal">“deltax”</code> property</h3>
 
300
<pre class="programlisting">  “deltax”                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
206
301
<p>Shift X position to the left or to the right. Unit is pixels.</p>
 
302
<p>Flags: Read / Write</p>
207
303
<p>Default value: 0</p>
208
304
</div>
209
305
<hr>
210
306
<div class="refsect2">
211
 
<a name="GstTextOverlay--deltay"></a><h3>The <code class="literal">"deltay"</code> property</h3>
212
 
<pre class="programlisting">  "deltay"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
307
<a name="GstTextOverlay--deltay"></a><h3>The <code class="literal">“deltay”</code> property</h3>
 
308
<pre class="programlisting">  “deltay”                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
213
309
<p>Shift Y position up or down. Unit is pixels.</p>
 
310
<p>Flags: Read / Write</p>
214
311
<p>Default value: 0</p>
215
312
</div>
216
313
<hr>
217
314
<div class="refsect2">
218
 
<a name="GstTextOverlay--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
219
 
<pre class="programlisting">  "font-desc"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 
315
<a name="GstTextOverlay--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3>
 
316
<pre class="programlisting">  “font-desc”                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
220
317
<p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 
318
<p>Flags: Write</p>
221
319
<p>Default value: ""</p>
222
320
</div>
223
321
<hr>
224
322
<div class="refsect2">
225
 
<a name="GstTextOverlay--halign"></a><h3>The <code class="literal">"halign"</code> property</h3>
226
 
<pre class="programlisting">  "halign"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 
323
<a name="GstTextOverlay--halign"></a><h3>The <code class="literal">“halign”</code> property</h3>
 
324
<pre class="programlisting">  “halign”                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
227
325
<p>Horizontal alignment of the text (deprecated; use halignment).</p>
 
326
<p>Flags: Write</p>
228
327
<p>Default value: "center"</p>
229
328
</div>
230
329
<hr>
231
330
<div class="refsect2">
232
 
<a name="GstTextOverlay--shaded-background"></a><h3>The <code class="literal">"shaded-background"</code> property</h3>
233
 
<pre class="programlisting">  "shaded-background"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
331
<a name="GstTextOverlay--shaded-background"></a><h3>The <code class="literal">“shaded-background”</code> property</h3>
 
332
<pre class="programlisting">  “shaded-background”        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
234
333
<p>Whether to shade the background under the text area.</p>
 
334
<p>Flags: Read / Write</p>
235
335
<p>Default value: FALSE</p>
236
336
</div>
237
337
<hr>
238
338
<div class="refsect2">
239
 
<a name="GstTextOverlay--text"></a><h3>The <code class="literal">"text"</code> property</h3>
240
 
<pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
339
<a name="GstTextOverlay--text"></a><h3>The <code class="literal">“text”</code> property</h3>
 
340
<pre class="programlisting">  “text”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
241
341
<p>Text to be display.</p>
 
342
<p>Flags: Read / Write</p>
242
343
<p>Default value: ""</p>
243
344
</div>
244
345
<hr>
245
346
<div class="refsect2">
246
 
<a name="GstTextOverlay--valign"></a><h3>The <code class="literal">"valign"</code> property</h3>
247
 
<pre class="programlisting">  "valign"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 
347
<a name="GstTextOverlay--valign"></a><h3>The <code class="literal">“valign”</code> property</h3>
 
348
<pre class="programlisting">  “valign”                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
248
349
<p>Vertical alignment of the text (deprecated; use valignment).</p>
 
350
<p>Flags: Write</p>
249
351
<p>Default value: "baseline"</p>
250
352
</div>
251
353
<hr>
252
354
<div class="refsect2">
253
 
<a name="GstTextOverlay--wrap-mode"></a><h3>The <code class="literal">"wrap-mode"</code> property</h3>
254
 
<pre class="programlisting">  "wrap-mode"                <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a>  : Read / Write</pre>
 
355
<a name="GstTextOverlay--wrap-mode"></a><h3>The <code class="literal">“wrap-mode”</code> property</h3>
 
356
<pre class="programlisting">  “wrap-mode”                <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayWrapMode"><span class="type">GstTextOverlayWrapMode</span></a></pre>
255
357
<p>Whether to wrap the text and if so how.</p>
 
358
<p>Flags: Read / Write</p>
256
359
<p>Default value: wordchar</p>
257
360
</div>
258
361
<hr>
259
362
<div class="refsect2">
260
 
<a name="GstTextOverlay--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
261
 
<pre class="programlisting">  "xpad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
363
<a name="GstTextOverlay--xpad"></a><h3>The <code class="literal">“xpad”</code> property</h3>
 
364
<pre class="programlisting">  “xpad”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
262
365
<p>Horizontal paddding when using left/right alignment.</p>
 
366
<p>Flags: Read / Write</p>
263
367
<p>Allowed values: &gt;= 0</p>
264
368
<p>Default value: 25</p>
265
369
</div>
266
370
<hr>
267
371
<div class="refsect2">
268
 
<a name="GstTextOverlay--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
269
 
<pre class="programlisting">  "ypad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
372
<a name="GstTextOverlay--ypad"></a><h3>The <code class="literal">“ypad”</code> property</h3>
 
373
<pre class="programlisting">  “ypad”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
270
374
<p>Vertical padding when using top/bottom alignment.</p>
 
375
<p>Flags: Read / Write</p>
271
376
<p>Allowed values: &gt;= 0</p>
272
377
<p>Default value: 25</p>
273
378
</div>
274
379
<hr>
275
380
<div class="refsect2">
276
 
<a name="GstTextOverlay--halignment"></a><h3>The <code class="literal">"halignment"</code> property</h3>
277
 
<pre class="programlisting">  "halignment"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a>  : Read / Write</pre>
 
381
<a name="GstTextOverlay--halignment"></a><h3>The <code class="literal">“halignment”</code> property</h3>
 
382
<pre class="programlisting">  “halignment”               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayHAlign"><span class="type">GstTextOverlayHAlign</span></a></pre>
278
383
<p>Horizontal alignment of the text.</p>
 
384
<p>Flags: Read / Write</p>
279
385
<p>Default value: center</p>
280
386
</div>
281
387
<hr>
282
388
<div class="refsect2">
283
 
<a name="GstTextOverlay--valignment"></a><h3>The <code class="literal">"valignment"</code> property</h3>
284
 
<pre class="programlisting">  "valignment"               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a>  : Read / Write</pre>
 
389
<a name="GstTextOverlay--valignment"></a><h3>The <code class="literal">“valignment”</code> property</h3>
 
390
<pre class="programlisting">  “valignment”               <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/gst-plugins-base-plugins-textoverlay.html#GstTextOverlayVAlign"><span class="type">GstTextOverlayVAlign</span></a></pre>
285
391
<p>Vertical alignment of the text.</p>
 
392
<p>Flags: Read / Write</p>
286
393
<p>Default value: baseline</p>
287
394
</div>
288
395
<hr>
289
396
<div class="refsect2">
290
 
<a name="GstTextOverlay--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
291
 
<pre class="programlisting">  "line-alignment"           <span class="type">GstTextOverlayLineAlign</span>  : Read / Write</pre>
 
397
<a name="GstTextOverlay--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3>
 
398
<pre class="programlisting">  “line-alignment”           <span class="type">GstTextOverlayLineAlign</span></pre>
292
399
<p>Alignment of text lines relative to each other.</p>
 
400
<p>Flags: Read / Write</p>
293
401
<p>Default value: center</p>
294
402
</div>
295
403
<hr>
296
404
<div class="refsect2">
297
 
<a name="GstTextOverlay--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
298
 
<pre class="programlisting">  "silent"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
405
<a name="GstTextOverlay--silent"></a><h3>The <code class="literal">“silent”</code> property</h3>
 
406
<pre class="programlisting">  “silent”                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
299
407
<p>Whether to render the text string.</p>
 
408
<p>Flags: Read / Write</p>
300
409
<p>Default value: FALSE</p>
301
410
</div>
302
411
<hr>
303
412
<div class="refsect2">
304
 
<a name="GstTextOverlay--wait-text"></a><h3>The <code class="literal">"wait-text"</code> property</h3>
305
 
<pre class="programlisting">  "wait-text"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
413
<a name="GstTextOverlay--wait-text"></a><h3>The <code class="literal">“wait-text”</code> property</h3>
 
414
<pre class="programlisting">  “wait-text”                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
306
415
<p>Whether to wait for subtitles.</p>
 
416
<p>Flags: Read / Write</p>
307
417
<p>Default value: TRUE</p>
308
418
</div>
309
419
<hr>
310
420
<div class="refsect2">
311
 
<a name="GstTextOverlay--auto-resize"></a><h3>The <code class="literal">"auto-resize"</code> property</h3>
312
 
<pre class="programlisting">  "auto-resize"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
421
<a name="GstTextOverlay--auto-resize"></a><h3>The <code class="literal">“auto-resize”</code> property</h3>
 
422
<pre class="programlisting">  “auto-resize”              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
313
423
<p>Automatically adjust font size to screen-size.</p>
 
424
<p>Flags: Read / Write</p>
314
425
<p>Default value: TRUE</p>
315
426
</div>
316
427
<hr>
317
428
<div class="refsect2">
318
 
<a name="GstTextOverlay--vertical-render"></a><h3>The <code class="literal">"vertical-render"</code> property</h3>
319
 
<pre class="programlisting">  "vertical-render"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
429
<a name="GstTextOverlay--vertical-render"></a><h3>The <code class="literal">“vertical-render”</code> property</h3>
 
430
<pre class="programlisting">  “vertical-render”          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
320
431
<p>Vertical Render.</p>
 
432
<p>Flags: Read / Write</p>
321
433
<p>Default value: FALSE</p>
322
434
</div>
323
435
<hr>
324
436
<div class="refsect2">
325
 
<a name="GstTextOverlay--color"></a><h3>The <code class="literal">"color"</code> property</h3>
326
 
<pre class="programlisting">  "color"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
437
<a name="GstTextOverlay--color"></a><h3>The <code class="literal">“color”</code> property</h3>
 
438
<pre class="programlisting">  “color”                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
327
439
<p>Color to use for text (big-endian ARGB).</p>
 
440
<p>Flags: Read / Write</p>
328
441
<p>Default value: 4294967295</p>
329
442
</div>
330
443
<hr>
331
444
<div class="refsect2">
332
 
<a name="GstTextOverlay--xpos"></a><h3>The <code class="literal">"xpos"</code> property</h3>
333
 
<pre class="programlisting">  "xpos"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
445
<a name="GstTextOverlay--xpos"></a><h3>The <code class="literal">“xpos”</code> property</h3>
 
446
<pre class="programlisting">  “xpos”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
334
447
<p>Horizontal position when using position alignment.</p>
 
448
<p>Flags: Read / Write</p>
335
449
<p>Allowed values: [0,1]</p>
336
450
<p>Default value: 0.5</p>
337
451
</div>
338
452
<hr>
339
453
<div class="refsect2">
340
 
<a name="GstTextOverlay--ypos"></a><h3>The <code class="literal">"ypos"</code> property</h3>
341
 
<pre class="programlisting">  "ypos"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
454
<a name="GstTextOverlay--ypos"></a><h3>The <code class="literal">“ypos”</code> property</h3>
 
455
<pre class="programlisting">  “ypos”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
342
456
<p>Vertical position when using position alignment.</p>
 
457
<p>Flags: Read / Write</p>
343
458
<p>Allowed values: [0,1]</p>
344
459
<p>Default value: 0.5</p>
345
460
</div>
347
462
</div>
348
463
<div class="footer">
349
464
<hr>
350
 
          Generated by GTK-Doc V1.19</div>
 
465
          Generated by GTK-Doc V1.20</div>
351
466
</body>
352
467
</html>
 
 
b'\\ No newline at end of file'