libvlc_media_library.h 2.86 KB
Newer Older
1 2 3
/*****************************************************************************
 * libvlc.h:  libvlc external API
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1998-2009 VLC authors and VideoLAN
5 6 7 8 9 10
 * $Id$
 *
 * Authors: Clément Stenac <zorglub@videolan.org>
 *          Jean-Paul Saman <jpsaman@videolan.org>
 *          Pierre d'Herbemont <pdherbemont@videolan.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
11 12 13
 * 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
14 15 16 17
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
21 22 23
 * 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.
24 25 26 27 28 29 30 31 32 33
 *****************************************************************************/

/**
 * \file
 * This file defines libvlc_media_library external API
 */

#ifndef VLC_LIBVLC_MEDIA_LIBRARY_H
#define VLC_LIBVLC_MEDIA_LIBRARY_H 1

34 35 36 37
# ifdef __cplusplus
extern "C" {
# endif

38
/** \defgroup libvlc_media_library LibVLC media library
39 40 41 42 43 44
 * \ingroup libvlc
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

45 46 47
/**
 * Create an new Media Library object
 *
48
 * \param p_instance the libvlc instance
49
 * \return a new object or NULL on error
50
 */
51
LIBVLC_API libvlc_media_library_t *
52
    libvlc_media_library_new( libvlc_instance_t * p_instance );
53 54 55 56 57 58 59 60

/**
 * Release media library object. This functions decrements the
 * reference count of the media library object. If it reaches 0,
 * then the object will be released.
 *
 * \param p_mlib media library object
 */
61
LIBVLC_API void
62 63 64 65 66 67 68 69 70
    libvlc_media_library_release( libvlc_media_library_t * p_mlib );

/**
 * Retain a reference to a media library object. This function will
 * increment the reference counting for this object. Use
 * libvlc_media_library_release() to decrement the reference count.
 *
 * \param p_mlib media library object
 */
71
LIBVLC_API void
72 73 74 75 76 77
    libvlc_media_library_retain( libvlc_media_library_t * p_mlib );

/**
 * Load media library.
 *
 * \param p_mlib media library object
78
 * \return 0 on success, -1 on error
79
 */
80
LIBVLC_API int
81
    libvlc_media_library_load( libvlc_media_library_t * p_mlib );
82 83 84 85 86 87 88

/**
 * Get media library subitems.
 *
 * \param p_mlib media library object
 * \return media list subitems
 */
89
LIBVLC_API libvlc_media_list_t *
90
    libvlc_media_library_media_list( libvlc_media_library_t * p_mlib );
91 92 93 94


/** @} */

95 96 97 98
# ifdef __cplusplus
}
# endif

99
#endif /* VLC_LIBVLC_MEDIA_LIBRARY_H */