Various spelling fixes.
[vlc.git] / 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 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #ifndef _VLC_SERVICES_DISCOVERY_H_
29 #define _VLC_SERVICES_DISCOVERY_H_
30
31 # ifdef __cplusplus
32 extern "C" {
33 # endif
34
35 /*
36  * @{
37  */
38
39 #include <vlc_input.h>
40 #include <vlc_events.h>
41
42 struct services_discovery_t
43 {
44     VLC_COMMON_MEMBERS
45     char *              psz_module;
46     module_t *          p_module;
47
48     char *              psz_localized_name; /* Accessed through Setters for non class function */
49     vlc_event_manager_t event_manager;      /* Accessed through Setters for non class function */
50
51     services_discovery_sys_t *p_sys;
52     void (*pf_run) ( services_discovery_t *);
53 };
54
55
56 /***********************************************************************
57  * Service Discovery
58  ***********************************************************************/
59
60 /* Get the services discovery modules names to use in Create(), in a null
61  * terminated string array. Array and string must be freed after use. */
62 VLC_EXPORT( char **, __services_discovery_GetServicesNames, ( vlc_object_t * p_super, char ***pppsz_longnames ) );
63 #define services_discovery_GetServicesNames(a,b) \
64         __services_discovery_GetServicesNames(VLC_OBJECT(a),b)
65
66 /* Creation of a service_discovery object */
67 VLC_EXPORT( services_discovery_t *, services_discovery_Create, ( vlc_object_t * p_super, const char * psz_service_name ) );
68 VLC_EXPORT( void,                   services_discovery_Destroy, ( services_discovery_t * p_this ) );
69 VLC_EXPORT( int,                    services_discovery_Start, ( services_discovery_t * p_this ) );
70 VLC_EXPORT( void,                   services_discovery_Stop, ( services_discovery_t * p_this ) );
71
72 /* Read info from discovery object */
73 VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
74
75 /* Receive event notification (preferred way to get new items) */
76 VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
77
78 /* Used by services_discovery to post update about their items */
79 VLC_EXPORT( void,                   services_discovery_SetLocalizedName, ( services_discovery_t * p_this, const char * ) );
80     /* About the psz_category, it is a legacy way to add info to the item,
81      * for more options, directly set the (meta) data on the input item */
82 VLC_EXPORT( void,                   services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) );
83 VLC_EXPORT( void,                   services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) );
84
85 /** @} */
86 # ifdef __cplusplus
87 }
88 # endif
89
90 #endif