libcheese/cheese.c

   1 /*
   2  * Copyright © 2011 David King <amigadave@amigadave.com>
   3  *
   4  * Licensed under the GNU General Public License Version 2
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <clutter-gst/clutter-gst.h>
  21
  22 #include "cheese.h"
  23
  24 /**
  25  * SECTION:cheese-init
  26  * @short_description: Initialize libcheese
  27  * @stability: Unstable
  28  * @include: cheese/cheese.h
  29  *
  30  * Call cheese_init() to initialize libcheese.
  31  */
  32
  33
  34 /**
  35  * cheese_init:
  36  * @argc: (allow-none): pointer to the argument list count
  37  * @argv: (allow-none): pointer to the argument list vector
  38  *
  39  * Initialize libcheese, by initializing Clutter and GStreamer.
  40  *
  41  * Returns: %TRUE if the initialization was successful, %FALSE otherwise
  42  */
  43 gboolean
  44 cheese_init (int *argc, char ***argv)
  45 {
  46     ClutterInitError error;
  47
  48     error = clutter_gst_init (argc, argv);
  49
  50     if (error != CLUTTER_INIT_SUCCESS)
  51         return FALSE;
  52
  53     return TRUE;
  54 }