]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc_media_library.h
LGPL
[vlc] / include / vlc / libvlc_media_library.h
index d2192bc788e8bce7b33a2f1f05826b5e95d21676..b9a8153ac58186260481e99c8a6b5b5a84e06d9b 100644 (file)
@@ -1,26 +1,26 @@
 /*****************************************************************************
  * libvlc.h:  libvlc external API
  *****************************************************************************
- * Copyright (C) 1998-2009 the VideoLAN team
+ * Copyright (C) 1998-2009 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
  *          Jean-Paul Saman <jpsaman@videolan.org>
  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /**
 #ifndef VLC_LIBVLC_MEDIA_LIBRARY_H
 #define VLC_LIBVLC_MEDIA_LIBRARY_H 1
 
-/*****************************************************************************
- * Media Library
- *****************************************************************************/
-/** \defgroup libvlc_media_library libvlc_media_library
+# ifdef __cplusplus
+extern "C" {
+# endif
+
+/** \defgroup libvlc_media_library LibVLC media library
  * \ingroup libvlc
- * LibVLC Media Library
  * @{
  */
 
 typedef struct libvlc_media_library_t libvlc_media_library_t;
 
-VLC_PUBLIC_API libvlc_media_library_t *
-    libvlc_media_library_new( libvlc_instance_t * p_inst,
-                              libvlc_exception_t * p_e );
+/**
+ * Create an new Media Library object
+ *
+ * \param p_instance the libvlc instance
+ * \return a new object or NULL on error
+ */
+LIBVLC_API libvlc_media_library_t *
+    libvlc_media_library_new( libvlc_instance_t * p_instance );
 
 /**
  * Release media library object. This functions decrements the
@@ -53,7 +58,7 @@ VLC_PUBLIC_API libvlc_media_library_t *
  *
  * \param p_mlib media library object
  */
-VLC_PUBLIC_API void
+LIBVLC_API void
     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
 
 /**
@@ -63,41 +68,32 @@ VLC_PUBLIC_API void
  *
  * \param p_mlib media library object
  */
-VLC_PUBLIC_API void
+LIBVLC_API void
     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
 
 /**
  * Load media library.
  *
  * \param p_mlib media library object
- * \param p_e an initialized exception object.
+ * \return 0 on success, -1 on error
  */
-VLC_PUBLIC_API void
-    libvlc_media_library_load( libvlc_media_library_t * p_mlib,
-                               libvlc_exception_t * p_e );
-
-/**
- * Save media library.
- *
- * \param p_mlib media library object
- * \param p_e an initialized exception object.
- */
-VLC_PUBLIC_API void
-    libvlc_media_library_save( libvlc_media_library_t * p_mlib,
-                               libvlc_exception_t * p_e );
+LIBVLC_API int
+    libvlc_media_library_load( libvlc_media_library_t * p_mlib );
 
 /**
  * Get media library subitems.
  *
  * \param p_mlib media library object
- * \param p_e an initialized exception object.
  * \return media list subitems
  */
-VLC_PUBLIC_API libvlc_media_list_t *
-    libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
-                                     libvlc_exception_t * p_e );
+LIBVLC_API libvlc_media_list_t *
+    libvlc_media_library_media_list( libvlc_media_library_t * p_mlib );
 
 
 /** @} */
 
+# ifdef __cplusplus
+}
+# endif
+
 #endif /* VLC_LIBVLC_MEDIA_LIBRARY_H */