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_discoverer external API
31 #ifndef VLC_LIBVLC_MEDIA_DISCOVERER_H
32 #define VLC_LIBVLC_MEDIA_DISCOVERER_H 1
38 /** \defgroup libvlc_media_discoverer LibVLC media discovery
40 * LibVLC media discovery finds available media via various means.
41 * This corresponds to the service discovery functionality in VLC media player.
42 * Different plugins find potential medias locally (e.g. user media directory),
43 * from peripherals (e.g. video capture device), on the local network
44 * (e.g. SAP) or on the Internet (e.g. Internet radios).
48 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
51 * Discover media service by name.
53 * \param p_inst libvlc instance
54 * \param psz_name service name
55 * \return media discover object or NULL in case of error
57 VLC_PUBLIC_API libvlc_media_discoverer_t *
58 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
59 const char * psz_name );
62 * Release media discover object. If the reference count reaches 0, then
63 * the object will be released.
65 * \param p_mdis media service discover object
67 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
70 * Get media service discover object its localized name.
72 * \param p_mdis media discover object
73 * \return localized name
75 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
78 * Get media service discover media list.
80 * \param p_mdis media service discover object
81 * \return list of media items
83 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
86 * Get event manager from media service discover object.
88 * \param p_mdis media service discover object
89 * \return event manager object.
91 VLC_PUBLIC_API libvlc_event_manager_t *
92 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
95 * Query if media service discover object is running.
97 * \param p_mdis media service discover object
98 * \return true if running, false if not
101 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
109 #endif /* <vlc/libvlc.h> */