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 /*****************************************************************************
39 * Services/Media Discovery
40 *****************************************************************************/
41 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
43 * LibVLC Media Discoverer
47 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
50 * Discover media service by name.
52 * \param p_inst libvlc instance
53 * \param psz_name service name
54 * \return media discover object or NULL in case of error
56 VLC_PUBLIC_API libvlc_media_discoverer_t *
57 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
58 const char * psz_name );
61 * Release media discover object. If the reference count reaches 0, then
62 * the object will be released.
64 * \param p_mdis media service discover object
66 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
69 * Get media service discover object its localized name.
71 * \param media discover object
72 * \return localized name
74 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
77 * Get media service discover media list.
79 * \param p_mdis media service discover object
80 * \return list of media items
82 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
85 * Get event manager from media service discover object.
87 * \param p_mdis media service discover object
88 * \return event manager object.
90 VLC_PUBLIC_API libvlc_event_manager_t *
91 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
94 * Query if media service discover object is running.
96 * \param p_mdis media service discover object
97 * \return true if running, false if not
100 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
108 #endif /* <vlc/libvlc.h> */