git.sesse.net Git - vlc/blob - include/vlc_update.h

   1 /*****************************************************************************
   2  * vlc_update.h: VLC update download
   3  *****************************************************************************
   4  * Copyright © 2005-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
   8  *          Rafaël Carré <funman@videolanorg>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either release 2 of the License, or
  13  * (at your option) any later release.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 #ifdef UPDATE_CHECK
  30
  31 #ifndef _VLC_UPDATE_H
  32 #define _VLC_UPDATE_H
  33
  34 #include <vlc/vlc.h>
  35
  36 /**
  37  * \defgroup update Update
  38  *
  39  * @{
  40  */
  41
  42 /**
  43  * Describes an update VLC release number
  44  */
  45 struct update_release_t
  46 {
  47     int i_major;        ///< Version major
  48     int i_minor;        ///< Version minor
  49     int i_revision;     ///< Version revision
  50     unsigned char extra;///< Version extra
  51     char* psz_url;      ///< Download URL
  52     char* psz_desc;     ///< Release description
  53 };
  54
  55 typedef struct update_release_t update_release_t;
  56
  57 #define update_New( a ) __update_New( VLC_OBJECT( a ) )
  58
  59 VLC_EXPORT( update_t *, __update_New, ( vlc_object_t * ) );
  60 VLC_EXPORT( void, update_Delete, ( update_t * ) );
  61 VLC_EXPORT( void, update_Check, ( update_t *, void (*callback)( void*, bool ), void * ) );
  62 VLC_EXPORT( bool, update_NeedUpgrade, ( update_t * ) );
  63 VLC_EXPORT( void, update_Download, ( update_t *, char* ) );
  64 VLC_EXPORT( update_release_t*, update_GetRelease, ( update_t * ) );
  65
  66 /**
  67  * @}
  68  */
  69
  70 #endif
  71
  72 #endif