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 #ifndef VLC_UPDATE_H
  26 #define VLC_UPDATE_H
  27
  28 /**
  29  * \file
  30  * This file defines update API in vlc
  31  */
  32
  33 /**
  34  * \defgroup update Update
  35  *
  36  * @{
  37  */
  38
  39 #ifdef UPDATE_CHECK
  40
  41 /**
  42  * Describes an update VLC release number
  43  */
  44 struct update_release_t
  45 {
  46     int i_major;        ///< Version major
  47     int i_minor;        ///< Version minor
  48     int i_revision;     ///< Version revision
  49     unsigned char extra;///< Version extra
  50     char* psz_url;      ///< Download URL
  51     char* psz_desc;     ///< Release description
  52 };
  53
  54 #endif /* UPDATE_CHECK */
  55
  56 typedef struct update_release_t update_release_t;
  57
  58 VLC_EXPORT( update_t *, update_New, ( vlc_object_t * ) );
  59 #define update_New( a ) update_New( VLC_OBJECT( a ) )
  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 *, const char* ) );
  64 VLC_EXPORT( update_release_t*, update_GetRelease, ( update_t * ) );
  65
  66 /**
  67  * @}
  68  */
  69
  70 #endif /* _VLC_UPDATE_H */