~ubuntu-branches/ubuntu/quantal/cheese/quantal

« back to all changes in this revision

Viewing changes to .pc/debian-changes-3.2.2-0ubuntu1/docs/reference/html/CheeseCameraDeviceMonitor.html

  • Committer: Package Import Robot
  • Author(s): Michael Terry
  • Date: 2011-11-22 15:02:36 UTC
  • Revision ID: package-import@ubuntu.com-20111122150236-6fs4o0adktyojxm2
Tags: 3.2.2-0ubuntu2
* debian/control:
  - Drop Vcs-Bzr and update maintainer; this is in universe, not maintained
    by the Desktop Team.
* debian/patches/debian-changes-3.2.2-0ubuntu1:
  - Dropped, looks like an accidental change
* debian/patches/add-missing-cheese-common-vapi.patch:
  - Add missing file from the tarball, grabbed from bzr.  Fixes FTBFS

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>CheeseCameraDeviceMonitor</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
 
<link rel="home" href="index.html" title="Cheese Reference Manual">
8
 
<link rel="up" href="ch01.html" title="Cheese Overview">
9
 
<link rel="prev" href="CheeseEffect.html" title="CheeseEffect">
10
 
<link rel="next" href="CheeseAvatarChooser.html" title="CheeseAvatarChooser">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="CheeseEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Cheese Reference Manual</th>
21
 
<td><a accesskey="n" href="CheeseAvatarChooser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#CheeseCameraDeviceMonitor.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#CheeseCameraDeviceMonitor.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#CheeseCameraDeviceMonitor.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#CheeseCameraDeviceMonitor.signals" class="shortcut">Signals</a>
31
 
</td></tr>
32
 
</table>
33
 
<div class="refentry">
34
 
<a name="CheeseCameraDeviceMonitor"></a><div class="titlepage"></div>
35
 
<div class="refnamediv"><table width="100%"><tr>
36
 
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="CheeseCameraDeviceMonitor.top_of_page"></a>CheeseCameraDeviceMonitor</span></h2>
38
 
<p>CheeseCameraDeviceMonitor — Simple object to enumerate v4l devices</p>
39
 
</td>
40
 
<td valign="top" align="right"></td>
41
 
</tr></table></div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="CheeseCameraDeviceMonitor.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">
45
 
#include &lt;cheese/cheese-camera-device-monitor.h&gt;
46
 
 
47
 
struct              <a class="link" href="CheeseCameraDeviceMonitor.html#CheeseCameraDeviceMonitorClass" title="struct CheeseCameraDeviceMonitorClass">CheeseCameraDeviceMonitorClass</a>;
48
 
struct              <a class="link" href="CheeseCameraDeviceMonitor.html#CheeseCameraDeviceMonitor-struct" title="struct CheeseCameraDeviceMonitor">CheeseCameraDeviceMonitor</a>;
49
 
<a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="returnvalue">CheeseCameraDeviceMonitor</span></a> * <a class="link" href="CheeseCameraDeviceMonitor.html#cheese-camera-device-monitor-new" title="cheese_camera_device_monitor_new ()">cheese_camera_device_monitor_new</a>
50
 
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
51
 
<span class="returnvalue">void</span>                <a class="link" href="CheeseCameraDeviceMonitor.html#cheese-camera-device-monitor-coldplug" title="cheese_camera_device_monitor_coldplug ()">cheese_camera_device_monitor_coldplug</a>
52
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> *monitor</code></em>);
53
 
</pre>
54
 
</div>
55
 
<div class="refsect1">
56
 
<a name="CheeseCameraDeviceMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
57
 
<pre class="synopsis">
58
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
59
 
   +----CheeseCameraDeviceMonitor
60
 
</pre>
61
 
</div>
62
 
<div class="refsect1">
63
 
<a name="CheeseCameraDeviceMonitor.signals"></a><h2>Signals</h2>
64
 
<pre class="synopsis">
65
 
  "<a class="link" href="CheeseCameraDeviceMonitor.html#CheeseCameraDeviceMonitor-added" title='The "added" signal'>added</a>"                                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
66
 
  "<a class="link" href="CheeseCameraDeviceMonitor.html#CheeseCameraDeviceMonitor-removed" title='The "removed" signal'>removed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a>
67
 
</pre>
68
 
</div>
69
 
<div class="refsect1">
70
 
<a name="CheeseCameraDeviceMonitor.description"></a><h2>Description</h2>
71
 
<p>
72
 
<a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> provides a basic interface for
73
 
video4linux device enumeration and hotplugging.
74
 
</p>
75
 
<p>
76
 
It uses either GUdev or some platform specific code to list video
77
 
devices.  It is also capable (right now in linux only, with the
78
 
udev backend) to monitor device plugging and emit a
79
 
CheeseCameraDeviceMonitor::added or
80
 
CheeseCameraDeviceMonitor::removed signal when an event happens.
81
 
</p>
82
 
</div>
83
 
<div class="refsect1">
84
 
<a name="CheeseCameraDeviceMonitor.details"></a><h2>Details</h2>
85
 
<div class="refsect2">
86
 
<a name="CheeseCameraDeviceMonitorClass"></a><h3>struct CheeseCameraDeviceMonitorClass</h3>
87
 
<pre class="programlisting">struct CheeseCameraDeviceMonitorClass {
88
 
  GObjectClass parent_class;
89
 
 
90
 
  void (*added)(CheeseCameraDeviceMonitor *camera,
91
 
                const char                *id,
92
 
                const char                *device_file,
93
 
                const char                *product_name,
94
 
                int                        api_version);
95
 
  void (*removed)(CheeseCameraDeviceMonitor *camera, const char *id);
96
 
};
97
 
</pre>
98
 
</div>
99
 
<hr>
100
 
<div class="refsect2">
101
 
<a name="CheeseCameraDeviceMonitor-struct"></a><h3>struct CheeseCameraDeviceMonitor</h3>
102
 
<pre class="programlisting">struct CheeseCameraDeviceMonitor;</pre>
103
 
</div>
104
 
<hr>
105
 
<div class="refsect2">
106
 
<a name="cheese-camera-device-monitor-new"></a><h3>cheese_camera_device_monitor_new ()</h3>
107
 
<pre class="programlisting"><a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="returnvalue">CheeseCameraDeviceMonitor</span></a> * cheese_camera_device_monitor_new
108
 
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
109
 
<p>
110
 
Returns a new <a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> object.
111
 
</p>
112
 
<div class="variablelist"><table border="0">
113
 
<col align="left" valign="top">
114
 
<tbody><tr>
115
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
116
 
<td>a new <a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> object.</td>
117
 
</tr></tbody>
118
 
</table></div>
119
 
</div>
120
 
<hr>
121
 
<div class="refsect2">
122
 
<a name="cheese-camera-device-monitor-coldplug"></a><h3>cheese_camera_device_monitor_coldplug ()</h3>
123
 
<pre class="programlisting"><span class="returnvalue">void</span>                cheese_camera_device_monitor_coldplug
124
 
                                                        (<em class="parameter"><code><a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> *monitor</code></em>);</pre>
125
 
<p>
126
 
Will actively look for plugged in cameras and emit
127
 
::added for those new cameras.
128
 
This is only required when your program starts, so as to connect
129
 
to those signals before they are emitted.
130
 
</p>
131
 
<div class="variablelist"><table border="0">
132
 
<col align="left" valign="top">
133
 
<tbody><tr>
134
 
<td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
135
 
<td>a <a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> object.</td>
136
 
</tr></tbody>
137
 
</table></div>
138
 
</div>
139
 
</div>
140
 
<div class="refsect1">
141
 
<a name="CheeseCameraDeviceMonitor.signal-details"></a><h2>Signal Details</h2>
142
 
<div class="refsect2">
143
 
<a name="CheeseCameraDeviceMonitor-added"></a><h3>The <code class="literal">"added"</code> signal</h3>
144
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> *device,
145
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>                     *id,
146
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>                     *device,
147
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>                     *product_name,
148
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                       api_version,
149
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                   user_data)         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
150
 
<p>
151
 
The ::added signal is emitted when a camera is added, or on start-up
152
 
after <span class="type">cheese_camera_device_monitor_colplug</span> is called.
153
 
</p>
154
 
<div class="variablelist"><table border="0">
155
 
<col align="left" valign="top">
156
 
<tbody>
157
 
<tr>
158
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
159
 
<td>A private object representing the newly added camera.</td>
160
 
</tr>
161
 
<tr>
162
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
163
 
<td>Device unique identifier.</td>
164
 
</tr>
165
 
<tr>
166
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
167
 
<td>Device file name  (e.g. /dev/video2).</td>
168
 
</tr>
169
 
<tr>
170
 
<td><p><span class="term"><em class="parameter"><code>product_name</code></em> :</span></p></td>
171
 
<td>Device product name (human readable, intended to be displayed in a UI).</td>
172
 
</tr>
173
 
<tr>
174
 
<td><p><span class="term"><em class="parameter"><code>api_version</code></em> :</span></p></td>
175
 
<td>Supported video4linux API: 1 for v4l, 2 for v4l2.</td>
176
 
</tr>
177
 
<tr>
178
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
179
 
<td>user data set when the signal handler was connected.</td>
180
 
</tr>
181
 
</tbody>
182
 
</table></div>
183
 
</div>
184
 
<hr>
185
 
<div class="refsect2">
186
 
<a name="CheeseCameraDeviceMonitor-removed"></a><h3>The <code class="literal">"removed"</code> signal</h3>
187
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor"><span class="type">CheeseCameraDeviceMonitor</span></a> *device,
188
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>                     *id,
189
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre>
190
 
<p>
191
 
The ::removed signal is emitted when a camera is un-plugged, or
192
 
disabled on the system.
193
 
</p>
194
 
<div class="variablelist"><table border="0">
195
 
<col align="left" valign="top">
196
 
<tbody>
197
 
<tr>
198
 
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
199
 
<td>A private object representing the newly added camera</td>
200
 
</tr>
201
 
<tr>
202
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
203
 
<td>Device unique identifier.</td>
204
 
</tr>
205
 
<tr>
206
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
207
 
<td>user data set when the signal handler was connected.</td>
208
 
</tr>
209
 
</tbody>
210
 
</table></div>
211
 
</div>
212
 
</div>
213
 
</div>
214
 
<div class="footer">
215
 
<hr>
216
 
          Generated by GTK-Doc V1.18</div>
217
 
</body>
218
 
</html>
 
 
b'\\ No newline at end of file'