~ubuntu-branches/ubuntu/precise/gst-plugins-bad0.10/precise-proposed

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-fpsdisplaysink.html

Tags: upstream-0.10.17.2
Import upstream version 0.10.17.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>fpsdisplaysink</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
 
<link rel="prev" href="gst-plugins-bad-plugins-festival.html" title="festival">
 
9
<link rel="prev" href="gst-plugins-bad-plugins-flacparse.html" title="flacparse">
10
10
<link rel="next" href="gst-plugins-bad-plugins-input-selector.html" title="input-selector">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
14
14
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
17
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
19
19
<tr valign="middle">
20
 
<td><a accesskey="p" href="gst-plugins-bad-plugins-festival.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
20
<td><a accesskey="p" href="gst-plugins-bad-plugins-flacparse.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21
21
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23
23
<th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th>
25
25
</tr>
26
26
<tr><td colspan="5" class="shortcuts">
27
27
<a href="#gst-plugins-bad-plugins-fpsdisplaysink.synopsis" class="shortcut">Top</a>
28
 
                 | 
29
 
                <a href="#gst-plugins-bad-plugins-fpsdisplaysink.description" class="shortcut">Description</a>
30
 
                 | 
31
 
                <a href="#gst-plugins-bad-plugins-fpsdisplaysink.object-hierarchy" class="shortcut">Object Hierarchy</a>
32
 
                 | 
33
 
                <a href="#gst-plugins-bad-plugins-fpsdisplaysink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
34
 
                 | 
35
 
                <a href="#gst-plugins-bad-plugins-fpsdisplaysink.properties" class="shortcut">Properties</a>
 
28
                   | 
 
29
                  <a href="#gst-plugins-bad-plugins-fpsdisplaysink.description" class="shortcut">Description</a>
 
30
                   | 
 
31
                  <a href="#gst-plugins-bad-plugins-fpsdisplaysink.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
32
                   | 
 
33
                  <a href="#gst-plugins-bad-plugins-fpsdisplaysink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
34
                   | 
 
35
                  <a href="#gst-plugins-bad-plugins-fpsdisplaysink.properties" class="shortcut">Properties</a>
36
36
</td></tr>
37
37
</table>
38
38
<div class="refentry" title="fpsdisplaysink">
46
46
</tr></table></div>
47
47
<div class="refsynopsisdiv" title="Synopsis">
48
48
<a name="gst-plugins-bad-plugins-fpsdisplaysink.synopsis"></a><h2>Synopsis</h2>
49
 
<a name="GstFPSDisplaySink"></a><pre class="synopsis">
50
 
                    <a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink-struct" title="GstFPSDisplaySink">GstFPSDisplaySink</a>;
 
49
<a name="GstFPSDisplaySink"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink-struct" title="GstFPSDisplaySink">GstFPSDisplaySink</a>;
51
50
</pre>
52
51
</div>
53
52
<div class="refsect1" title="Object Hierarchy">
54
53
<a name="gst-plugins-bad-plugins-fpsdisplaysink.object-hierarchy"></a><h2>Object Hierarchy</h2>
55
54
<pre class="synopsis">
56
 
  <a
57
 
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
58
 
>GObject</a>
59
 
   +----<a
60
 
href="../gstreamer-0.10/GstObject.html"
61
 
>GstObject</a>
62
 
         +----<a
63
 
href="../gstreamer-0.10/GstElement.html"
64
 
>GstElement</a>
65
 
               +----<a
66
 
href="../gstreamer-0.10/GstBin.html"
67
 
>GstBin</a>
 
55
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
56
   +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstObject.html">GstObject</a>
 
57
         +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html">GstElement</a>
 
58
               +----<a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstBin.html">GstBin</a>
68
59
                     +----GstFPSDisplaySink
69
60
</pre>
70
61
</div>
72
63
<a name="gst-plugins-bad-plugins-fpsdisplaysink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
73
64
<p>
74
65
GstFPSDisplaySink implements
75
 
 <a
76
 
href="../gstreamer-0.10/GstChildProxy.html"
77
 
>GstChildProxy</a>.</p>
 
66
 <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstChildProxy.html">GstChildProxy</a>.</p>
78
67
</div>
79
68
<div class="refsect1" title="Properties">
80
69
<a name="gst-plugins-bad-plugins-fpsdisplaysink.properties"></a><h2>Properties</h2>
81
70
<pre class="synopsis">
82
 
  "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--sync" title='The "sync" property'>sync</a>"                     <a
83
 
href="../glib/glib-Basic-Types.html#gboolean"
84
 
>gboolean</a>              : Read / Write
85
 
  "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--text-overlay" title='The "text-overlay" property'>text-overlay</a>"             <a
86
 
href="../glib/glib-Basic-Types.html#gboolean"
87
 
>gboolean</a>              : Read / Write
 
71
  "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--sync" title='The "sync" property'>sync</a>"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
72
  "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--text-overlay" title='The "text-overlay" property'>text-overlay</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
73
  "<a class="link" href="gst-plugins-bad-plugins-fpsdisplaysink.html#GstFPSDisplaySink--video-sink" title='The "video-sink" property'>video-sink</a>"               <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a>*           : Read / Write
88
74
</pre>
89
75
</div>
90
76
<div class="refsect1" title="Description">
95
81
<p>
96
82
</p>
97
83
<div class="refsect2" title="Example launch lines">
98
 
<a name="id3138926"></a><h3>Example launch lines</h3>
99
 
<div class="informalexample"><pre class="programlisting">
100
 
gst-launch videotestsrc ! fpsdisplaysink
101
 
gst-launch videotestsrc ! fpsdisplaysink text-overlay=false
102
 
gst-launch filesrc location=video.avi ! decodebin2 name=d ! queue ! fpsdisplaysink d. ! queue ! fakesink sync=true
103
 
</pre></div>
104
 
</div>
105
 
<div class="refsynopsisdiv" title="Synopsis">
106
 
<h2>Synopsis</h2>
107
 
<div class="refsect2" title="Element Information">
108
 
<a name="id3138951"></a><h3>Element Information</h3>
109
 
<div class="variablelist"><table border="0">
110
 
<col align="left" valign="top">
111
 
<tbody>
112
 
<tr>
113
 
<td><p><span class="term">plugin</span></p></td>
114
 
<td>
115
 
            <a class="link" href="gst-plugins-bad-plugins-plugin-debugutilsbad.html#plugin-debugutilsbad">debugutilsbad</a>
116
 
          </td>
117
 
</tr>
118
 
<tr>
119
 
<td><p><span class="term">author</span></p></td>
120
 
<td>Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;, Stefan Kost &lt;stefan.kost@nokia.com&gt;</td>
121
 
</tr>
122
 
<tr>
123
 
<td><p><span class="term">class</span></p></td>
124
 
<td>Sink/Video</td>
125
 
</tr>
126
 
</tbody>
127
 
</table></div>
128
 
</div>
129
 
<hr>
130
 
<div class="refsect2" title="Element Pads">
131
 
<a name="id3139014"></a><h3>Element Pads</h3>
132
 
<div class="variablelist"><table border="0">
133
 
<col align="left" valign="top">
134
 
<tbody>
135
 
<tr>
136
 
<td><p><span class="term">name</span></p></td>
137
 
<td>sink</td>
138
 
</tr>
139
 
<tr>
140
 
<td><p><span class="term">direction</span></p></td>
141
 
<td>sink</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><span class="term">presence</span></p></td>
145
 
<td>always</td>
146
 
</tr>
147
 
<tr>
148
 
<td><p><span class="term">details</span></p></td>
149
 
<td>ANY</td>
150
 
</tr>
151
 
</tbody>
152
 
</table></div>
153
 
</div>
154
 
</div>
155
 
<p>
156
 
</p>
 
84
<a name="id407853"></a><h3>Example launch lines</h3>
 
85
<div class="informalexample">
 
86
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
87
    <tbody>
 
88
      <tr>
 
89
        <td class="listing_lines" align="right"><pre>1
 
90
2
 
91
3</pre></td>
 
92
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch videotestsrc <span class="symbol">!</span> fpsdisplaysink
 
93
gst<span class="symbol">-</span>launch videotestsrc <span class="symbol">!</span> fpsdisplaysink text<span class="symbol">-</span>overlay<span class="symbol">=</span><span class="keyword">false</span>
 
94
gst<span class="symbol">-</span>launch filesrc location<span class="symbol">=</span>video<span class="symbol">.</span>avi <span class="symbol">!</span> decodebin2 name<span class="symbol">=</span>d <span class="symbol">!</span> queue <span class="symbol">!</span> fpsdisplaysink d<span class="symbol">. !</span> queue <span class="symbol">!</span> fakesink sync<span class="symbol">=</span><span class="keyword">true</span></pre></td>
 
95
      </tr>
 
96
    </tbody>
 
97
  </table>
 
98
</div>
 
99
 
 
100
</div>
157
101
</div>
158
102
<div class="refsect1" title="Details">
159
103
<a name="gst-plugins-bad-plugins-fpsdisplaysink.details"></a><h2>Details</h2>
168
112
<a name="gst-plugins-bad-plugins-fpsdisplaysink.property-details"></a><h2>Property Details</h2>
169
113
<div class="refsect2" title='The "sync" property'>
170
114
<a name="GstFPSDisplaySink--sync"></a><h3>The <code class="literal">"sync"</code> property</h3>
171
 
<pre class="programlisting">  "sync"                     <a
172
 
href="../glib/glib-Basic-Types.html#gboolean"
173
 
>gboolean</a>              : Read / Write</pre>
174
 
<p>Sync on the clock.</p>
 
115
<pre class="programlisting">  "sync"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
116
<p>Sync on the clock (if the internally used sink doesn't have this property it will be ignored.</p>
175
117
<p>Default value: TRUE</p>
176
118
</div>
177
119
<hr>
178
120
<div class="refsect2" title='The "text-overlay" property'>
179
121
<a name="GstFPSDisplaySink--text-overlay"></a><h3>The <code class="literal">"text-overlay"</code> property</h3>
180
 
<pre class="programlisting">  "text-overlay"             <a
181
 
href="../glib/glib-Basic-Types.html#gboolean"
182
 
>gboolean</a>              : Read / Write</pre>
183
 
<p>Wether to use text-overlay.</p>
 
122
<pre class="programlisting">  "text-overlay"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
123
<p>Whether to use text-overlay.</p>
184
124
<p>Default value: TRUE</p>
185
125
</div>
 
126
<hr>
 
127
<div class="refsect2" title='The "video-sink" property'>
 
128
<a name="GstFPSDisplaySink--video-sink"></a><h3>The <code class="literal">"video-sink"</code> property</h3>
 
129
<pre class="programlisting">  "video-sink"               <a href="/usr/share/gtk-doc/html/gstreamer-0.10/GstElement.html"><span class="type">GstElement</span></a>*           : Read / Write</pre>
 
130
<p>Video sink to use (Must only be called on NULL state).</p>
 
131
</div>
186
132
</div>
187
133
</div>
188
134
<div class="footer">
189
135
<hr>
190
 
          Generated by GTK-Doc V1.11</div>
 
136
          Generated by GTK-Doc V1.13</div>
191
137
</body>
192
 
</html>
 
138
</html>
 
 
b'\\ No newline at end of file'