git.sesse.net Git - vlc/blob - 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 # ifdef __cplusplus
  35 extern "C" {
  36 # endif
  37
  38 /*****************************************************************************
  39  * Services/Media Discovery
  40  *****************************************************************************/
  41 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
  42  * \ingroup libvlc
  43  * LibVLC Media Discoverer
  44  * @{
  45  */
  46
  47 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
  48
  49 /**
  50  * Discover media service by name.
  51  *
  52  * \param p_inst libvlc instance
  53  * \param psz_name service name
  54  * \param p_e an initialized exception object
  55  * \return media discover object
  56  */
  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,
  60                                        libvlc_exception_t * p_e );
  61
  62 /**
  63  * Release media discover object. If the reference count reaches 0, then
  64  * the object will be released.
  65  *
  66  * \param p_mdis media service discover object
  67  */
  68 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
  69
  70 /**
  71  * Get media service discover object its localized name.
  72  *
  73  * \param media discover object
  74  * \return localized name
  75  */
  76 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
  77
  78 /**
  79  * Get media service discover media list.
  80  *
  81  * \param p_mdis media service discover object
  82  * \return list of media items
  83  */
  84 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
  85
  86 /**
  87  * Get event manager from media service discover object.
  88  *
  89  * \param p_mdis media service discover object
  90  * \return event manager object.
  91  */
  92 VLC_PUBLIC_API libvlc_event_manager_t *
  93         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
  94
  95 /**
  96  * Query if media service discover object is running.
  97  *
  98  * \param p_mdis media service discover object
  99  * \return true if running, false if not
 100  */
 101 VLC_PUBLIC_API int
 102         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
 103
 104 /**@} */
 105
 106 # ifdef __cplusplus
 107 }
 108 # endif
 109
 110 #endif /* <vlc/libvlc.h> */