libvlc: Don't use enum directly, it's a bad pratice for ABI compat.
[vlc.git] / include / vlc / libvlc_media_discoverer.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_discoverer external API
29  */
30
31 #ifndef VLC_LIBVLC_MEDIA_DISCOVERER_H
32 #define VLC_LIBVLC_MEDIA_DISCOVERER_H 1
33
34 /*****************************************************************************
35  * Services/Media Discovery
36  *****************************************************************************/
37 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
38  * \ingroup libvlc
39  * LibVLC Media Discoverer
40  * @{
41  */
42
43 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
44
45 /**
46  * Discover media service by name.
47  *
48  * \param p_inst libvlc instance
49  * \param psz_name service name
50  * \param p_e an initialized exception object
51  * \return media discover object
52  */
53 VLC_PUBLIC_API libvlc_media_discoverer_t *
54 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
55                                        const char * psz_name,
56                                        libvlc_exception_t * p_e );
57
58 /**
59  * Release media discover object. If the reference count reaches 0, then
60  * the object will be released.
61  *
62  * \param p_mdis media service discover object
63  */
64 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
65
66 /**
67  * Get media service discover object its localized name.
68  *
69  * \param media discover object
70  * \return localized name
71  */
72 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
73
74 /**
75  * Get media service discover media list.
76  *
77  * \param p_mdis media service discover object
78  * \return list of media items
79  */
80 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
81
82 /**
83  * Get event manager from media service discover object.
84  *
85  * \param p_mdis media service discover object
86  * \return event manager object.
87  */
88 VLC_PUBLIC_API libvlc_event_manager_t *
89         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
90
91 /**
92  * Query if media service discover object is running.
93  *
94  * \param p_mdis media service discover object
95  * \return true if running, false if not
96  */
97 VLC_PUBLIC_API int
98         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
99
100 /**@} */
101
102 # ifdef __cplusplus
103 }
104 # endif
105
106 #endif /* <vlc/libvlc.h> */