libcheese-doc 3.18.1-2ubuntu3 / usr / share / gtk-doc / html / cheese / CheeseFileUtil.html

This file is indexed.

/usr/share/gtk-doc/html/cheese/CheeseFileUtil.html is in libcheese-doc 3.18.1-2ubuntu3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CheeseFileUtil: Cheese Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Cheese Reference Manual">
<link rel="up" href="libcheese.html" title="libcheese">
<link rel="prev" href="CheeseEffect.html" title="CheeseEffect">
<link rel="next" href="libcheese-gtk.html" title="libcheese-gtk">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#CheeseFileUtil.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CheeseFileUtil.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libcheese.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CheeseEffect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libcheese-gtk.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CheeseFileUtil"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CheeseFileUtil.top_of_page"></a>CheeseFileUtil</span></h2>
<p>CheeseFileUtil — File utility functions for Cheese</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CheeseFileUtil.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="CheeseFileUtil.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="returnvalue">CheeseFileUtil</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-new" title="cheese_fileutil_new ()">cheese_fileutil_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-get-new-media-filename" title="cheese_fileutil_get_new_media_filename ()">cheese_fileutil_get_new_media_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-get-photo-path" title="cheese_fileutil_get_photo_path ()">cheese_fileutil_get_photo_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-get-video-path" title="cheese_fileutil_get_video_path ()">cheese_fileutil_get_video_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-reset-burst" title="cheese_fileutil_reset_burst ()">cheese_fileutil_reset_burst</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="CheeseFileUtil.html#CheeseFileUtil-struct" title="CheeseFileUtil">CheeseFileUtil</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="CheeseFileUtil.html#CHEESE-PHOTO-NAME-SUFFIX:CAPS" title="CHEESE_PHOTO_NAME_SUFFIX">CHEESE_PHOTO_NAME_SUFFIX</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="CheeseFileUtil.html#CHEESE-VIDEO-NAME-SUFFIX:CAPS" title="CHEESE_VIDEO_NAME_SUFFIX">CHEESE_VIDEO_NAME_SUFFIX</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="CheeseFileUtil.html#CheeseMediaMode" title="enum CheeseMediaMode">CheeseMediaMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> CheeseFileUtil
</pre>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;cheese/cheese-fileutil.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.description"></a><h2>Description</h2>
<p><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> provides some helpful utility functions for looking up paths
for photos and videos.</p>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cheese-fileutil-new"></a><h3>cheese_fileutil_new ()</h3>
<pre class="programlisting"><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="returnvalue">CheeseFileUtil</span></a> *
cheese_fileutil_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> object.</p>
<div class="refsect3">
<a name="id-1.3.8.9.2.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-fileutil-get-new-media-filename"></a><h3>cheese_fileutil_get_new_media_filename ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
cheese_fileutil_get_new_media_filename
                               (<em class="parameter"><code><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> *fileutil</code></em>,
                                <em class="parameter"><code><a class="link" href="CheeseFileUtil.html#CheeseMediaMode" title="enum CheeseMediaMode"><span class="type">CheeseMediaMode</span></a> mode</code></em>);</pre>
<p>Creates a filename for one of the three media types: photo, photo burst or
video. If a filename for a photo burst image was previously created, this
function increments the burst count automatically. To start a new burst,
first call <a class="link" href="CheeseFileUtil.html#cheese-fileutil-reset-burst" title="cheese_fileutil_reset_burst ()"><code class="function">cheese_fileutil_reset_burst()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>fileutil</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>the type of media to create a filename for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.9.3.6"></a><h4>Returns</h4>
<p> a new filename. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-fileutil-get-photo-path"></a><h3>cheese_fileutil_get_photo_path ()</h3>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
cheese_fileutil_get_photo_path (<em class="parameter"><code><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> *fileutil</code></em>);</pre>
<p>Get the path where Cheese photo files are stored.</p>
<div class="refsect3">
<a name="id-1.3.8.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>fileutil</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.9.4.6"></a><h4>Returns</h4>
<p> the Cheese photo path. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-fileutil-get-video-path"></a><h3>cheese_fileutil_get_video_path ()</h3>
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
cheese_fileutil_get_video_path (<em class="parameter"><code><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> *fileutil</code></em>);</pre>
<p>Get the path where Cheese video files are stored.</p>
<div class="refsect3">
<a name="id-1.3.8.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>fileutil</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.9.5.6"></a><h4>Returns</h4>
<p> the Cheese video path. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-fileutil-reset-burst"></a><h3>cheese_fileutil_reset_burst ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cheese_fileutil_reset_burst (<em class="parameter"><code><a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a> *fileutil</code></em>);</pre>
<p>Resets the burst counter, so that calling
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-get-new-media-filename" title="cheese_fileutil_get_new_media_filename ()"><code class="function">cheese_fileutil_get_new_media_filename()</code></a> with a photo burst starts a new
burst of photos.</p>
<div class="refsect3">
<a name="id-1.3.8.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>fileutil</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseFileUtil.html" title="CheeseFileUtil"><span class="type">CheeseFileUtil</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="CheeseFileUtil.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CheeseFileUtil-struct"></a><h3>CheeseFileUtil</h3>
<pre class="programlisting">typedef struct _CheeseFileUtil CheeseFileUtil;</pre>
<p>Use the accessor functions below.</p>
</div>
<hr>
<div class="refsect2">
<a name="CHEESE-PHOTO-NAME-SUFFIX:CAPS"></a><h3>CHEESE_PHOTO_NAME_SUFFIX</h3>
<pre class="programlisting">#define CHEESE_PHOTO_NAME_SUFFIX ".jpg"
</pre>
<p>The filename suffix for photos saved by Cheese.</p>
</div>
<hr>
<div class="refsect2">
<a name="CHEESE-VIDEO-NAME-SUFFIX:CAPS"></a><h3>CHEESE_VIDEO_NAME_SUFFIX</h3>
<pre class="programlisting">#define CHEESE_VIDEO_NAME_SUFFIX ".webm"
</pre>
<p>The filename suffix for videos saved by Cheese.</p>
</div>
<hr>
<div class="refsect2">
<a name="CheeseMediaMode"></a><h3>enum CheeseMediaMode</h3>
<p>The media type, used for generating filenames with
<a class="link" href="CheeseFileUtil.html#cheese-fileutil-get-new-media-filename" title="cheese_fileutil_get_new_media_filename ()"><code class="function">cheese_fileutil_get_new_media_filename()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.5.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CHEESE-MEDIA-MODE-PHOTO:CAPS"></a>CHEESE_MEDIA_MODE_PHOTO</p></td>
<td class="enum_member_description">
<p>photo</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CHEESE-MEDIA-MODE-VIDEO:CAPS"></a>CHEESE_MEDIA_MODE_VIDEO</p></td>
<td class="enum_member_description">
<p>video</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CHEESE-MEDIA-MODE-BURST:CAPS"></a>CHEESE_MEDIA_MODE_BURST</p></td>
<td class="enum_member_description">
<p>a burst of photos</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.