1 /*****************************************************************************
2 * libvlc.h: libvlc external API
3 *****************************************************************************
4 * Copyright (C) 1998-2009 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
9 * Pierre d'Herbemont <pdherbemont@videolan.org>
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.
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.
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 *****************************************************************************/
28 * This file defines libvlc_media_library external API
31 #ifndef VLC_LIBVLC_MEDIA_LIBRARY_H
32 #define VLC_LIBVLC_MEDIA_LIBRARY_H 1
38 /*****************************************************************************
40 *****************************************************************************/
41 /** \defgroup libvlc_media_library libvlc_media_library
43 * LibVLC Media Library
47 typedef struct libvlc_media_library_t libvlc_media_library_t;
50 * Create an new Media Library object
52 * \param p_libvlc_instance the libvlc instance
53 * \return a new object or NULL on error
55 VLC_PUBLIC_API libvlc_media_library_t *
56 libvlc_media_library_new( libvlc_instance_t * p_inst );
59 * Release media library object. This functions decrements the
60 * reference count of the media library object. If it reaches 0,
61 * then the object will be released.
63 * \param p_mlib media library object
66 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
69 * Retain a reference to a media library object. This function will
70 * increment the reference counting for this object. Use
71 * libvlc_media_library_release() to decrement the reference count.
73 * \param p_mlib media library object
76 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
81 * \param p_mlib media library object
82 * \return 0 on success, -1 on error
85 libvlc_media_library_load( libvlc_media_library_t * p_mlib );
88 * Get media library subitems.
90 * \param p_mlib media library object
91 * \return media list subitems
93 VLC_PUBLIC_API libvlc_media_list_t *
94 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib );
103 #endif /* VLC_LIBVLC_MEDIA_LIBRARY_H */