git.sesse.net Git - vlc/blob - bindings/libvlcpp/src/libvlc.hpp

   1 /*****************************************************************************
   2  * libvlc.hpp: Main libvlc++ class
   3  *****************************************************************************
   4  * Copyright (C) 2010 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rémi Duraffort <ivoire@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LIBVLCPP_HPP
  25 #define LIBVLCPP_HPP
  26
  27 #include <vlc/libvlc.h>
  28
  29 namespace libvlc
  30 {
  31
  32 class Media;
  33 class MediaPlayer;
  34
  35 class libVLC
  36 {
  37 public:
  38     /**
  39      * Contructor
  40      * @param i_argc: the number of arguments
  41      * @param argv: arguments given to libvlc
  42      */
  43     libVLC( int i_argc, const char* const* argv );
  44
  45     /* Destructor */
  46     ~libVLC();
  47
  48     /**
  49      * Get the version of libVLC
  50      * @return the version
  51      */
  52     const char *version();
  53
  54     /**
  55      * Get the compiler use for this binari
  56      * @return the compiler used
  57      */
  58     const char *compiler();
  59
  60     /**
  61      * Get the chanset of libvlc
  62      * @return thje changeset
  63      */
  64     const char *chanset();
  65
  66 private:
  67     /**
  68      * Get the instance of libvlc that cannot be modified
  69      * @return the instance of libvlc
  70      */
  71     libvlc_instance_t *instance();
  72
  73     /** The instance of libvlc */
  74     libvlc_instance_t *m_instance;
  75
  76     /**
  77      * Some friends class to access the instance of libvlc
  78      */
  79     friend class Media;
  80     friend class MediaPlayer;
  81 };
  82
  83 };
  84
  85 #endif // LIBVLCPP_HPP
  86