Support of Mxpeg codec

[vlc] / include / vlc / libvlc_media_discoverer.h

diff --git a/include/vlc/libvlc_media_discoverer.h b/include/vlc/libvlc_media_discoverer.h
index f6aee418cbd5f43cae4460f3b3f1ae047895b9fa..cf263b0536d9b19e725e039f12ef20eaa392fec3 100644 (file)
--- a/include/vlc/libvlc_media_discoverer.h
+++ b/include/vlc/libvlc_media_discoverer.h
@@ -1,26 +1,26 @@
 /*****************************************************************************
- * libvlc.h:  libvlc external API
+ * libvlc_media_discoverer.h:  libvlc external API
  *****************************************************************************
- * Copyright (C) 1998-2009 the VideoLAN team
+ * Copyright (C) 1998-2009 VLC authors and VideoLAN
  * $Id$
  *
  * 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 General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * 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 General Public License for more details.
+ * 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 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.
+ * 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.
  *****************************************************************************/
 
 /**
@@ -35,12 +35,13 @@
 extern "C" {
 # endif
 
-/*****************************************************************************
- * Services/Media Discovery
- *****************************************************************************/
-/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
+/** \defgroup libvlc_media_discoverer LibVLC media discovery
  * \ingroup libvlc
- * LibVLC Media Discoverer
+ * LibVLC media discovery finds available media via various means.
+ * This corresponds to the service discovery functionality in VLC media player.
+ * Different plugins find potential medias locally (e.g. user media directory),
+ * from peripherals (e.g. video capture device), on the local network
+ * (e.g. SAP) or on the Internet (e.g. Internet radios).
  * @{
  */
 
@@ -53,7 +54,7 @@ typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
  * \param psz_name service name
  * \return media discover object or NULL in case of error
  */
-VLC_PUBLIC_API libvlc_media_discoverer_t *
+LIBVLC_API libvlc_media_discoverer_t *
 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
                                        const char * psz_name );
 
@@ -63,7 +64,7 @@ libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
  *
  * \param p_mdis media service discover object
  */
-VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
+LIBVLC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
 
 /**
  * Get media service discover object its localized name.
@@ -71,7 +72,7 @@ VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t
  * \param p_mdis media discover object
  * \return localized name
  */
-VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
+LIBVLC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
 
 /**
  * Get media service discover media list.
@@ -79,7 +80,7 @@ VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_disco
  * \param p_mdis media service discover object
  * \return list of media items
  */
-VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
+LIBVLC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
 
 /**
  * Get event manager from media service discover object.
@@ -87,7 +88,7 @@ VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_
  * \param p_mdis media service discover object
  * \return event manager object.
  */
-VLC_PUBLIC_API libvlc_event_manager_t *
+LIBVLC_API libvlc_event_manager_t *
         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
 
 /**
@@ -95,8 +96,10 @@ VLC_PUBLIC_API libvlc_event_manager_t *
  *
  * \param p_mdis media service discover object
  * \return true if running, false if not
+ *
+ * \libvlc_return_bool
  */
-VLC_PUBLIC_API int
+LIBVLC_API int
         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
 
 /**@} */