include/vlc_update.h

   1 /*****************************************************************************
   2  * vlc_update.h: VLC update download
   3  *****************************************************************************
   4  * Copyright © 2005-2007 VLC authors and VideoLAN
   5  *
   6  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
   7  *          Rafaël Carré <funman@videolanorg>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either release 2 of the License, or
  12  * (at your option) any later release.
  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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_UPDATE_H
  25 #define VLC_UPDATE_H
  26
  27 /**
  28  * \defgroup update Software updates
  29  * \ingroup interface
  30  * Over-the-air VLC software updates
  31  * @{
  32  * \file
  33  *VLC software update interface
  34  */
  35
  36 /**
  37  * Describes an update VLC release number
  38  */
  39 struct update_release_t
  40 {
  41     int i_major;        ///< Version major
  42     int i_minor;        ///< Version minor
  43     int i_revision;     ///< Version revision
  44     int i_extra;        ///< Version extra
  45     char* psz_url;      ///< Download URL
  46     char* psz_desc;     ///< Release description
  47 };
  48
  49 typedef struct update_release_t update_release_t;
  50
  51 VLC_API update_t * update_New( vlc_object_t * );
  52 #define update_New( a ) update_New( VLC_OBJECT( a ) )
  53 VLC_API void update_Delete( update_t * );
  54 VLC_API void update_Check( update_t *, void (*callback)( void*, bool ), void * );
  55 VLC_API bool update_NeedUpgrade( update_t * );
  56 VLC_API void update_Download( update_t *, const char* );
  57 VLC_API update_release_t* update_GetRelease( update_t * );
  58
  59 /**
  60  * @}
  61  */
  62
  63 #endif /* _VLC_UPDATE_H */