include/vlc_services_discovery.h

   1 /*****************************************************************************
   2  * vlc_services_discovery.h : Services Discover functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_SERVICES_DISCOVERY_H_
  25 #define _VLC_SERVICES_DISCOVERY_H_
  26
  27 # ifdef __cplusplus
  28 extern "C" {
  29 # endif
  30
  31 /*
  32  * @{
  33  */
  34
  35 #include <vlc_input.h>
  36 #include <vlc_events.h>
  37
  38 struct services_discovery_t
  39 {
  40     VLC_COMMON_MEMBERS
  41     char *              psz_module;
  42     module_t *          p_module;
  43
  44     char *              psz_localized_name; /* Accessed through Setters for non class function */
  45     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
  46
  47     services_discovery_sys_t *p_sys;
  48     void (*pf_run) ( services_discovery_t *);
  49 };
  50
  51
  52 /***********************************************************************
  53  * Service Discovery
  54  ***********************************************************************/
  55
  56 /* Get the services discovery modules names to use in Create(), in a null
  57  * terminated string array. Array and string must be freed after use. */
  58 VLC_EXPORT( char **, __services_discovery_GetServicesNames, ( vlc_object_t * p_super, char ***pppsz_longnames ) );
  59 #define services_discovery_GetServicesNames(a,b) \
  60         __services_discovery_GetServicesNames(VLC_OBJECT(a),b)
  61
  62 /* Creation of a service_discovery object */
  63 VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) );
  64 VLC_EXPORT( void,                   services_discovery_Destroy, ( services_discovery_t * p_this ) );
  65 VLC_EXPORT( int,                    services_discovery_Start, ( services_discovery_t * p_this ) );
  66 VLC_EXPORT( void,                   services_discovery_Stop, ( services_discovery_t * p_this ) );
  67
  68 /* Read info from discovery object */
  69 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
  70
  71 /* Receive event notification (preferred way to get new items) */
  72 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
  73
  74 /* Used by services_discovery to post update about their items */
  75 VLC_EXPORT( void,                   services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) );
  76     /* About the psz_category, it is a legacy way to add info to the item,
  77      * for more options, directly set the (meta) data on the input item */
  78 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
  79 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
  80
  81 /** @} */
  82 # ifdef __cplusplus
  83 }
  84 # endif
  85
  86 #endif