34
31
<h2><span class="refentrytitle"><a name="CheeseEffect.top_of_page"></a>CheeseEffect</span></h2>
35
32
<p>CheeseEffect — An effect to apply to a video capture stream</p>
37
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
38
35
</tr></table></div>
39
36
<div class="refsect1">
40
37
<a name="CheeseEffect.stability-level"></a><h2>Stability Level</h2>
41
Unstable, unless otherwise indicated
43
<div class="refsynopsisdiv">
44
<a name="CheeseEffect.synopsis"></a><h2>Synopsis</h2>
45
<pre class="synopsis">
46
#include <cheese/cheese-effect.h>
48
struct <a class="link" href="CheeseEffect.html#CheeseEffect-struct" title="struct CheeseEffect">CheeseEffect</a>;
49
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> * <a class="link" href="CheeseEffect.html#cheese-effect-new" title="cheese_effect_new ()">cheese_effect_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
50
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pipeline_desc</code></em>);
51
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CheeseEffect.html#cheese-effect-get-name" title="cheese_effect_get_name ()">cheese_effect_get_name</a> (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);
52
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CheeseEffect.html#cheese-effect-get-pipeline-desc" title="cheese_effect_get_pipeline_desc ()">cheese_effect_get_pipeline_desc</a> (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="CheeseEffect.html#cheese-effect-enable-preview" title="cheese_effect_enable_preview ()">cheese_effect_enable_preview</a> (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);
54
<span class="returnvalue">void</span> <a class="link" href="CheeseEffect.html#cheese-effect-disable-preview" title="cheese_effect_disable_preview ()">cheese_effect_disable_preview</a> (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CheeseEffect.html#cheese-effect-is-preview-connected" title="cheese_effect_is_preview_connected ()">cheese_effect_is_preview_connected</a> (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);
56
<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="CheeseEffect.html#cheese-effect-load-effects" title="cheese_effect_load_effects ()">cheese_effect_load_effects</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
57
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> * <a class="link" href="CheeseEffect.html#cheese-effect-load-from-file" title="cheese_effect_load_from_file ()">cheese_effect_load_from_file</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
38
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
39
give outside developers early access to new or rapidly changing technology, or
40
to provide an interim solution to a problem where a more general solution is
41
anticipated. No claims are made about either source or binary compatibility from
42
one minor release to the next.
44
The Unstable interface level is a warning that these interfaces are subject to
45
change without warning and should not be used in unbundled products.
47
Given such caveats, customer impact need not be a factor when considering
48
incompatible changes to an Unstable interface in a major or minor release.
49
Nonetheless, when such changes are introduced, the changes should still be
50
mentioned in the release notes for the affected release.
51
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
53
<div class="refsect1">
54
<a name="CheeseEffect.functions"></a><h2>Functions</h2>
55
<div class="informaltable"><table width="100%" border="0">
57
<col width="150px" class="functions_return">
58
<col class="functions_name">
62
<td class="function_type">
63
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
65
<td class="function_name">
66
<a class="link" href="CheeseEffect.html#cheese-effect-new" title="cheese_effect_new ()">cheese_effect_new</a> <span class="c_punctuation">()</span>
70
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
72
<td class="function_name">
73
<a class="link" href="CheeseEffect.html#cheese-effect-get-name" title="cheese_effect_get_name ()">cheese_effect_get_name</a> <span class="c_punctuation">()</span>
77
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
79
<td class="function_name">
80
<a class="link" href="CheeseEffect.html#cheese-effect-get-pipeline-desc" title="cheese_effect_get_pipeline_desc ()">cheese_effect_get_pipeline_desc</a> <span class="c_punctuation">()</span>
84
<td class="function_type">
85
<span class="returnvalue">void</span>
87
<td class="function_name">
88
<a class="link" href="CheeseEffect.html#cheese-effect-enable-preview" title="cheese_effect_enable_preview ()">cheese_effect_enable_preview</a> <span class="c_punctuation">()</span>
92
<td class="function_type">
93
<span class="returnvalue">void</span>
95
<td class="function_name">
96
<a class="link" href="CheeseEffect.html#cheese-effect-disable-preview" title="cheese_effect_disable_preview ()">cheese_effect_disable_preview</a> <span class="c_punctuation">()</span>
100
<td class="function_type">
101
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
103
<td class="function_name">
104
<a class="link" href="CheeseEffect.html#cheese-effect-is-preview-connected" title="cheese_effect_is_preview_connected ()">cheese_effect_is_preview_connected</a> <span class="c_punctuation">()</span>
108
<td class="function_type">
109
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
111
<td class="function_name">
112
<a class="link" href="CheeseEffect.html#cheese-effect-load-effects" title="cheese_effect_load_effects ()">cheese_effect_load_effects</a> <span class="c_punctuation">()</span>
116
<td class="function_type">
117
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
119
<td class="function_name">
120
<a class="link" href="CheeseEffect.html#cheese-effect-load-from-file" title="cheese_effect_load_from_file ()">cheese_effect_load_from_file</a> <span class="c_punctuation">()</span>
126
<div class="refsect1">
127
<a name="CheeseEffect.properties"></a><h2>Properties</h2>
128
<div class="informaltable"><table border="0">
130
<col width="150px" class="properties_type">
131
<col width="300px" class="properties_name">
132
<col width="200px" class="properties_flags">
136
<td class="property_type">
137
<span class="type">GstElement</span> *</td>
138
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--control-valve" title="The “control-valve” property">control-valve</a></td>
139
<td class="property_flags">Read / Write</td>
142
<td class="property_type">
143
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
144
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--name" title="The “name” property">name</a></td>
145
<td class="property_flags">Read / Write / Construct Only</td>
148
<td class="property_type">
149
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
150
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--pipeline-desc" title="The “pipeline-desc” property">pipeline-desc</a></td>
151
<td class="property_flags">Read / Write / Construct Only</td>
156
<div class="refsect1">
157
<a name="CheeseEffect.other"></a><h2>Types and Values</h2>
158
<div class="informaltable"><table width="100%" border="0">
160
<col width="150px" class="name">
161
<col class="description">
164
<td class="datatype_keyword">struct</td>
165
<td class="function_name"><a class="link" href="CheeseEffect.html#CheeseEffect-struct" title="struct CheeseEffect">CheeseEffect</a></td>
60
169
<div class="refsect1">
61
170
<a name="CheeseEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
62
<pre class="synopsis">
63
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
171
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
172
<span class="lineart">╰──</span> CheeseEffect
67
175
<div class="refsect1">
68
<a name="CheeseEffect.properties"></a><h2>Properties</h2>
69
<pre class="synopsis">
70
"<a class="link" href="CheeseEffect.html#CheeseEffect--control-valve" title='The "control-valve" property'>control-valve</a>" <span class="type">GstElement</span>* : Read / Write
71
"<a class="link" href="CheeseEffect.html#CheeseEffect--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
72
"<a class="link" href="CheeseEffect.html#CheeseEffect--pipeline-desc" title='The "pipeline-desc" property'>pipeline-desc</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
176
<a name="CheeseEffect.includes"></a><h2>Includes</h2>
177
<pre class="synopsis">#include <cheese/cheese-effect.h>
75
180
<div class="refsect1">
76
181
<a name="CheeseEffect.description"></a><h2>Description</h2>
78
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> provides an abstraction of an effect to apply to a stream
79
from a video capture device.
82
<div class="refsect1">
83
<a name="CheeseEffect.details"></a><h2>Details</h2>
182
<p><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> provides an abstraction of an effect to apply to a stream
183
from a video capture device.</p>
185
<div class="refsect1">
186
<a name="CheeseEffect.functions_details"></a><h2>Functions</h2>
187
<div class="refsect2">
188
<a name="cheese-effect-new"></a><h3>cheese_effect_new ()</h3>
189
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
190
cheese_effect_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
191
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pipeline_desc</code></em>);</pre>
192
<p>Create a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
193
<div class="refsect3">
194
<a name="id-1.3.7.10.2.5"></a><h4>Parameters</h4>
195
<div class="informaltable"><table width="100%" border="0">
197
<col width="150px" class="parameters_name">
198
<col class="parameters_description">
199
<col width="200px" class="parameters_annotations">
203
<td class="parameter_name"><p>name</p></td>
204
<td class="parameter_description"><p>name of the effect</p></td>
205
<td class="parameter_annotations"> </td>
208
<td class="parameter_name"><p>pipeline_desc</p></td>
209
<td class="parameter_description"><p>GStreamer pipeline of the new effect</p></td>
210
<td class="parameter_annotations"> </td>
215
<div class="refsect3">
216
<a name="id-1.3.7.10.2.6"></a><h4>Returns</h4>
217
<p> a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>. </p>
218
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
222
<div class="refsect2">
223
<a name="cheese-effect-get-name"></a><h3>cheese_effect_get_name ()</h3>
224
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
225
cheese_effect_get_name (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
226
<p>Get the human-readable name of the <em class="parameter"><code>effect</code></em>
228
<div class="refsect3">
229
<a name="id-1.3.7.10.3.5"></a><h4>Parameters</h4>
230
<div class="informaltable"><table width="100%" border="0">
232
<col width="150px" class="parameters_name">
233
<col class="parameters_description">
234
<col width="200px" class="parameters_annotations">
237
<td class="parameter_name"><p>effect</p></td>
238
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
239
<td class="parameter_annotations"> </td>
243
<div class="refsect3">
244
<a name="id-1.3.7.10.3.6"></a><h4>Returns</h4>
245
<p> the human-readable name of the effect. </p>
246
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
250
<div class="refsect2">
251
<a name="cheese-effect-get-pipeline-desc"></a><h3>cheese_effect_get_pipeline_desc ()</h3>
252
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
253
cheese_effect_get_pipeline_desc (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
254
<p>Get the Gstreamer pipeline description of the <em class="parameter"><code>effect</code></em>
256
<div class="refsect3">
257
<a name="id-1.3.7.10.4.5"></a><h4>Parameters</h4>
258
<div class="informaltable"><table width="100%" border="0">
260
<col width="150px" class="parameters_name">
261
<col class="parameters_description">
262
<col width="200px" class="parameters_annotations">
265
<td class="parameter_name"><p>effect</p></td>
266
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
267
<td class="parameter_annotations"> </td>
271
<div class="refsect3">
272
<a name="id-1.3.7.10.4.6"></a><h4>Returns</h4>
273
<p> the Gstreamer pipeline description of the effect. </p>
274
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
278
<div class="refsect2">
279
<a name="cheese-effect-enable-preview"></a><h3>cheese_effect_enable_preview ()</h3>
280
<pre class="programlisting"><span class="returnvalue">void</span>
281
cheese_effect_enable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
282
<p>Enable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
283
<div class="refsect3">
284
<a name="id-1.3.7.10.5.5"></a><h4>Parameters</h4>
285
<div class="informaltable"><table width="100%" border="0">
287
<col width="150px" class="parameters_name">
288
<col class="parameters_description">
289
<col width="200px" class="parameters_annotations">
292
<td class="parameter_name"><p>effect</p></td>
293
<td class="parameter_description"><p>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to enable the preview of</p></td>
294
<td class="parameter_annotations"> </td>
300
<div class="refsect2">
301
<a name="cheese-effect-disable-preview"></a><h3>cheese_effect_disable_preview ()</h3>
302
<pre class="programlisting"><span class="returnvalue">void</span>
303
cheese_effect_disable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
304
<p>Disable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
305
<div class="refsect3">
306
<a name="id-1.3.7.10.6.5"></a><h4>Parameters</h4>
307
<div class="informaltable"><table width="100%" border="0">
309
<col width="150px" class="parameters_name">
310
<col class="parameters_description">
311
<col width="200px" class="parameters_annotations">
314
<td class="parameter_name"><p>effect</p></td>
315
<td class="parameter_description"><p>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to disable the preview of</p></td>
316
<td class="parameter_annotations"> </td>
322
<div class="refsect2">
323
<a name="cheese-effect-is-preview-connected"></a><h3>cheese_effect_is_preview_connected ()</h3>
324
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
325
cheese_effect_is_preview_connected (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
326
<p>Get whether the <em class="parameter"><code>effect</code></em>
327
is connected to a video stream, for previews.</p>
328
<div class="refsect3">
329
<a name="id-1.3.7.10.7.5"></a><h4>Parameters</h4>
330
<div class="informaltable"><table width="100%" border="0">
332
<col width="150px" class="parameters_name">
333
<col class="parameters_description">
334
<col width="200px" class="parameters_annotations">
337
<td class="parameter_name"><p>effect</p></td>
338
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
339
<td class="parameter_annotations"> </td>
343
<div class="refsect3">
344
<a name="id-1.3.7.10.7.6"></a><h4>Returns</h4>
345
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the preview is connected, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
350
<div class="refsect2">
351
<a name="cheese-effect-load-effects"></a><h3>cheese_effect_load_effects ()</h3>
352
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
353
cheese_effect_load_effects (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
354
<p>Load effects from standard directories, including the user's data directory.</p>
355
<div class="refsect3">
356
<a name="id-1.3.7.10.8.5"></a><h4>Returns</h4>
358
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no effects could be found. </p>
359
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Cheese.Effect][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
363
<div class="refsect2">
364
<a name="cheese-effect-load-from-file"></a><h3>cheese_effect_load_from_file ()</h3>
365
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
366
cheese_effect_load_from_file (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
367
<p>Load effect from file.</p>
368
<div class="refsect3">
369
<a name="id-1.3.7.10.9.5"></a><h4>Parameters</h4>
370
<div class="informaltable"><table width="100%" border="0">
372
<col width="150px" class="parameters_name">
373
<col class="parameters_description">
374
<col width="200px" class="parameters_annotations">
377
<td class="parameter_name"><p>filename</p></td>
378
<td class="parameter_description"><p> name of the file containing the effect
379
specification. </p></td>
380
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
384
<div class="refsect3">
385
<a name="id-1.3.7.10.9.6"></a><h4>Returns</h4>
386
<p> a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
387
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
391
<div class="refsect1">
392
<a name="CheeseEffect.other_details"></a><h2>Types and Values</h2>
84
393
<div class="refsect2">
85
394
<a name="CheeseEffect-struct"></a><h3>struct CheeseEffect</h3>
86
395
<pre class="programlisting">struct CheeseEffect;</pre>
88
Use the accessor functions below.
92
<div class="refsect2">
93
<a name="cheese-effect-new"></a><h3>cheese_effect_new ()</h3>
94
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> * cheese_effect_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
95
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pipeline_desc</code></em>);</pre>
97
Create a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.
99
<div class="variablelist"><table border="0" class="variablelist">
101
<col align="left" valign="top">
106
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
107
<td>name of the effect</td>
110
<td><p><span class="term"><em class="parameter"><code>pipeline_desc</code></em> :</span></p></td>
111
<td>GStreamer pipeline of the new effect</td>
114
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
115
<td>a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
122
<div class="refsect2">
123
<a name="cheese-effect-get-name"></a><h3>cheese_effect_get_name ()</h3>
124
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * cheese_effect_get_name (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
126
Get the human-readable name of the <em class="parameter"><code>effect</code></em>.
128
<div class="variablelist"><table border="0" class="variablelist">
130
<col align="left" valign="top">
135
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
136
<td>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>
140
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
141
<td>the human-readable name of the effect. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
148
<div class="refsect2">
149
<a name="cheese-effect-get-pipeline-desc"></a><h3>cheese_effect_get_pipeline_desc ()</h3>
150
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * cheese_effect_get_pipeline_desc (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
152
Get the Gstreamer pipeline description of the <em class="parameter"><code>effect</code></em>.
154
<div class="variablelist"><table border="0" class="variablelist">
156
<col align="left" valign="top">
161
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
162
<td>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
<td>the Gstreamer pipeline description of the effect. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
174
<div class="refsect2">
175
<a name="cheese-effect-enable-preview"></a><h3>cheese_effect_enable_preview ()</h3>
176
<pre class="programlisting"><span class="returnvalue">void</span> cheese_effect_enable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
178
Enable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.
180
<div class="variablelist"><table border="0" class="variablelist">
182
<col align="left" valign="top">
186
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
187
<td>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to enable the preview of</td>
192
<div class="refsect2">
193
<a name="cheese-effect-disable-preview"></a><h3>cheese_effect_disable_preview ()</h3>
194
<pre class="programlisting"><span class="returnvalue">void</span> cheese_effect_disable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
196
Disable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.
198
<div class="variablelist"><table border="0" class="variablelist">
200
<col align="left" valign="top">
204
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
205
<td>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to disable the preview of</td>
210
<div class="refsect2">
211
<a name="cheese-effect-is-preview-connected"></a><h3>cheese_effect_is_preview_connected ()</h3>
212
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> cheese_effect_is_preview_connected (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
214
Get whether the <em class="parameter"><code>effect</code></em> is connected to a video stream, for previews.
216
<div class="variablelist"><table border="0" class="variablelist">
218
<col align="left" valign="top">
223
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
224
<td>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>
228
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
230
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the preview is connected, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
236
<div class="refsect2">
237
<a name="cheese-effect-load-effects"></a><h3>cheese_effect_load_effects ()</h3>
238
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * cheese_effect_load_effects (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
240
Load effects from standard directories, including the user's data directory.
242
<div class="variablelist"><table border="0" class="variablelist">
244
<col align="left" valign="top">
248
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
250
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no effects could be found. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Cheese.Effect][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
256
<div class="refsect2">
257
<a name="cheese-effect-load-from-file"></a><h3>cheese_effect_load_from_file ()</h3>
258
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> * cheese_effect_load_from_file (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
260
Load effect from file.
262
<div class="variablelist"><table border="0" class="variablelist">
264
<col align="left" valign="top">
269
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
270
<td>name of the file containing the effect
271
specification. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span>
275
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
276
<td>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
396
<p>Use the accessor functions below.</p>
283
399
<div class="refsect1">
284
400
<a name="CheeseEffect.property-details"></a><h2>Property Details</h2>
285
401
<div class="refsect2">
286
<a name="CheeseEffect--control-valve"></a><h3>The <code class="literal">"control-valve"</code> property</h3>
287
<pre class="programlisting"> "control-valve" <span class="type">GstElement</span>* : Read / Write</pre>
289
If the control valve is active, then the effect is currently connected to
290
a video stream, for previews.
402
<a name="CheeseEffect--control-valve"></a><h3>The <code class="literal">“control-valve”</code> property</h3>
403
<pre class="programlisting"> “control-valve” <span class="type">GstElement</span> *</pre>
404
<p>If the control valve is active, then the effect is currently connected to
405
a video stream, for previews.</p>
406
<p>Flags: Read / Write</p>
294
409
<div class="refsect2">
295
<a name="CheeseEffect--name"></a><h3>The <code class="literal">"name"</code> property</h3>
296
<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
298
Name of the effect, for display in a UI.
410
<a name="CheeseEffect--name"></a><h3>The <code class="literal">“name”</code> property</h3>
411
<pre class="programlisting"> “name” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
412
<p>Name of the effect, for display in a UI.</p>
413
<p>Flags: Read / Write / Construct Only</p>
300
414
<p>Default value: ""</p>
303
417
<div class="refsect2">
304
<a name="CheeseEffect--pipeline-desc"></a><h3>The <code class="literal">"pipeline-desc"</code> property</h3>
305
<pre class="programlisting"> "pipeline-desc" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
307
Description of the GStreamer pipeline associated with the effect.
418
<a name="CheeseEffect--pipeline-desc"></a><h3>The <code class="literal">“pipeline-desc”</code> property</h3>
419
<pre class="programlisting"> “pipeline-desc” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
420
<p>Description of the GStreamer pipeline associated with the effect.</p>
421
<p>Flags: Read / Write / Construct Only</p>
309
422
<p>Default value: ""</p>
313
426
<div class="footer">
315
Generated by GTK-Doc V1.19.1</div>
428
Generated by GTK-Doc V1.20.1</div>
b'\\ No newline at end of file'
added
removed
docs/reference/html/CheeseEffect.html
