~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-burn.html

  • Committer: Bazaar Package Importer
  • Author(s): Ken VanDine
  • Date: 2011-07-19 14:32:43 UTC
  • mfrom: (18.4.21 sid)
  • Revision ID: james.westby@ubuntu.com-20110719143243-p7pnkh45akfp0ihk
Tags: 0.10.22-2ubuntu1
* Rebased on debian unstable, remaining changes:
  - debian/gstreamer-plugins-bad.install
    * don't include dtmf, liveadder, rtpmux, autoconvert and shm, we include 
      them in -good

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9
9
<link rel="prev" href="gst-plugins-bad-plugins-bulge.html" title="bulge">
10
10
<link rel="next" href="gst-plugins-bad-plugins-camerabin.html" title="camerabin">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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">
30
30
                  <a href="#gst-plugins-bad-plugins-burn.properties" class="shortcut">Properties</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" title="burn">
 
33
<div class="refentry">
34
34
<a name="gst-plugins-bad-plugins-burn"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv" title="Synopsis">
 
42
<div class="refsynopsisdiv">
43
43
<a name="gst-plugins-bad-plugins-burn.synopsis"></a><h2>Synopsis</h2>
44
 
<a name="GstBurn"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn-struct" title="GstBurn">GstBurn</a>;
 
44
<a name="GstBurn"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn-struct" title="struct GstBurn">GstBurn</a>;
45
45
</pre>
46
46
</div>
47
 
<div class="refsect1" title="Object Hierarchy">
 
47
<div class="refsect1">
48
48
<a name="gst-plugins-bad-plugins-burn.object-hierarchy"></a><h2>Object Hierarchy</h2>
49
49
<pre class="synopsis">
50
50
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
55
55
                           +----GstBurn
56
56
</pre>
57
57
</div>
58
 
<div class="refsect1" title="Properties">
 
58
<div class="refsect1">
59
59
<a name="gst-plugins-bad-plugins-burn.properties"></a><h2>Properties</h2>
60
60
<pre class="synopsis">
61
61
  "<a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn--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
62
62
  "<a class="link" href="gst-plugins-bad-plugins-burn.html#GstBurn--adjustment" title='The "adjustment" property'>adjustment</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
63
63
</pre>
64
64
</div>
65
 
<div class="refsect1" title="Description">
 
65
<div class="refsect1">
66
66
<a name="gst-plugins-bad-plugins-burn.description"></a><h2>Description</h2>
67
67
<p>
68
68
Burn adjusts the colors of a video stream in realtime.
69
69
</p>
70
 
<div class="refsect2" title="Example launch line">
71
 
<a name="id592687"></a><h3>Example launch line</h3>
 
70
<p>
 
71
</p>
 
72
<div class="refsect2">
 
73
<a name="idp8087776"></a><h3>Example launch line</h3>
72
74
<div class="informalexample">
73
75
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
74
76
    <tbody>
75
77
      <tr>
76
78
        <td class="listing_lines" align="right"><pre>1</pre></td>
77
 
        <td class="listing_code"><pre class="programlisting">gst<span class="symbol">-</span>launch <span class="symbol">-</span>v videotestsrc <span class="symbol">!</span> burn <span class="symbol">!</span> ffmpegcolorspace <span class="symbol">!</span> autovideosink</pre></td>
 
79
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> burn <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> autovideosink</pre></td>
78
80
      </tr>
79
81
    </tbody>
80
82
  </table>
81
83
</div>
82
84
 This pipeline shows the effect of burn on a test stream
83
85
</div>
84
 
</div>
85
 
<div class="refsect1" title="Details">
 
86
<p>
 
87
</p>
 
88
<div class="refsynopsisdiv">
 
89
<h2>Synopsis</h2>
 
90
<div class="refsect2">
 
91
<a name="idp7775712"></a><h3>Element Information</h3>
 
92
<div class="variablelist"><table border="0">
 
93
<col align="left" valign="top">
 
94
<tbody>
 
95
<tr>
 
96
<td><p><span class="term">plugin</span></p></td>
 
97
<td>
 
98
            <a class="link" href="gst-plugins-bad-plugins-plugin-gaudieffects.html#plugin-gaudieffects">gaudieffects</a>
 
99
          </td>
 
100
</tr>
 
101
<tr>
 
102
<td><p><span class="term">author</span></p></td>
 
103
<td>Luis de Bethencourt &lt;luis@debethencourt.com&gt;</td>
 
104
</tr>
 
105
<tr>
 
106
<td><p><span class="term">class</span></p></td>
 
107
<td>Filter/Effect/Video</td>
 
108
</tr>
 
109
</tbody>
 
110
</table></div>
 
111
</div>
 
112
<hr>
 
113
<div class="refsect2">
 
114
<a name="idp6732048"></a><h3>Element Pads</h3>
 
115
<div class="variablelist"><table border="0">
 
116
<col align="left" valign="top">
 
117
<tbody>
 
118
<tr>
 
119
<td><p><span class="term">name</span></p></td>
 
120
<td>sink</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term">direction</span></p></td>
 
124
<td>sink</td>
 
125
</tr>
 
126
<tr>
 
127
<td><p><span class="term">presence</span></p></td>
 
128
<td>always</td>
 
129
</tr>
 
130
<tr>
 
131
<td><p><span class="term">details</span></p></td>
 
132
<td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
133
</tr>
 
134
<tr>
 
135
<td><p><span class="term"></span></p></td>
 
136
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
137
</tr>
 
138
</tbody>
 
139
</table></div>
 
140
<div class="variablelist"><table border="0">
 
141
<col align="left" valign="top">
 
142
<tbody>
 
143
<tr>
 
144
<td><p><span class="term">name</span></p></td>
 
145
<td>src</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><span class="term">direction</span></p></td>
 
149
<td>source</td>
 
150
</tr>
 
151
<tr>
 
152
<td><p><span class="term">presence</span></p></td>
 
153
<td>always</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term">details</span></p></td>
 
157
<td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"></span></p></td>
 
161
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
162
</tr>
 
163
</tbody>
 
164
</table></div>
 
165
</div>
 
166
</div>
 
167
<p>
 
168
</p>
 
169
</div>
 
170
<div class="refsect1">
86
171
<a name="gst-plugins-bad-plugins-burn.details"></a><h2>Details</h2>
87
 
<div class="refsect2" title="GstBurn">
88
 
<a name="GstBurn-struct"></a><h3>GstBurn</h3>
89
 
<pre class="programlisting">typedef struct _GstBurn GstBurn;</pre>
 
172
<div class="refsect2">
 
173
<a name="GstBurn-struct"></a><h3>struct GstBurn</h3>
 
174
<pre class="programlisting">struct GstBurn;</pre>
90
175
<p>
91
176
</p>
92
177
</div>
93
178
</div>
94
 
<div class="refsect1" title="Property Details">
 
179
<div class="refsect1">
95
180
<a name="gst-plugins-bad-plugins-burn.property-details"></a><h2>Property Details</h2>
96
 
<div class="refsect2" title='The "silent" property'>
 
181
<div class="refsect2">
97
182
<a name="GstBurn--silent"></a><h3>The <code class="literal">"silent"</code> property</h3>
98
183
<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>
99
184
<p>Produce verbose output ?.</p>
100
185
<p>Default value: FALSE</p>
101
186
</div>
102
187
<hr>
103
 
<div class="refsect2" title='The "adjustment" property'>
 
188
<div class="refsect2">
104
189
<a name="GstBurn--adjustment"></a><h3>The <code class="literal">"adjustment"</code> property</h3>
105
190
<pre class="programlisting">  "adjustment"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
106
191
<p>Adjustment parameter.</p>
111
196
</div>
112
197
<div class="footer">
113
198
<hr>
114
 
          Generated by GTK-Doc V1.15</div>
 
199
          Generated by GTK-Doc V1.17</div>
115
200
</body>
116
201
</html>
 
 
b'\\ No newline at end of file'