100 lines
2.9 KiB
C
100 lines
2.9 KiB
C
/*****************************************************************************
|
|
* libvlc_media_library.h: libvlc external API
|
|
*****************************************************************************
|
|
* Copyright (C) 1998-2009 VLC authors and VideoLAN
|
|
* $Id: fa7094a6a8aac42607490c9982d9f4d082c2794c $
|
|
*
|
|
* 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 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 Lesser General Public License for more details.
|
|
*
|
|
* 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.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* \file
|
|
* This file defines libvlc_media_library external API
|
|
*/
|
|
|
|
#ifndef VLC_LIBVLC_MEDIA_LIBRARY_H
|
|
#define VLC_LIBVLC_MEDIA_LIBRARY_H 1
|
|
|
|
# ifdef __cplusplus
|
|
extern "C" {
|
|
# endif
|
|
|
|
/** \defgroup libvlc_media_library LibVLC media library
|
|
* \ingroup libvlc
|
|
* @{
|
|
*/
|
|
|
|
typedef struct libvlc_media_library_t libvlc_media_library_t;
|
|
|
|
/**
|
|
* 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
|
|
* reference count of the media library object. If it reaches 0,
|
|
* then the object will be released.
|
|
*
|
|
* \param p_mlib media library object
|
|
*/
|
|
LIBVLC_API void
|
|
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
|
|
*/
|
|
LIBVLC_API void
|
|
libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
|
|
|
|
/**
|
|
* Load media library.
|
|
*
|
|
* \param p_mlib media library object
|
|
* \return 0 on success, -1 on error
|
|
*/
|
|
LIBVLC_API int
|
|
libvlc_media_library_load( libvlc_media_library_t * p_mlib );
|
|
|
|
/**
|
|
* Get media library subitems.
|
|
*
|
|
* \param p_mlib media library object
|
|
* \return media list subitems
|
|
*/
|
|
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 */
|