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 /**
  28  * \file
  29  * This file functions and structures for service discovery in vlc
  30  */
  31
  32 # ifdef __cplusplus
  33 extern "C" {
  34 # endif
  35
  36 /*
  37  * @{
  38  */
  39
  40 #include <vlc_input.h>
  41 #include <vlc_events.h>
  42
  43 struct services_discovery_t
  44 {
  45     VLC_COMMON_MEMBERS
  46     module_t *          p_module;
  47
  48     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
  49
  50     services_discovery_sys_t *p_sys;
  51 };
  52
  53 /***********************************************************************
  54  * Service Discovery
  55  ***********************************************************************/
  56
  57 /* Get the services discovery modules names to use in Create(), in a null
  58  * terminated string array. Array and string must be freed after use. */
  59 VLC_EXPORT( char **, vlc_sd_GetNames, ( char ***pppsz_longnames ) );
  60
  61 /* Creation of a service_discovery object */
  62 VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t * ) );
  63 VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t *, const char * ) );
  64 VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
  65
  66 static inline void vlc_sd_Destroy( services_discovery_t *p_sd )
  67 {
  68     vlc_object_release( VLC_OBJECT(p_sd) );
  69 }
  70
  71 static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
  72 {
  73     vlc_sd_Stop( p_this );
  74     vlc_sd_Destroy( p_this );
  75 }
  76
  77 /* Read info from discovery object */
  78 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
  79
  80 /* Receive event notification (preferred way to get new items) */
  81 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
  82
  83 /* Used by services_discovery to post update about their items */
  84     /* About the psz_category, it is a legacy way to add info to the item,
  85      * for more options, directly set the (meta) data on the input item */
  86 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
  87 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
  88
  89 /** @} */
  90 # ifdef __cplusplus
  91 }
  92 # endif
  93
  94 #endif