libcheese/cheese-fileutil.h

   1 /*
   2  * Copyright © 2007,2008 daniel g. siegel <dgsiegel@gnome.org>
   3  * Copyright © 2007,2008 Jaap Haitsma <jaap@haitsma.org>
   4  * Copyright © 2008 Felix Kaser <f.kaser@gmx.net>
   5  *
   6  * Licensed under the GNU General Public License Version 2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef CHEESE_FILEUTIL_H_
  23 #define CHEESE_FILEUTIL_H_
  24
  25 #include <glib-object.h>
  26
  27 /**
  28  * CHEESE_PHOTO_NAME_SUFFIX:
  29  *
  30  * The filename suffix for photos saved by Cheese.
  31  */
  32 #define CHEESE_PHOTO_NAME_SUFFIX ".jpg"
  33
  34 /**
  35  * CHEESE_VIDEO_NAME_SUFFIX:
  36  *
  37  * The filename suffix for videos saved by Cheese.
  38  */
  39 #define CHEESE_VIDEO_NAME_SUFFIX ".webm"
  40
  41 G_BEGIN_DECLS
  42
  43 /**
  44  * CheeseFileUtil:
  45  *
  46  * Use the accessor functions below.
  47  */
  48 struct _CheeseFileUtil
  49 {
  50   /*< private >*/
  51   GObject parent;
  52   void *unused;
  53 };
  54
  55 /**
  56  * CheeseMediaMode:
  57  * @CHEESE_MEDIA_MODE_PHOTO: photo
  58  * @CHEESE_MEDIA_MODE_VIDEO: video
  59  * @CHEESE_MEDIA_MODE_BURST: a burst of photos
  60  *
  61  * The media type, used for generating filenames with
  62  * cheese_fileutil_get_new_media_filename().
  63  */
  64 typedef enum
  65 {
  66   CHEESE_MEDIA_MODE_PHOTO,
  67   CHEESE_MEDIA_MODE_VIDEO,
  68   CHEESE_MEDIA_MODE_BURST
  69 } CheeseMediaMode;
  70
  71
  72 #define CHEESE_TYPE_FILEUTIL (cheese_fileutil_get_type ())
  73 G_DECLARE_FINAL_TYPE (CheeseFileUtil, cheese_fileutil, CHEESE, FILEUTIL, GObject)
  74
  75 CheeseFileUtil *cheese_fileutil_new (void);
  76 const gchar *cheese_fileutil_get_video_path (CheeseFileUtil *fileutil);
  77 const gchar *cheese_fileutil_get_photo_path (CheeseFileUtil *fileutil);
  78 gchar       *cheese_fileutil_get_new_media_filename (CheeseFileUtil *fileutil, CheeseMediaMode mode);
  79 void         cheese_fileutil_reset_burst (CheeseFileUtil *fileutil);
  80
  81 G_END_DECLS
  82
  83 #endif /* __CHEESE_FILEUTIL_H__ */