4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>gstcolorbalance</title>
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstcolorbalance</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 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-video.html" title="Video Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstvideosink.html" title="gstvideosink">
10
10
<link rel="next" href="gst-plugins-base-libs-gstcolorbalancechannel.html" title="gstcolorbalancechannel">
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">
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">
17
<td><a accesskey="p" href="gst-plugins-base-libs-gstvideosink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="gstreamer-video.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 Library Reference Manual</th>
21
<td><a accesskey="n" href="gst-plugins-base-libs-gstcolorbalancechannel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#gst-plugins-base-libs-gstcolorbalance.synopsis" class="shortcut">Top</a>
26
<a href="#gst-plugins-base-libs-gstcolorbalance.description" class="shortcut">Description</a>
28
<a href="#gst-plugins-base-libs-gstcolorbalance.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#gst-plugins-base-libs-gstcolorbalance.signals" class="shortcut">Signals</a>
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-libs-gstcolorbalance.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#gst-plugins-base-libs-gstcolorbalance.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
20
<a href="#gst-plugins-base-libs-gstcolorbalance.signals" class="shortcut">Signals</a></span>
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="gstreamer-video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
<td><a accesskey="p" href="gst-plugins-base-libs-gstvideosink.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="gst-plugins-base-libs-gstcolorbalancechannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-libs-gstcolorbalance"></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-libs-gstcolorbalance.top_of_page"></a>gstcolorbalance</span></h2>
38
32
<p>gstcolorbalance — Interface for adjusting color balance settings</p>
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-libs-gstcolorbalance.synopsis"></a><h2>Synopsis</h2>
44
<a name="GstColorBalance"></a><pre class="synopsis">
45
#include <gst/video/colorbalance.h>
47
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-struct" title="GstColorBalance">GstColorBalance</a>;
48
struct <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceInterface" title="struct GstColorBalanceInterface">GstColorBalanceInterface</a>;
49
enum <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType">GstColorBalanceType</a>;
50
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-list-channels" title="gst_color_balance_list_channels ()">gst_color_balance_list_channels</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-get-value" title="gst_color_balance_get_value ()">gst_color_balance_get_value</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
52
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-set-value" title="gst_color_balance_set_value ()">gst_color_balance_set_value</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
54
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
55
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-value-changed" title="gst_color_balance_value_changed ()">gst_color_balance_value_changed</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
57
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
58
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
59
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="returnvalue">GstColorBalanceType</span></a> <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-get-balance-type" title="gst_color_balance_get_balance_type ()">gst_color_balance_get_balance_type</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);
36
<div class="refsect1">
37
<a name="gst-plugins-base-libs-gstcolorbalance.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
47
<td class="function_name">
48
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-list-channels" title="gst_color_balance_list_channels ()">gst_color_balance_list_channels</a> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
55
<td class="function_name">
56
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-get-value" title="gst_color_balance_get_value ()">gst_color_balance_get_value</a> <span class="c_punctuation">()</span>
60
<td class="function_type">
61
<span class="returnvalue">void</span>
63
<td class="function_name">
64
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-set-value" title="gst_color_balance_set_value ()">gst_color_balance_set_value</a> <span class="c_punctuation">()</span>
68
<td class="function_type">
69
<span class="returnvalue">void</span>
71
<td class="function_name">
72
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-value-changed" title="gst_color_balance_value_changed ()">gst_color_balance_value_changed</a> <span class="c_punctuation">()</span>
76
<td class="function_type">
77
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="returnvalue">GstColorBalanceType</span></a>
79
<td class="function_name">
80
<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#gst-color-balance-get-balance-type" title="gst_color_balance_get_balance_type ()">gst_color_balance_get_balance_type</a> <span class="c_punctuation">()</span>
86
<div class="refsect1">
87
<a name="gst-plugins-base-libs-gstcolorbalance.signals"></a><h2>Signals</h2>
88
<div class="informaltable"><table border="0">
90
<col width="150px" class="signals_return">
91
<col width="300px" class="signals_name">
92
<col width="200px" class="signals_flags">
95
<td class="signal_type"><span class="returnvalue">void</span></td>
96
<td class="signal_name"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-value-changed" title="The “value-changed” signal">value-changed</a></td>
97
<td class="signal_flags">Run Last</td>
101
<a name="GstColorBalance"></a><div class="refsect1">
102
<a name="gst-plugins-base-libs-gstcolorbalance.other"></a><h2>Types and Values</h2>
103
<div class="informaltable"><table width="100%" border="0">
105
<col width="150px" class="name">
106
<col class="description">
110
<td class="datatype_keyword"> </td>
111
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-struct" title="GstColorBalance">GstColorBalance</a></td>
114
<td class="datatype_keyword">struct</td>
115
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceInterface" title="struct GstColorBalanceInterface">GstColorBalanceInterface</a></td>
118
<td class="datatype_keyword">enum</td>
119
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType">GstColorBalanceType</a></td>
62
124
<div class="refsect1">
63
125
<a name="gst-plugins-base-libs-gstcolorbalance.object-hierarchy"></a><h2>Object Hierarchy</h2>
64
<pre class="synopsis">
126
<pre class="screen"> GInterface
127
<span class="lineart">╰──</span> GstColorBalance
69
130
<div class="refsect1">
70
<a name="gst-plugins-base-libs-gstcolorbalance.signals"></a><h2>Signals</h2>
71
<pre class="synopsis">
72
"<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-value-changed" title='The "value-changed" signal'>value-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
131
<a name="gst-plugins-base-libs-gstcolorbalance.includes"></a><h2>Includes</h2>
132
<pre class="synopsis">#include <gst/video/colorbalance.h>
75
135
<div class="refsect1">
76
136
<a name="gst-plugins-base-libs-gstcolorbalance.description"></a><h2>Description</h2>
79
137
<div class="refsect2">
80
<a name="id-1.2.14.8.6.2.1"></a><p>
138
<a name="id-1.2.14.8.9.2"></a><p>
81
139
This interface is implemented by elements which can perform some color
82
140
balance operation on video frames they process. For example, modifying
83
141
the brightness, contrast, hue or saturation.
86
144
Example elements are 'xvimagesink' and 'colorbalance'
92
<div class="refsect1">
93
<a name="gst-plugins-base-libs-gstcolorbalance.details"></a><h2>Details</h2>
148
<div class="refsect1">
149
<a name="gst-plugins-base-libs-gstcolorbalance.functions_details"></a><h2>Functions</h2>
150
<div class="refsect2">
151
<a name="gst-color-balance-list-channels"></a><h3>gst_color_balance_list_channels ()</h3>
152
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
153
gst_color_balance_list_channels (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);</pre>
154
<p>Retrieve a list of the available channels.</p>
155
<div class="refsect3">
156
<a name="id-1.2.14.8.10.2.5"></a><h4>Parameters</h4>
157
<div class="informaltable"><table width="100%" border="0">
159
<col width="150px" class="parameters_name">
160
<col class="parameters_description">
161
<col width="200px" class="parameters_annotations">
164
<td class="parameter_name"><p>balance</p></td>
165
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</p></td>
166
<td class="parameter_annotations"> </td>
170
<div class="refsect3">
171
<a name="id-1.2.14.8.10.2.6"></a><h4>Returns</h4>
172
<p> A GList containing pointers to <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> objects.
173
The list is owned by the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance and must not
179
<div class="refsect2">
180
<a name="gst-color-balance-get-value"></a><h3>gst_color_balance_get_value ()</h3>
181
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
182
gst_color_balance_get_value (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
183
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>);</pre>
184
<p>Retrieve the current value of the indicated channel, between min_value
186
<p>See Also: The <span class="type">GstColorBalanceChannel.min_value</span> and
187
<span class="type">GstColorBalanceChannel.max_value</span> members of the
188
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> object.</p>
189
<div class="refsect3">
190
<a name="id-1.2.14.8.10.3.6"></a><h4>Parameters</h4>
191
<div class="informaltable"><table width="100%" border="0">
193
<col width="150px" class="parameters_name">
194
<col class="parameters_description">
195
<col width="200px" class="parameters_annotations">
199
<td class="parameter_name"><p>balance</p></td>
200
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</p></td>
201
<td class="parameter_annotations"> </td>
204
<td class="parameter_name"><p>channel</p></td>
205
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> instance</p></td>
206
<td class="parameter_annotations"> </td>
211
<div class="refsect3">
212
<a name="id-1.2.14.8.10.3.7"></a><h4>Returns</h4>
213
<p> The current value of the channel.</p>
218
<div class="refsect2">
219
<a name="gst-color-balance-set-value"></a><h3>gst_color_balance_set_value ()</h3>
220
<pre class="programlisting"><span class="returnvalue">void</span>
221
gst_color_balance_set_value (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
222
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
223
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
224
<p>Sets the current value of the channel to the passed value, which must
225
be between min_value and max_value.</p>
226
<p>See Also: The <span class="type">GstColorBalanceChannel.min_value</span> and
227
<span class="type">GstColorBalanceChannel.max_value</span> members of the
228
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> object.</p>
229
<div class="refsect3">
230
<a name="id-1.2.14.8.10.4.6"></a><h4>Parameters</h4>
231
<div class="informaltable"><table width="100%" border="0">
233
<col width="150px" class="parameters_name">
234
<col class="parameters_description">
235
<col width="200px" class="parameters_annotations">
239
<td class="parameter_name"><p>balance</p></td>
240
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</p></td>
241
<td class="parameter_annotations"> </td>
244
<td class="parameter_name"><p>channel</p></td>
245
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> instance</p></td>
246
<td class="parameter_annotations"> </td>
249
<td class="parameter_name"><p>value</p></td>
250
<td class="parameter_description"><p>The new value for the channel.</p></td>
251
<td class="parameter_annotations"> </td>
258
<div class="refsect2">
259
<a name="gst-color-balance-value-changed"></a><h3>gst_color_balance_value_changed ()</h3>
260
<pre class="programlisting"><span class="returnvalue">void</span>
261
gst_color_balance_value_changed (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
262
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
263
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
264
<p>A helper function called by implementations of the GstColorBalance
265
interface. It fires the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-value-changed" title="The “value-changed” signal"><span class="type">“value-changed”</span></a> signal on the
266
instance, and the <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel-value-changed" title="The “value-changed” signal"><span class="type">“value-changed”</span></a> signal on the
268
<div class="refsect3">
269
<a name="id-1.2.14.8.10.5.5"></a><h4>Parameters</h4>
270
<div class="informaltable"><table width="100%" border="0">
272
<col width="150px" class="parameters_name">
273
<col class="parameters_description">
274
<col width="200px" class="parameters_annotations">
278
<td class="parameter_name"><p>balance</p></td>
279
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</p></td>
280
<td class="parameter_annotations"> </td>
283
<td class="parameter_name"><p>channel</p></td>
284
<td class="parameter_description"><p>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> whose value has changed</p></td>
285
<td class="parameter_annotations"> </td>
288
<td class="parameter_name"><p>value</p></td>
289
<td class="parameter_description"><p>The new value of the channel</p></td>
290
<td class="parameter_annotations"> </td>
297
<div class="refsect2">
298
<a name="gst-color-balance-get-balance-type"></a><h3>gst_color_balance_get_balance_type ()</h3>
299
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="returnvalue">GstColorBalanceType</span></a>
300
gst_color_balance_get_balance_type (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);</pre>
301
<p>Get the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="type">GstColorBalanceType</span></a> of this implementation.</p>
302
<div class="refsect3">
303
<a name="id-1.2.14.8.10.6.5"></a><h4>Parameters</h4>
304
<div class="informaltable"><table width="100%" border="0">
306
<col width="150px" class="parameters_name">
307
<col class="parameters_description">
308
<col width="200px" class="parameters_annotations">
311
<td class="parameter_name"><p>balance</p></td>
312
<td class="parameter_description"><p>The <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> implementation</p></td>
313
<td class="parameter_annotations"> </td>
317
<div class="refsect3">
318
<a name="id-1.2.14.8.10.6.6"></a><h4>Returns</h4>
319
<p> A the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="type">GstColorBalanceType</span></a>.</p>
324
<div class="refsect1">
325
<a name="gst-plugins-base-libs-gstcolorbalance.other_details"></a><h2>Types and Values</h2>
94
326
<div class="refsect2">
95
327
<a name="GstColorBalance-struct"></a><h3>GstColorBalance</h3>
96
328
<pre class="programlisting">typedef struct _GstColorBalance GstColorBalance;</pre>
121
Color-balance interface.
123
<div class="variablelist"><table border="0" class="variablelist">
352
<p>Color-balance interface.</p>
353
<div class="refsect3">
354
<a name="id-1.2.14.8.11.3.5"></a><h4>Members</h4>
355
<div class="informaltable"><table width="100%" border="0">
125
<col align="left" valign="top">
357
<col width="300px" class="struct_members_name">
358
<col class="struct_members_description">
359
<col width="200px" class="struct_members_annotations">
130
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstColorBalanceInterface.iface"></a>iface</code></em>;</span></p></td>
131
<td>the parent interface</td>
134
<td><p><span class="term"><em class="structfield"><code><a name="GstColorBalanceInterface.list-channels"></a>list_channels</code></em> ()</span></p></td>
135
<td>list handled channels</td>
138
<td><p><span class="term"><em class="structfield"><code><a name="GstColorBalanceInterface.set-value"></a>set_value</code></em> ()</span></p></td>
139
<td>set a channel value</td>
142
<td><p><span class="term"><em class="structfield"><code><a name="GstColorBalanceInterface.get-value"></a>get_value</code></em> ()</span></p></td>
143
<td>get a channel value</td>
146
<td><p><span class="term"><em class="structfield"><code><a name="GstColorBalanceInterface.get-balance-type"></a>get_balance_type</code></em> ()</span></p></td>
150
<td><p><span class="term"><em class="structfield"><code><a name="GstColorBalanceInterface.value-changed"></a>value_changed</code></em> ()</span></p></td>
151
<td>default handler for value changed notification</td>
363
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GstColorBalanceInterface.iface"></a>iface</code></em>;</p></td>
364
<td class="struct_member_description"><p>the parent interface</p></td>
365
<td class="struct_member_annotations"> </td>
368
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstColorBalanceInterface.list-channels"></a>list_channels</code></em> ()</p></td>
369
<td class="struct_member_description"><p>list handled channels</p></td>
370
<td class="struct_member_annotations"> </td>
373
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstColorBalanceInterface.set-value"></a>set_value</code></em> ()</p></td>
374
<td class="struct_member_description"><p>set a channel value</p></td>
375
<td class="struct_member_annotations"> </td>
378
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstColorBalanceInterface.get-value"></a>get_value</code></em> ()</p></td>
379
<td class="struct_member_description"><p>get a channel value</p></td>
380
<td class="struct_member_annotations"> </td>
383
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstColorBalanceInterface.get-balance-type"></a>get_balance_type</code></em> ()</p></td>
388
<td class="struct_member_name"><p><em class="structfield"><code><a name="GstColorBalanceInterface.value-changed"></a>value_changed</code></em> ()</p></td>
389
<td class="struct_member_description"><p>default handler for value changed notification</p></td>
390
<td class="struct_member_annotations"> </td>
157
397
<div class="refsect2">
158
398
<a name="GstColorBalanceType"></a><h3>enum GstColorBalanceType</h3>
159
<pre class="programlisting">typedef enum {
160
GST_COLOR_BALANCE_HARDWARE,
161
GST_COLOR_BALANCE_SOFTWARE
162
} GstColorBalanceType;
165
An enumeration indicating whether an element implements color balancing
399
<p>An enumeration indicating whether an element implements color balancing
166
400
operations in software or in dedicated hardware. In general, dedicated
167
401
hardware implementations (such as those provided by xvimagesink) are
170
<div class="variablelist"><table border="0" class="variablelist">
172
<col align="left" valign="top">
177
<td><p><a name="GST-COLOR-BALANCE-HARDWARE:CAPS"></a><span class="term"><code class="literal">GST_COLOR_BALANCE_HARDWARE</code></span></p></td>
178
<td>Color balance is implemented with dedicated
183
<td><p><a name="GST-COLOR-BALANCE-SOFTWARE:CAPS"></a><span class="term"><code class="literal">GST_COLOR_BALANCE_SOFTWARE</code></span></p></td>
184
<td>Color balance is implemented via software
192
<div class="refsect2">
193
<a name="gst-color-balance-list-channels"></a><h3>gst_color_balance_list_channels ()</h3>
194
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * gst_color_balance_list_channels (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);</pre>
196
Retrieve a list of the available channels.
198
<div class="variablelist"><table border="0" class="variablelist">
200
<col align="left" valign="top">
205
<td><p><span class="term"><em class="parameter"><code>balance</code></em> :</span></p></td>
206
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</td>
209
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210
<td>A GList containing pointers to <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> objects.
211
The list is owned by the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance and must not
218
<div class="refsect2">
219
<a name="gst-color-balance-get-value"></a><h3>gst_color_balance_get_value ()</h3>
220
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gst_color_balance_get_value (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
221
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>);</pre>
223
Retrieve the current value of the indicated channel, between min_value
227
See Also: The <span class="type">GstColorBalanceChannel.min_value</span> and
228
<span class="type">GstColorBalanceChannel.max_value</span> members of the
229
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> object.
231
<div class="variablelist"><table border="0" class="variablelist">
233
<col align="left" valign="top">
238
<td><p><span class="term"><em class="parameter"><code>balance</code></em> :</span></p></td>
239
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</td>
242
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
243
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> instance</td>
246
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247
<td>The current value of the channel.</td>
253
<div class="refsect2">
254
<a name="gst-color-balance-set-value"></a><h3>gst_color_balance_set_value ()</h3>
255
<pre class="programlisting"><span class="returnvalue">void</span> gst_color_balance_set_value (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
256
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
257
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
259
Sets the current value of the channel to the passed value, which must
260
be between min_value and max_value.
263
See Also: The <span class="type">GstColorBalanceChannel.min_value</span> and
264
<span class="type">GstColorBalanceChannel.max_value</span> members of the
265
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> object.
267
<div class="variablelist"><table border="0" class="variablelist">
269
<col align="left" valign="top">
274
<td><p><span class="term"><em class="parameter"><code>balance</code></em> :</span></p></td>
275
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</td>
278
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
279
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> instance</td>
282
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
283
<td>The new value for the channel.</td>
289
<div class="refsect2">
290
<a name="gst-color-balance-value-changed"></a><h3>gst_color_balance_value_changed ()</h3>
291
<pre class="programlisting"><span class="returnvalue">void</span> gst_color_balance_value_changed (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>,
292
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel</code></em>,
293
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
295
A helper function called by implementations of the GstColorBalance
296
interface. It fires the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance-value-changed" title='The "value-changed" signal'><span class="type">"value-changed"</span></a> signal on the
297
instance, and the <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel-value-changed" title='The "value-changed" signal'><span class="type">"value-changed"</span></a> signal on the
300
<div class="variablelist"><table border="0" class="variablelist">
302
<col align="left" valign="top">
307
<td><p><span class="term"><em class="parameter"><code>balance</code></em> :</span></p></td>
308
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> instance</td>
311
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
312
<td>A <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> whose value has changed</td>
315
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
316
<td>The new value of the channel</td>
322
<div class="refsect2">
323
<a name="gst-color-balance-get-balance-type"></a><h3>gst_color_balance_get_balance_type ()</h3>
324
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="returnvalue">GstColorBalanceType</span></a> gst_color_balance_get_balance_type (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *balance</code></em>);</pre>
326
Get the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="type">GstColorBalanceType</span></a> of this implementation.
328
<div class="variablelist"><table border="0" class="variablelist">
330
<col align="left" valign="top">
335
<td><p><span class="term"><em class="parameter"><code>balance</code></em> :</span></p></td>
336
<td>The <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> implementation</td>
339
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
340
<td>A the <a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalanceType" title="enum GstColorBalanceType"><span class="type">GstColorBalanceType</span></a>.</td>
403
<div class="refsect3">
404
<a name="id-1.2.14.8.11.4.4"></a><h4>Members</h4>
405
<div class="informaltable"><table width="100%" border="0">
407
<col width="300px" class="enum_members_name">
408
<col class="enum_members_description">
409
<col width="200px" class="enum_members_annotations">
413
<td class="enum_member_name"><p><a name="GST-COLOR-BALANCE-HARDWARE:CAPS"></a>GST_COLOR_BALANCE_HARDWARE</p></td>
414
<td class="enum_member_description">
415
<p>Color balance is implemented with dedicated
418
<td class="enum_member_annotations"> </td>
421
<td class="enum_member_name"><p><a name="GST-COLOR-BALANCE-SOFTWARE:CAPS"></a>GST_COLOR_BALANCE_SOFTWARE</p></td>
422
<td class="enum_member_description">
423
<p>Color balance is implemented via software
426
<td class="enum_member_annotations"> </td>
346
433
<div class="refsect1">
347
434
<a name="gst-plugins-base-libs-gstcolorbalance.signal-details"></a><h2>Signal Details</h2>
348
435
<div class="refsect2">
349
<a name="GstColorBalance-value-changed"></a><h3>The <code class="literal">"value-changed"</code> signal</h3>
350
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *colorbalance,
351
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel,
352
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value,
353
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
355
Fired when the value of the indicated channel has changed.
357
<div class="variablelist"><table border="0" class="variablelist">
436
<a name="GstColorBalance-value-changed"></a><h3>The <code class="literal">“value-changed”</code> signal</h3>
437
<pre class="programlisting"><span class="returnvalue">void</span>
438
user_function (<a class="link" href="gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance"><span class="type">GstColorBalance</span></a> *colorbalance,
439
<a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a> *channel,
440
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value,
441
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
442
<p>Fired when the value of the indicated channel has changed.</p>
443
<div class="refsect3">
444
<a name="id-1.2.14.8.12.2.5"></a><h4>Parameters</h4>
445
<div class="informaltable"><table width="100%" border="0">
359
<col align="left" valign="top">
447
<col width="150px" class="parameters_name">
448
<col class="parameters_description">
449
<col width="200px" class="parameters_annotations">
364
<td><p><span class="term"><em class="parameter"><code>colorbalance</code></em> :</span></p></td>
365
<td>The GstColorBalance instance</td>
368
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
369
<td>The <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a>
373
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
374
<td>The new value</td>
377
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
378
<td>user data set when the signal handler was connected.</td>
453
<td class="parameter_name"><p>colorbalance</p></td>
454
<td class="parameter_description"><p>The GstColorBalance instance</p></td>
455
<td class="parameter_annotations"> </td>
458
<td class="parameter_name"><p>channel</p></td>
459
<td class="parameter_description"><p>The <a class="link" href="gst-plugins-base-libs-gstcolorbalancechannel.html#GstColorBalanceChannel"><span class="type">GstColorBalanceChannel</span></a></p></td>
460
<td class="parameter_annotations"> </td>
463
<td class="parameter_name"><p>value</p></td>
464
<td class="parameter_description"><p>The new value</p></td>
465
<td class="parameter_annotations"> </td>
468
<td class="parameter_name"><p>user_data</p></td>
469
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
470
<td class="parameter_annotations"> </td>
475
<p>Flags: Run Last</p>
385
479
<div class="footer">
387
Generated by GTK-Doc V1.19</div>
481
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'