X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_services_discovery.h;h=d9c231b28f3ec075343e0f8016792b8fa33f60f5;hb=1c61bc759905fb604765aa47e71d500a1807c996;hp=97a180ce74ba1002f979c77b64b7231a642d0852;hpb=16d8baab8135e6931b829a0d846fd0d94b8d36a5;p=vlc diff --git a/include/vlc_services_discovery.h b/include/vlc_services_discovery.h index 97a180ce74..d9c231b28f 100644 --- a/include/vlc_services_discovery.h +++ b/include/vlc_services_discovery.h @@ -1,24 +1,24 @@ /***************************************************************************** * vlc_services_discovery.h : Services Discover functions ***************************************************************************** - * Copyright (C) 1999-2004 the VideoLAN team + * Copyright (C) 1999-2004 VLC authors and VideoLAN * $Id$ * * Authors: Pierre d'Herbemont * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_SERVICES_DISCOVERY_H_ @@ -30,41 +30,50 @@ /** * \file - * This file functions and structures for service discovery in vlc + * This file lists functions and structures for service discovery (SD) in vlc */ # ifdef __cplusplus extern "C" { # endif -/* +/** * @{ */ +/** + * Main service discovery structure to build a SD module + */ struct services_discovery_t { VLC_COMMON_MEMBERS - module_t * p_module; + module_t * p_module; /**< Loaded module */ - vlc_event_manager_t event_manager; /* Accessed through Setters for non class function */ + /**< Event manager + * You should access it through setters, outside of the core */ + vlc_event_manager_t event_manager; - char *psz_name; - config_chain_t *p_cfg; + char *psz_name; /**< Main name of the SD */ + config_chain_t *p_cfg; /**< Configuration for the SD */ + /** Control function + * \see services_discovery_command_e + */ int ( *pf_control ) ( services_discovery_t *, int, va_list ); - services_discovery_sys_t *p_sys; + services_discovery_sys_t *p_sys; /**< Custom private data */ }; /** * Service discovery categories + * \see vlc_sd_probe_Add */ enum services_discovery_category_e { - SD_CAT_DEVICES = 1, - SD_CAT_LAN, - SD_CAT_INTERNET, - SD_CAT_MYCOMPUTER + SD_CAT_DEVICES = 1, /**< Devices, like portable music players */ + SD_CAT_LAN, /**< LAN/WAN services, like Upnp or SAP */ + SD_CAT_INTERNET, /**< Internet or Website channels services */ + SD_CAT_MYCOMPUTER /**< Computer services, like Discs or Apps */ }; /** @@ -81,20 +90,22 @@ enum services_discovery_command_e */ enum services_discovery_capability_e { - SD_CAP_SEARCH = 1 + SD_CAP_SEARCH = 1 /**< One can search in the SD */ }; /** * Service discovery descriptor + * \see services_discovery_command_e */ typedef struct { - char *psz_short_desc; - char *psz_icon_url; - char *psz_url; - int i_capabilities; + char *psz_short_desc; /**< The short description, human-readable */ + char *psz_icon_url; /**< URL to the icon that represents it */ + char *psz_url; /**< URL for the service */ + int i_capabilities; /**< \see services_discovery_capability_e */ } services_discovery_descriptor_t; + /*********************************************************************** * Service Discovery ***********************************************************************/ @@ -116,16 +127,19 @@ static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_ /* Get the services discovery modules names to use in Create(), in a null * terminated string array. Array and string must be freed after use. */ -VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED ); +VLC_API char ** vlc_sd_GetNames( vlc_object_t *, char ***, int ** ) VLC_USED; #define vlc_sd_GetNames(obj, pln, pcat ) \ vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat) /* Creation of a services_discovery object */ -VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED ); -VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) ); -VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) ); -VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) ); +VLC_API services_discovery_t * vlc_sd_Create( vlc_object_t *, const char * ) VLC_USED; +VLC_API bool vlc_sd_Start( services_discovery_t * ); +VLC_API void vlc_sd_Stop( services_discovery_t * ); +VLC_API void vlc_sd_Destroy( services_discovery_t * ); +/** + * Helper to stop and destroy the Service Discovery + */ static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this ) { vlc_sd_Stop( p_this ); @@ -133,21 +147,22 @@ static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this ) } /* Read info from discovery object */ -VLC_EXPORT( char *, services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED ); +VLC_API char * services_discovery_GetLocalizedName( services_discovery_t * p_this ) VLC_USED; /* Receive event notification (preferred way to get new items) */ -VLC_EXPORT( vlc_event_manager_t *, services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED ); +VLC_API vlc_event_manager_t * services_discovery_EventManager( services_discovery_t * p_this ) VLC_USED; /* Used by services_discovery to post update about their items */ /* About the psz_category, it is a legacy way to add info to the item, * for more options, directly set the (meta) data on the input item */ -VLC_EXPORT( void, services_discovery_AddItem, ( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ) ); -VLC_EXPORT( void, services_discovery_RemoveItem, ( services_discovery_t * p_this, input_item_t * p_item ) ); +VLC_API void services_discovery_AddItem( services_discovery_t * p_this, input_item_t * p_item, const char * psz_category ); +VLC_API void services_discovery_RemoveItem( services_discovery_t * p_this, input_item_t * p_item ); +VLC_API void services_discovery_RemoveAll( services_discovery_t * p_sd ); /* SD probing */ -VLC_EXPORT(int, vlc_sd_probe_Add, (vlc_probe_t *, const char *, const char *, int category)); +VLC_API int vlc_sd_probe_Add(vlc_probe_t *, const char *, const char *, int category); #define VLC_SD_PROBE_SUBMODULE \ add_submodule() \