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

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /**
  27  * \file
  28  * This file defines libvlc_media_library external API
  29  */
  30
  31 #ifndef VLC_LIBVLC_MEDIA_LIBRARY_H
  32 #define VLC_LIBVLC_MEDIA_LIBRARY_H 1
  33
  34 /*****************************************************************************
  35  * Media Library
  36  *****************************************************************************/
  37 /** \defgroup libvlc_media_library libvlc_media_library
  38  * \ingroup libvlc
  39  * LibVLC Media Library
  40  * @{
  41  */
  42
  43 typedef struct libvlc_media_library_t libvlc_media_library_t;
  44
  45 /**
  46  * Create an new Media Library object
  47  *
  48  * \param p_libvlc_instance the libvlc instance
  49  * \param p_e an initialized exception pointer
  50  */
  51 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
  52 VLC_PUBLIC_API libvlc_media_library_t *
  53     libvlc_media_library_new( libvlc_instance_t * p_inst,
  54                               libvlc_exception_t * p_e );
  55
  56 /**
  57  * Release media library object. This functions decrements the
  58  * reference count of the media library object. If it reaches 0,
  59  * then the object will be released.
  60  *
  61  * \param p_mlib media library object
  62  */
  63 VLC_PUBLIC_API void
  64     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
  65
  66 /**
  67  * Retain a reference to a media library object. This function will
  68  * increment the reference counting for this object. Use
  69  * libvlc_media_library_release() to decrement the reference count.
  70  *
  71  * \param p_mlib media library object
  72  */
  73 VLC_PUBLIC_API void
  74     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
  75
  76 /**
  77  * Load media library.
  78  *
  79  * \param p_mlib media library object
  80  * \param p_e an initialized exception object.
  81  */
  82 VLC_PUBLIC_API void
  83     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
  84                                libvlc_exception_t * p_e );
  85
  86 /**
  87  * Save media library.
  88  *
  89  * \param p_mlib media library object
  90  * \param p_e an initialized exception object.
  91  */
  92 VLC_PUBLIC_API void
  93     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
  94                                libvlc_exception_t * p_e );
  95
  96 /**
  97  * Get media library subitems.
  98  *
  99  * \param p_mlib media library object
 100  * \param p_e an initialized exception object.
 101  * \return media list subitems
 102  */
 103 VLC_PUBLIC_API libvlc_media_list_t *
 104     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
 105                                      libvlc_exception_t * p_e );
 106
 107
 108 /** @} */
 109
 110 #endif /* VLC_LIBVLC_MEDIA_LIBRARY_H */