home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_services_discovery.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  3.8 KB  |  92 lines
  1. /*****************************************************************************
  2.  * vlc_services_discovery.h : Services Discover functions
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2004 the VideoLAN team
  5.  * $Id: 75834212b3d14bed300bb1ee57acd79e17dd2b4e $
  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.     char *              psz_module;
  47.     module_t *          p_module;
  48.  
  49.     char *              psz_localized_name; /* Accessed through Setters for non class function */
  50.     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
  51.  
  52.     services_discovery_sys_t *p_sys;
  53.     void (*pf_run) ( services_discovery_t *);
  54. };
  55.  
  56.  
  57. /***********************************************************************
  58.  * Service Discovery
  59.  ***********************************************************************/
  60.  
  61. /* Get the services discovery modules names to use in Create(), in a null
  62.  * terminated string array. Array and string must be freed after use. */
  63. VLC_EXPORT( char **, __services_discovery_GetServicesNames, ( vlc_object_t * p_super, char ***pppsz_longnames ) );
  64. #define services_discovery_GetServicesNames(a,b) \
  65.         __services_discovery_GetServicesNames(VLC_OBJECT(a),b)
  66.  
  67. /* Creation of a service_discovery object */
  68. VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) );
  69. VLC_EXPORT( void,                   services_discovery_Destroy, ( services_discovery_t * p_this ) );
  70. VLC_EXPORT( int,                    services_discovery_Start, ( services_discovery_t * p_this ) );
  71. VLC_EXPORT( void,                   services_discovery_Stop, ( services_discovery_t * p_this ) );
  72.  
  73. /* Read info from discovery object */
  74. VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
  75.  
  76. /* Receive event notification (preferred way to get new items) */
  77. VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
  78.  
  79. /* Used by services_discovery to post update about their items */
  80. VLC_EXPORT( void,                   services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) );
  81.     /* About the psz_category, it is a legacy way to add info to the item,
  82.      * for more options, directly set the (meta) data on the input item */
  83. VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
  84. VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
  85.  
  86. /** @} */
  87. # ifdef __cplusplus
  88. }
  89. # endif
  90.  
  91. #endif
  92.