← Back to branch summary

~ubuntu-branches/debian/jessie/cheese/jessie

« back to all changes in this revision

Viewing changes to docs/reference/html/CheeseCameraDevice.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-04-02 21:39:33 UTC
  • mfrom: (1.5.1) (15.1.7 experimental)
  • Revision ID: package-import@ubuntu.com-20140402213933-r0w3gna0pv7q7085
Tags: 3.12.0-1
* New upstream release.
* Revert changes done in 3.10.1-3
  - i.e. lower gnome-desktop build-dependency again.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/CheeseCameraDevice.html
8
8
<link rel="up" href="libcheese.html" title="libcheese">
9
9
<link rel="prev" href="CheeseCamera.html" title="CheeseCamera">
10
10
<link rel="next" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor">
11
 
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
 
<td width="100%" align="left">
17
 
<a href="#" class="shortcut">Top</a>
18
 
                   | 
19
 
                  <a href="#CheeseCameraDevice.description" class="shortcut">Description</a>
20
 
                   | 
21
 
                  <a href="#CheeseCameraDevice.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
 
                   | 
23
 
                  <a href="#CheeseCameraDevice.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
24
 
                   | 
25
 
                  <a href="#CheeseCameraDevice.properties" class="shortcut">Properties</a>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><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="#CheeseCameraDevice.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#CheeseCameraDevice.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
 
20
                  <a href="#CheeseCameraDevice.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
 
21
                  <a href="#CheeseCameraDevice.properties" class="shortcut">Properties</a></span>
26
22
</td>
27
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
28
24
<td><a accesskey="u" href="libcheese.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
36
32
<h2><span class="refentrytitle"><a name="CheeseCameraDevice.top_of_page"></a>CheeseCameraDevice</span></h2>
37
33
<p>CheeseCameraDevice — Object to represent a video capture device</p>
38
34
</td>
39
 
<td valign="top" align="right"></td>
 
35
<td class="gallery_image" valign="top" align="right"></td>
40
36
</tr></table></div>
41
37
<div class="refsect1">
42
38
<a name="CheeseCameraDevice.stability-level"></a><h2>Stability Level</h2>
43
 
Unstable, unless otherwise indicated
44
 
</div>
45
 
<div class="refsynopsisdiv">
46
 
<a name="CheeseCameraDevice.synopsis"></a><h2>Synopsis</h2>
47
 
<a name="CheeseVideoFormat"></a><pre class="synopsis">
48
 
#include &lt;cheese/cheese-camera-device.h&gt;
49
 
 
50
 
struct              <a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice-struct" title="struct CheeseCameraDevice">CheeseCameraDevice</a>;
51
 
struct              <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat-struct" title="struct CheeseVideoFormat">CheeseVideoFormat</a>;
52
 
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="returnvalue">CheeseCameraDevice</span></a> * <a class="link" href="CheeseCameraDevice.html#cheese-camera-device-new" title="cheese_camera_device_new ()">cheese_camera_device_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> *uuid</code></em>,
53
 
                                                         <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> *device_node</code></em>,
54
 
                                                         <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>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> v4l_api_version</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
57
 
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="CheeseCameraDevice.html#cheese-camera-device-get-name" title="cheese_camera_device_get_name ()">cheese_camera_device_get_name</a>       (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
58
 
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="CheeseCameraDevice.html#cheese-camera-device-get-uuid" title="cheese_camera_device_get_uuid ()">cheese_camera_device_get_uuid</a>       (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
59
 
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="CheeseCameraDevice.html#cheese-camera-device-get-device-node" title="cheese_camera_device_get_device_node ()">cheese_camera_device_get_device_node</a>
60
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
61
 
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="returnvalue">CheeseVideoFormat</span></a> * <a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-best-format" title="cheese_camera_device_get_best_format ()">cheese_camera_device_get_best_format</a>
62
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
63
 
<span class="returnvalue">GstCaps</span> *           <a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-caps-for-format" title="cheese_camera_device_get_caps_for_format ()">cheese_camera_device_get_caps_for_format</a>
64
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>,
65
 
                                                         <em class="parameter"><code><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> *format</code></em>);
66
 
<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="CheeseCameraDevice.html#cheese-camera-device-get-format-list" title="cheese_camera_device_get_format_list ()">cheese_camera_device_get_format_list</a>
67
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
68
 
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="CheeseCameraDevice.html#cheese-camera-device-get-src" title="cheese_camera_device_get_src ()">cheese_camera_device_get_src</a>        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);
69
 
</pre>
 
39
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
 
40
give outside developers early access to new or rapidly changing technology, or
 
41
to provide an interim solution to a problem where a more general solution is
 
42
anticipated. No claims are made about either source or binary compatibility from
 
43
one minor release to the next.
 
44
 
 
45
The Unstable interface level is a warning that these interfaces are  subject to
 
46
change without warning and should not be used in unbundled products.
 
47
 
 
48
Given such caveats, customer impact need not be a factor when considering
 
49
incompatible changes to an Unstable interface in a major or minor release.
 
50
Nonetheless, when such changes are introduced, the changes should still be
 
51
mentioned in the release notes for the affected release.
 
52
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
 
53
</div>
 
54
<div class="refsect1">
 
55
<a name="CheeseCameraDevice.functions"></a><h2>Functions</h2>
 
56
<div class="informaltable"><table width="100%" border="0">
 
57
<colgroup>
 
58
<col width="150px" class="functions_return">
 
59
<col class="functions_name">
 
60
</colgroup>
 
61
<tbody>
 
62
<tr>
 
63
<td class="function_type">
 
64
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="returnvalue">CheeseCameraDevice</span></a> *
 
65
</td>
 
66
<td class="function_name">
 
67
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-new" title="cheese_camera_device_new ()">cheese_camera_device_new</a> <span class="c_punctuation">()</span>
 
68
</td>
 
69
</tr>
 
70
<tr>
 
71
<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>
 
73
<td class="function_name">
 
74
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-name" title="cheese_camera_device_get_name ()">cheese_camera_device_get_name</a> <span class="c_punctuation">()</span>
 
75
</td>
 
76
</tr>
 
77
<tr>
 
78
<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>
 
80
<td class="function_name">
 
81
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-uuid" title="cheese_camera_device_get_uuid ()">cheese_camera_device_get_uuid</a> <span class="c_punctuation">()</span>
 
82
</td>
 
83
</tr>
 
84
<tr>
 
85
<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> *
 
86
</td>
 
87
<td class="function_name">
 
88
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-device-node" title="cheese_camera_device_get_device_node ()">cheese_camera_device_get_device_node</a> <span class="c_punctuation">()</span>
 
89
</td>
 
90
</tr>
 
91
<tr>
 
92
<td class="function_type">
 
93
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="returnvalue">CheeseVideoFormat</span></a> *
 
94
</td>
 
95
<td class="function_name">
 
96
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-best-format" title="cheese_camera_device_get_best_format ()">cheese_camera_device_get_best_format</a> <span class="c_punctuation">()</span>
 
97
</td>
 
98
</tr>
 
99
<tr>
 
100
<td class="function_type">
 
101
<span class="returnvalue">GstCaps</span> *
 
102
</td>
 
103
<td class="function_name">
 
104
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-caps-for-format" title="cheese_camera_device_get_caps_for_format ()">cheese_camera_device_get_caps_for_format</a> <span class="c_punctuation">()</span>
 
105
</td>
 
106
</tr>
 
107
<tr>
 
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> *
 
110
</td>
 
111
<td class="function_name">
 
112
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-format-list" title="cheese_camera_device_get_format_list ()">cheese_camera_device_get_format_list</a> <span class="c_punctuation">()</span>
 
113
</td>
 
114
</tr>
 
115
<tr>
 
116
<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> *
 
117
</td>
 
118
<td class="function_name">
 
119
<a class="link" href="CheeseCameraDevice.html#cheese-camera-device-get-src" title="cheese_camera_device_get_src ()">cheese_camera_device_get_src</a> <span class="c_punctuation">()</span>
 
120
</td>
 
121
</tr>
 
122
</tbody>
 
123
</table></div>
 
124
</div>
 
125
<div class="refsect1">
 
126
<a name="CheeseCameraDevice.properties"></a><h2>Properties</h2>
 
127
<div class="informaltable"><table border="0">
 
128
<colgroup>
 
129
<col width="150px" class="properties_type">
 
130
<col width="300px" class="properties_name">
 
131
<col width="200px" class="properties_flags">
 
132
</colgroup>
 
133
<tbody>
 
134
<tr>
 
135
<td class="property_type">
 
136
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
137
<td class="property_name"><a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--device-node" title="The “device-node” property">device-node</a></td>
 
138
<td class="property_flags">Read / Write / Construct Only</td>
 
139
</tr>
 
140
<tr>
 
141
<td class="property_type">
 
142
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
143
<td class="property_name"><a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--name" title="The “name” property">name</a></td>
 
144
<td class="property_flags">Read / Write / Construct Only</td>
 
145
</tr>
 
146
<tr>
 
147
<td class="property_type">
 
148
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
149
<td class="property_name"><a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--uuid" title="The “uuid” property">uuid</a></td>
 
150
<td class="property_flags">Read / Write / Construct Only</td>
 
151
</tr>
 
152
<tr>
 
153
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
 
154
<td class="property_name"><a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--v4l-api-version" title="The “v4l-api-version” property">v4l-api-version</a></td>
 
155
<td class="property_flags">Read / Write / Construct Only</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
</div>
 
160
<a name="CheeseVideoFormat"></a><div class="refsect1">
 
161
<a name="CheeseCameraDevice.other"></a><h2>Types and Values</h2>
 
162
<div class="informaltable"><table width="100%" border="0">
 
163
<colgroup>
 
164
<col width="150px" class="name">
 
165
<col class="description">
 
166
</colgroup>
 
167
<tbody>
 
168
<tr>
 
169
<td class="datatype_keyword">struct</td>
 
170
<td class="function_name"><a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice-struct" title="struct CheeseCameraDevice">CheeseCameraDevice</a></td>
 
171
</tr>
 
172
<tr>
 
173
<td class="datatype_keyword">struct</td>
 
174
<td class="function_name"><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat-struct" title="struct CheeseVideoFormat">CheeseVideoFormat</a></td>
 
175
</tr>
 
176
</tbody>
 
177
</table></div>
70
178
</div>
71
179
<div class="refsect1">
72
180
<a name="CheeseCameraDevice.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
 
<pre class="synopsis">
74
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
75
 
   +----CheeseCameraDevice
76
 
</pre>
77
 
<pre class="synopsis">
78
 
  GBoxed
79
 
   +----CheeseVideoFormat
 
181
<pre class="screen">    GBoxed
 
182
    <span class="lineart">╰──</span> CheeseVideoFormat
 
183
    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
184
    <span class="lineart">╰──</span> CheeseCameraDevice
80
185
</pre>
81
186
</div>
82
187
<div class="refsect1">
86
191
 <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a>.</p>
87
192
</div>
88
193
<div class="refsect1">
89
 
<a name="CheeseCameraDevice.properties"></a><h2>Properties</h2>
90
 
<pre class="synopsis">
91
 
  "<a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--device-node" title='The "device-node" property'>device-node</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
92
 
  "<a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--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
93
 
  "<a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--uuid" title='The "uuid" property'>uuid</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
94
 
  "<a class="link" href="CheeseCameraDevice.html#CheeseCameraDevice--v4l-api-version" title='The "v4l-api-version" property'>v4l-api-version</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only
 
194
<a name="CheeseCameraDevice.includes"></a><h2>Includes</h2>
 
195
<pre class="synopsis">#include &lt;cheese/cheese-camera-device.h&gt;
95
196
</pre>
96
197
</div>
97
198
<div class="refsect1">
98
199
<a name="CheeseCameraDevice.description"></a><h2>Description</h2>
99
 
<p>
100
 
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> provides an abstraction of a video capture device.
101
 
</p>
102
 
</div>
103
 
<div class="refsect1">
104
 
<a name="CheeseCameraDevice.details"></a><h2>Details</h2>
 
200
<p><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> provides an abstraction of a video capture device.</p>
 
201
</div>
 
202
<div class="refsect1">
 
203
<a name="CheeseCameraDevice.functions_details"></a><h2>Functions</h2>
 
204
<div class="refsect2">
 
205
<a name="cheese-camera-device-new"></a><h3>cheese_camera_device_new ()</h3>
 
206
<pre class="programlisting"><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="returnvalue">CheeseCameraDevice</span></a> *
 
207
cheese_camera_device_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> *uuid</code></em>,
 
208
                          <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> *device_node</code></em>,
 
209
                          <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>,
 
210
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> v4l_api_version</code></em>,
 
211
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
212
<p>Tries to create a new <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> with the supplied parameters. If
 
213
construction fails, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, and <em class="parameter"><code>error</code></em>
 
214
 is set.</p>
 
215
<div class="refsect3">
 
216
<a name="id-1.3.5.12.2.5"></a><h4>Parameters</h4>
 
217
<div class="informaltable"><table width="100%" border="0">
 
218
<colgroup>
 
219
<col width="150px" class="parameters_name">
 
220
<col class="parameters_description">
 
221
<col width="200px" class="parameters_annotations">
 
222
</colgroup>
 
223
<tbody>
 
224
<tr>
 
225
<td class="parameter_name"><p>uuid</p></td>
 
226
<td class="parameter_description"><p>UUID of the device, as supplied by udev</p></td>
 
227
<td class="parameter_annotations"> </td>
 
228
</tr>
 
229
<tr>
 
230
<td class="parameter_name"><p>device_node</p></td>
 
231
<td class="parameter_description"><p> path to the device node of the video capture
 
232
device. </p></td>
 
233
<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>
 
234
</tr>
 
235
<tr>
 
236
<td class="parameter_name"><p>name</p></td>
 
237
<td class="parameter_description"><p>human-readable name of the device, as supplied by udev</p></td>
 
238
<td class="parameter_annotations"> </td>
 
239
</tr>
 
240
<tr>
 
241
<td class="parameter_name"><p>v4l_api_version</p></td>
 
242
<td class="parameter_description"><p>version of the Video4Linux API that the device uses. Currently
 
243
either 1 or 2</p></td>
 
244
<td class="parameter_annotations"> </td>
 
245
</tr>
 
246
<tr>
 
247
<td class="parameter_name"><p>error</p></td>
 
248
<td class="parameter_description"><p>a location to store errors</p></td>
 
249
<td class="parameter_annotations"> </td>
 
250
</tr>
 
251
</tbody>
 
252
</table></div>
 
253
</div>
 
254
<div class="refsect3">
 
255
<a name="id-1.3.5.12.2.6"></a><h4>Returns</h4>
 
256
<p> a new <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
 
257
<p></p>
 
258
</div>
 
259
</div>
 
260
<hr>
 
261
<div class="refsect2">
 
262
<a name="cheese-camera-device-get-name"></a><h3>cheese_camera_device_get_name ()</h3>
 
263
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
264
cheese_camera_device_get_name (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
265
<p>Get a human-readable name for the device, as reported by udev, which is
 
266
suitable for display to a user.</p>
 
267
<div class="refsect3">
 
268
<a name="id-1.3.5.12.3.5"></a><h4>Parameters</h4>
 
269
<div class="informaltable"><table width="100%" border="0">
 
270
<colgroup>
 
271
<col width="150px" class="parameters_name">
 
272
<col class="parameters_description">
 
273
<col width="200px" class="parameters_annotations">
 
274
</colgroup>
 
275
<tbody><tr>
 
276
<td class="parameter_name"><p>device</p></td>
 
277
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
278
<td class="parameter_annotations"> </td>
 
279
</tr></tbody>
 
280
</table></div>
 
281
</div>
 
282
<div class="refsect3">
 
283
<a name="id-1.3.5.12.3.6"></a><h4>Returns</h4>
 
284
<p> the human-readable name of the video capture device. </p>
 
285
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
286
</div>
 
287
</div>
 
288
<hr>
 
289
<div class="refsect2">
 
290
<a name="cheese-camera-device-get-uuid"></a><h3>cheese_camera_device_get_uuid ()</h3>
 
291
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
292
cheese_camera_device_get_uuid (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
293
<p>Get the UUID of the <em class="parameter"><code>device</code></em>
 
294
, as reported by udev.</p>
 
295
<div class="refsect3">
 
296
<a name="id-1.3.5.12.4.5"></a><h4>Parameters</h4>
 
297
<div class="informaltable"><table width="100%" border="0">
 
298
<colgroup>
 
299
<col width="150px" class="parameters_name">
 
300
<col class="parameters_description">
 
301
<col width="200px" class="parameters_annotations">
 
302
</colgroup>
 
303
<tbody><tr>
 
304
<td class="parameter_name"><p>device</p></td>
 
305
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
306
<td class="parameter_annotations"> </td>
 
307
</tr></tbody>
 
308
</table></div>
 
309
</div>
 
310
<div class="refsect3">
 
311
<a name="id-1.3.5.12.4.6"></a><h4>Returns</h4>
 
312
<p> the UUID of the video capture device. </p>
 
313
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
314
</div>
 
315
</div>
 
316
<hr>
 
317
<div class="refsect2">
 
318
<a name="cheese-camera-device-get-device-node"></a><h3>cheese_camera_device_get_device_node ()</h3>
 
319
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
320
cheese_camera_device_get_device_node (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
321
<p>Get the path to the device node associated with the <em class="parameter"><code>device</code></em>
 
322
.</p>
 
323
<div class="refsect3">
 
324
<a name="id-1.3.5.12.5.5"></a><h4>Parameters</h4>
 
325
<div class="informaltable"><table width="100%" border="0">
 
326
<colgroup>
 
327
<col width="150px" class="parameters_name">
 
328
<col class="parameters_description">
 
329
<col width="200px" class="parameters_annotations">
 
330
</colgroup>
 
331
<tbody><tr>
 
332
<td class="parameter_name"><p>device</p></td>
 
333
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
334
<td class="parameter_annotations"> </td>
 
335
</tr></tbody>
 
336
</table></div>
 
337
</div>
 
338
<div class="refsect3">
 
339
<a name="id-1.3.5.12.5.6"></a><h4>Returns</h4>
 
340
<p> the path to the device node of the video capture
 
341
device. </p>
 
342
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
343
</div>
 
344
</div>
 
345
<hr>
 
346
<div class="refsect2">
 
347
<a name="cheese-camera-device-get-best-format"></a><h3>cheese_camera_device_get_best_format ()</h3>
 
348
<pre class="programlisting"><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="returnvalue">CheeseVideoFormat</span></a> *
 
349
cheese_camera_device_get_best_format (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
350
<p>Get the <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> with the highest resolution with a width greater
 
351
than 640 pixels and a framerate of greater than 15 FPS for this <em class="parameter"><code>device</code></em>
 
352
. If
 
353
no such format is found, get the highest available resolution instead.</p>
 
354
<div class="refsect3">
 
355
<a name="id-1.3.5.12.6.5"></a><h4>Parameters</h4>
 
356
<div class="informaltable"><table width="100%" border="0">
 
357
<colgroup>
 
358
<col width="150px" class="parameters_name">
 
359
<col class="parameters_description">
 
360
<col width="200px" class="parameters_annotations">
 
361
</colgroup>
 
362
<tbody><tr>
 
363
<td class="parameter_name"><p>device</p></td>
 
364
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
365
<td class="parameter_annotations"> </td>
 
366
</tr></tbody>
 
367
</table></div>
 
368
</div>
 
369
<div class="refsect3">
 
370
<a name="id-1.3.5.12.6.6"></a><h4>Returns</h4>
 
371
<p> the highest-resolution supported
 
372
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a>. </p>
 
373
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
374
</div>
 
375
</div>
 
376
<hr>
 
377
<div class="refsect2">
 
378
<a name="cheese-camera-device-get-caps-for-format"></a><h3>cheese_camera_device_get_caps_for_format ()</h3>
 
379
<pre class="programlisting"><span class="returnvalue">GstCaps</span> *
 
380
cheese_camera_device_get_caps_for_format
 
381
                               (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>,
 
382
                                <em class="parameter"><code><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> *format</code></em>);</pre>
 
383
<p>Get the <span class="type">GstCaps</span> for the given <em class="parameter"><code>format</code></em>
 
384
 on the <em class="parameter"><code>device</code></em>
 
385
.</p>
 
386
<div class="refsect3">
 
387
<a name="id-1.3.5.12.7.5"></a><h4>Parameters</h4>
 
388
<div class="informaltable"><table width="100%" border="0">
 
389
<colgroup>
 
390
<col width="150px" class="parameters_name">
 
391
<col class="parameters_description">
 
392
<col width="200px" class="parameters_annotations">
 
393
</colgroup>
 
394
<tbody>
 
395
<tr>
 
396
<td class="parameter_name"><p>device</p></td>
 
397
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
398
<td class="parameter_annotations"> </td>
 
399
</tr>
 
400
<tr>
 
401
<td class="parameter_name"><p>format</p></td>
 
402
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a></p></td>
 
403
<td class="parameter_annotations"> </td>
 
404
</tr>
 
405
</tbody>
 
406
</table></div>
 
407
</div>
 
408
<div class="refsect3">
 
409
<a name="id-1.3.5.12.7.6"></a><h4>Returns</h4>
 
410
<p> the <span class="type">GstCaps</span> for the given <em class="parameter"><code>format</code></em>
 
411
. </p>
 
412
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
413
</div>
 
414
</div>
 
415
<hr>
 
416
<div class="refsect2">
 
417
<a name="cheese-camera-device-get-format-list"></a><h3>cheese_camera_device_get_format_list ()</h3>
 
418
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 
419
cheese_camera_device_get_format_list (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
420
<p>Get the sorted list of <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> that the <em class="parameter"><code>device</code></em>
 
421
 supports.</p>
 
422
<div class="refsect3">
 
423
<a name="id-1.3.5.12.8.5"></a><h4>Parameters</h4>
 
424
<div class="informaltable"><table width="100%" border="0">
 
425
<colgroup>
 
426
<col width="150px" class="parameters_name">
 
427
<col class="parameters_description">
 
428
<col width="200px" class="parameters_annotations">
 
429
</colgroup>
 
430
<tbody><tr>
 
431
<td class="parameter_name"><p>device</p></td>
 
432
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
433
<td class="parameter_annotations"> </td>
 
434
</tr></tbody>
 
435
</table></div>
 
436
</div>
 
437
<div class="refsect3">
 
438
<a name="id-1.3.5.12.8.6"></a><h4>Returns</h4>
 
439
<p> list of
 
440
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a>. </p>
 
441
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Cheese.VideoFormat][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
 
442
</div>
 
443
</div>
 
444
<hr>
 
445
<div class="refsect2">
 
446
<a name="cheese-camera-device-get-src"></a><h3>cheese_camera_device_get_src ()</h3>
 
447
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
448
cheese_camera_device_get_src (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
 
449
<p>Get the name of the source GStreamer element for the <em class="parameter"><code>device</code></em>
 
450
. Currently,
 
451
this will be either v4lsrc or v4l2src, depending on the version of the
 
452
Video4Linux API that the device supports.</p>
 
453
<div class="refsect3">
 
454
<a name="id-1.3.5.12.9.5"></a><h4>Parameters</h4>
 
455
<div class="informaltable"><table width="100%" border="0">
 
456
<colgroup>
 
457
<col width="150px" class="parameters_name">
 
458
<col class="parameters_description">
 
459
<col width="200px" class="parameters_annotations">
 
460
</colgroup>
 
461
<tbody><tr>
 
462
<td class="parameter_name"><p>device</p></td>
 
463
<td class="parameter_description"><p>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a></p></td>
 
464
<td class="parameter_annotations"> </td>
 
465
</tr></tbody>
 
466
</table></div>
 
467
</div>
 
468
<div class="refsect3">
 
469
<a name="id-1.3.5.12.9.6"></a><h4>Returns</h4>
 
470
<p> the name of the source GStreamer element. </p>
 
471
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
472
</div>
 
473
</div>
 
474
</div>
 
475
<div class="refsect1">
 
476
<a name="CheeseCameraDevice.other_details"></a><h2>Types and Values</h2>
105
477
<div class="refsect2">
106
478
<a name="CheeseCameraDevice-struct"></a><h3>struct CheeseCameraDevice</h3>
107
479
<pre class="programlisting">struct CheeseCameraDevice;</pre>
108
 
<p>
109
 
Use the accessor functions below.
110
 
</p>
 
480
<p>Use the accessor functions below.</p>
111
481
</div>
112
482
<hr>
113
483
<div class="refsect2">
117
487
  gint height;
118
488
};
119
489
</pre>
120
 
<p>
121
 
A description of the resolution, in pixels, of the format to capture with a
122
 
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>.
123
 
</p>
124
 
<div class="variablelist"><table border="0" class="variablelist">
125
 
<colgroup>
126
 
<col align="left" valign="top">
127
 
<col>
128
 
</colgroup>
129
 
<tbody>
130
 
<tr>
131
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="CheeseVideoFormat-struct.width"></a>width</code></em>;</span></p></td>
132
 
<td>the width of of the video, in pixels</td>
133
 
</tr>
134
 
<tr>
135
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="CheeseVideoFormat-struct.height"></a>height</code></em>;</span></p></td>
136
 
<td>the height of the video, in pixels</td>
137
 
</tr>
138
 
</tbody>
139
 
</table></div>
140
 
</div>
141
 
<hr>
142
 
<div class="refsect2">
143
 
<a name="cheese-camera-device-new"></a><h3>cheese_camera_device_new ()</h3>
144
 
<pre class="programlisting"><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="returnvalue">CheeseCameraDevice</span></a> * cheese_camera_device_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> *uuid</code></em>,
145
 
                                                         <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> *device_node</code></em>,
146
 
                                                         <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>,
147
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> v4l_api_version</code></em>,
148
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
149
 
<p>
150
 
Tries to create a new <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> with the supplied parameters. If
151
 
construction fails, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, and <em class="parameter"><code>error</code></em> is set.
152
 
</p>
153
 
<div class="variablelist"><table border="0" class="variablelist">
154
 
<colgroup>
155
 
<col align="left" valign="top">
156
 
<col>
157
 
</colgroup>
158
 
<tbody>
159
 
<tr>
160
 
<td><p><span class="term"><em class="parameter"><code>uuid</code></em> :</span></p></td>
161
 
<td>UUID of the device, as supplied by udev</td>
162
 
</tr>
163
 
<tr>
164
 
<td><p><span class="term"><em class="parameter"><code>device_node</code></em> :</span></p></td>
165
 
<td>path to the device node of the video capture
166
 
device. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span>
167
 
</td>
168
 
</tr>
169
 
<tr>
170
 
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
171
 
<td>human-readable name of the device, as supplied by udev</td>
172
 
</tr>
173
 
<tr>
174
 
<td><p><span class="term"><em class="parameter"><code>v4l_api_version</code></em> :</span></p></td>
175
 
<td>version of the Video4Linux API that the device uses. Currently
176
 
either 1 or 2</td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
180
 
<td>a location to store errors</td>
181
 
</tr>
182
 
<tr>
183
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184
 
<td>a new <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
185
 
</td>
186
 
</tr>
187
 
</tbody>
188
 
</table></div>
189
 
</div>
190
 
<hr>
191
 
<div class="refsect2">
192
 
<a name="cheese-camera-device-get-name"></a><h3>cheese_camera_device_get_name ()</h3>
193
 
<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_camera_device_get_name       (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
194
 
<p>
195
 
Get a human-readable name for the device, as reported by udev, which is
196
 
suitable for display to a user.
197
 
</p>
198
 
<div class="variablelist"><table border="0" class="variablelist">
199
 
<colgroup>
200
 
<col align="left" valign="top">
201
 
<col>
202
 
</colgroup>
203
 
<tbody>
204
 
<tr>
205
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
206
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
207
 
</td>
208
 
</tr>
209
 
<tr>
210
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
211
 
<td>the human-readable name of the video capture device. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
212
 
</td>
213
 
</tr>
214
 
</tbody>
215
 
</table></div>
216
 
</div>
217
 
<hr>
218
 
<div class="refsect2">
219
 
<a name="cheese-camera-device-get-uuid"></a><h3>cheese_camera_device_get_uuid ()</h3>
220
 
<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_camera_device_get_uuid       (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
221
 
<p>
222
 
Get the UUID of the <em class="parameter"><code>device</code></em>, as reported by udev.
223
 
</p>
224
 
<div class="variablelist"><table border="0" class="variablelist">
225
 
<colgroup>
226
 
<col align="left" valign="top">
227
 
<col>
228
 
</colgroup>
229
 
<tbody>
230
 
<tr>
231
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
232
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
233
 
</td>
234
 
</tr>
235
 
<tr>
236
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237
 
<td>the UUID of the video capture device. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
238
 
</td>
239
 
</tr>
240
 
</tbody>
241
 
</table></div>
242
 
</div>
243
 
<hr>
244
 
<div class="refsect2">
245
 
<a name="cheese-camera-device-get-device-node"></a><h3>cheese_camera_device_get_device_node ()</h3>
246
 
<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_camera_device_get_device_node
247
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
248
 
<p>
249
 
Get the path to the device node associated with the <em class="parameter"><code>device</code></em>.
250
 
</p>
251
 
<div class="variablelist"><table border="0" class="variablelist">
252
 
<colgroup>
253
 
<col align="left" valign="top">
254
 
<col>
255
 
</colgroup>
256
 
<tbody>
257
 
<tr>
258
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
259
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
260
 
</td>
261
 
</tr>
262
 
<tr>
263
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
264
 
<td>the path to the device node of the video capture
265
 
device. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
266
 
</td>
267
 
</tr>
268
 
</tbody>
269
 
</table></div>
270
 
</div>
271
 
<hr>
272
 
<div class="refsect2">
273
 
<a name="cheese-camera-device-get-best-format"></a><h3>cheese_camera_device_get_best_format ()</h3>
274
 
<pre class="programlisting"><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="returnvalue">CheeseVideoFormat</span></a> * cheese_camera_device_get_best_format
275
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
276
 
<p>
277
 
Get the <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> with the highest resolution with a width greater
278
 
than 640 pixels and a framerate of greater than 15 FPS for this <em class="parameter"><code>device</code></em>. If
279
 
no such format is found, get the highest available resolution instead.
280
 
</p>
281
 
<div class="variablelist"><table border="0" class="variablelist">
282
 
<colgroup>
283
 
<col align="left" valign="top">
284
 
<col>
285
 
</colgroup>
286
 
<tbody>
287
 
<tr>
288
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
289
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
290
 
</td>
291
 
</tr>
292
 
<tr>
293
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
294
 
<td>the highest-resolution supported
295
 
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
296
 
</td>
297
 
</tr>
298
 
</tbody>
299
 
</table></div>
300
 
</div>
301
 
<hr>
302
 
<div class="refsect2">
303
 
<a name="cheese-camera-device-get-caps-for-format"></a><h3>cheese_camera_device_get_caps_for_format ()</h3>
304
 
<pre class="programlisting"><span class="returnvalue">GstCaps</span> *           cheese_camera_device_get_caps_for_format
305
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>,
306
 
                                                         <em class="parameter"><code><a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> *format</code></em>);</pre>
307
 
<p>
308
 
Get the <span class="type">GstCaps</span> for the given <em class="parameter"><code>format</code></em> on the <em class="parameter"><code>device</code></em>.
309
 
</p>
310
 
<div class="variablelist"><table border="0" class="variablelist">
311
 
<colgroup>
312
 
<col align="left" valign="top">
313
 
<col>
314
 
</colgroup>
315
 
<tbody>
316
 
<tr>
317
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
318
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
319
 
</td>
320
 
</tr>
321
 
<tr>
322
 
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
323
 
<td>a <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a>
324
 
</td>
325
 
</tr>
326
 
<tr>
327
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
328
 
<td>the <span class="type">GstCaps</span> for the given <em class="parameter"><code>format</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
329
 
</td>
330
 
</tr>
331
 
</tbody>
332
 
</table></div>
333
 
</div>
334
 
<hr>
335
 
<div class="refsect2">
336
 
<a name="cheese-camera-device-get-format-list"></a><h3>cheese_camera_device_get_format_list ()</h3>
337
 
<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_camera_device_get_format_list
338
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
339
 
<p>
340
 
Get the sorted list of <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> that the <em class="parameter"><code>device</code></em> supports.
341
 
</p>
342
 
<div class="variablelist"><table border="0" class="variablelist">
343
 
<colgroup>
344
 
<col align="left" valign="top">
345
 
<col>
346
 
</colgroup>
347
 
<tbody>
348
 
<tr>
349
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
350
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
351
 
</td>
352
 
</tr>
353
 
<tr>
354
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355
 
<td>list of
356
 
<a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Cheese.VideoFormat][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
357
 
</td>
358
 
</tr>
359
 
</tbody>
360
 
</table></div>
361
 
</div>
362
 
<hr>
363
 
<div class="refsect2">
364
 
<a name="cheese-camera-device-get-src"></a><h3>cheese_camera_device_get_src ()</h3>
365
 
<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_camera_device_get_src        (<em class="parameter"><code><a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> *device</code></em>);</pre>
366
 
<p>
367
 
Get the name of the source GStreamer element for the <em class="parameter"><code>device</code></em>. Currently,
368
 
this will be either v4lsrc or v4l2src, depending on the version of the
369
 
Video4Linux API that the device supports.
370
 
</p>
371
 
<div class="variablelist"><table border="0" class="variablelist">
372
 
<colgroup>
373
 
<col align="left" valign="top">
374
 
<col>
375
 
</colgroup>
376
 
<tbody>
377
 
<tr>
378
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
379
 
<td>a <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>
380
 
</td>
381
 
</tr>
382
 
<tr>
383
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
384
 
<td>the name of the source GStreamer element. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
385
 
</td>
386
 
</tr>
387
 
</tbody>
388
 
</table></div>
 
490
<p>A description of the resolution, in pixels, of the format to capture with a
 
491
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a>.</p>
 
492
<div class="refsect3">
 
493
<a name="id-1.3.5.13.3.5"></a><h4>Members</h4>
 
494
<div class="informaltable"><table width="100%" border="0">
 
495
<colgroup>
 
496
<col width="300px" class="struct_members_name">
 
497
<col class="struct_members_description">
 
498
<col width="200px" class="struct_members_annotations">
 
499
</colgroup>
 
500
<tbody>
 
501
<tr>
 
502
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="CheeseVideoFormat-struct.width"></a>width</code></em>;</p></td>
 
503
<td class="struct_member_description"><p>the width of of the video, in pixels</p></td>
 
504
<td class="struct_member_annotations"> </td>
 
505
</tr>
 
506
<tr>
 
507
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="CheeseVideoFormat-struct.height"></a>height</code></em>;</p></td>
 
508
<td class="struct_member_description"><p>the height of the video, in pixels</p></td>
 
509
<td class="struct_member_annotations"> </td>
 
510
</tr>
 
511
</tbody>
 
512
</table></div>
 
513
</div>
389
514
</div>
390
515
</div>
391
516
<div class="refsect1">
392
517
<a name="CheeseCameraDevice.property-details"></a><h2>Property Details</h2>
393
518
<div class="refsect2">
394
 
<a name="CheeseCameraDevice--device-node"></a><h3>The <code class="literal">"device-node"</code> property</h3>
395
 
<pre class="programlisting">  "device-node"              <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>
396
 
<p>
397
 
Path to the device node of the video capture device.
398
 
</p>
399
 
<p>Default value: NULL</p>
400
 
</div>
401
 
<hr>
402
 
<div class="refsect2">
403
 
<a name="CheeseCameraDevice--name"></a><h3>The <code class="literal">"name"</code> property</h3>
404
 
<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>
405
 
<p>
406
 
Human-readable name of the video capture device, for display to the user.
407
 
</p>
408
 
<p>Default value: NULL</p>
409
 
</div>
410
 
<hr>
411
 
<div class="refsect2">
412
 
<a name="CheeseCameraDevice--uuid"></a><h3>The <code class="literal">"uuid"</code> property</h3>
413
 
<pre class="programlisting">  "uuid"                     <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>
414
 
<p>
415
 
UUID of the video capture device.
416
 
</p>
417
 
<p>Default value: NULL</p>
418
 
</div>
419
 
<hr>
420
 
<div class="refsect2">
421
 
<a name="CheeseCameraDevice--v4l-api-version"></a><h3>The <code class="literal">"v4l-api-version"</code> property</h3>
422
 
<pre class="programlisting">  "v4l-api-version"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
423
 
<p>
424
 
Version of the Video4Linux API that the device supports. Currently, either
425
 
1 or 2 are supported.
426
 
</p>
 
519
<a name="CheeseCameraDevice--device-node"></a><h3>The <code class="literal">“device-node”</code> property</h3>
 
520
<pre class="programlisting">  “device-node”              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
521
<p>Path to the device node of the video capture device.</p>
 
522
<p>Flags: Read / Write / Construct Only</p>
 
523
<p>Default value: NULL</p>
 
524
</div>
 
525
<hr>
 
526
<div class="refsect2">
 
527
<a name="CheeseCameraDevice--name"></a><h3>The <code class="literal">“name”</code> property</h3>
 
528
<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>
 
529
<p>Human-readable name of the video capture device, for display to the user.</p>
 
530
<p>Flags: Read / Write / Construct Only</p>
 
531
<p>Default value: NULL</p>
 
532
</div>
 
533
<hr>
 
534
<div class="refsect2">
 
535
<a name="CheeseCameraDevice--uuid"></a><h3>The <code class="literal">“uuid”</code> property</h3>
 
536
<pre class="programlisting">  “uuid”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
537
<p>UUID of the video capture device.</p>
 
538
<p>Flags: Read / Write / Construct Only</p>
 
539
<p>Default value: NULL</p>
 
540
</div>
 
541
<hr>
 
542
<div class="refsect2">
 
543
<a name="CheeseCameraDevice--v4l-api-version"></a><h3>The <code class="literal">“v4l-api-version”</code> property</h3>
 
544
<pre class="programlisting">  “v4l-api-version”          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
 
545
<p>Version of the Video4Linux API that the device supports. Currently, either
 
546
1 or 2 are supported.</p>
 
547
<p>Flags: Read / Write / Construct Only</p>
427
548
<p>Allowed values: [1,2]</p>
428
549
<p>Default value: 2</p>
429
550
</div>
431
552
</div>
432
553
<div class="footer">
433
554
<hr>
434
 
          Generated by GTK-Doc V1.19.1</div>
 
555
          Generated by GTK-Doc V1.20.1</div>
435
556
</body>
436
557
</html>
 
 
b'\\ No newline at end of file'