X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_services_discovery.h;h=69c3d96bd52d8cdad8b04b690ffd7f46052ad4d9;hb=7158aaea585c198a4e536af1be9f3cbbe2e62f74;hp=77d4bc89e5371b4ba0efd137ee3302b5446bf158;hpb=bf343c29433a3424e56f13263adc81dd5cee835c;p=vlc diff --git a/include/vlc_services_discovery.h b/include/vlc_services_discovery.h index 77d4bc89e5..69c3d96bd5 100644 --- a/include/vlc_services_discovery.h +++ b/include/vlc_services_discovery.h @@ -37,16 +37,20 @@ extern "C" { # endif -/* +/** * @{ */ + +/** + * Main service discovery structure to build a SD module + */ struct services_discovery_t { VLC_COMMON_MEMBERS module_t * p_module; /**< Loaded module */ /**< Event manager - /* You should access it through setters, outside of the core */ + * You should access it through setters, outside of the core */ vlc_event_manager_t event_manager; char *psz_name; /**< Main name of the SD */ @@ -62,6 +66,7 @@ struct services_discovery_t /** * Service discovery categories + * \see vlc_sd_probe_Add */ enum services_discovery_category_e { @@ -90,6 +95,7 @@ enum services_discovery_capability_e /** * Service discovery descriptor + * \see services_discovery_command_e */ typedef struct { @@ -99,6 +105,7 @@ typedef struct int i_capabilities; /**< \see services_discovery_capability_e */ } services_discovery_descriptor_t; + /*********************************************************************** * Service Discovery ***********************************************************************/ @@ -120,15 +127,15 @@ 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 @@ -140,21 +147,21 @@ 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 ); /* 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() \