VLC  4.0.0-dev
Data Structures | Macros | Typedefs | Enumerations | Functions
vlc_configuration.h File Reference
Include dependency graph for vlc_configuration.h:

Go to the source code of this file.

Data Structures

struct  config_category_t
 
union  module_value_t
 
struct  module_config_t
 Configuration item. More...
 
struct  config_chain_t
 

Macros

#define config_SaveConfigFile(a)   config_SaveConfigFile(VLC_OBJECT(a))
 
#define config_ChainParse(a, b, c, d)   config_ChainParse( VLC_OBJECT(a), b, c, d )
 

Typedefs

typedef int(* vlc_string_list_cb) (const char *, char ***, char ***)
 
typedef int(* vlc_integer_list_cb) (const char *, int64_t **, char ***)
 
typedef enum vlc_system_dir vlc_sysdir_t
 System directory identifiers. More...
 
typedef enum vlc_user_dir vlc_userdir_t
 

Enumerations

enum  vlc_system_dir {
  VLC_PKG_DATA_DIR, VLC_PKG_LIB_DIR, VLC_PKG_LIBEXEC_DIR, VLC_PKG_INCLUDE_DIR_RESERVED,
  VLC_SYSDATA_DIR, VLC_LIB_DIR, VLC_LIBEXEC_DIR, VLC_INCLUDE_DIR_RESERVED,
  VLC_LOCALE_DIR
}
 System directory identifiers. More...
 
enum  vlc_user_dir {
  VLC_HOME_DIR, VLC_CONFIG_DIR, VLC_USERDATA_DIR, VLC_CACHE_DIR,
  VLC_DESKTOP_DIR =0x80, VLC_DOWNLOAD_DIR, VLC_TEMPLATES_DIR, VLC_PUBLICSHARE_DIR,
  VLC_DOCUMENTS_DIR, VLC_MUSIC_DIR, VLC_PICTURES_DIR, VLC_VIDEOS_DIR
}
 

Functions

VLC_EXPORT int config_GetType (const char *name)
 Gets a configuration item type. More...
 
VLC_EXPORT int64_t config_GetInt (const char *name)
 Gets an integer configuration item. More...
 
VLC_EXPORT void config_PutInt (const char *name, int64_t val)
 Sets an integer configuration item. More...
 
VLC_EXPORT float config_GetFloat (const char *name)
 Gets an floating point configuration item. More...
 
VLC_EXPORT void config_PutFloat (const char *name, float val)
 Sets an floating point configuration item. More...
 
VLC_EXPORT char * config_GetPsz (const char *name)
 Gets an string configuration item. More...
 
VLC_EXPORT void config_PutPsz (const char *name, const char *val)
 Sets an string configuration item. More...
 
VLC_EXPORT ssize_t config_GetIntChoices (const char *, int64_t **values, char ***texts)
 Enumerates integer configuration choices. More...
 
VLC_EXPORT ssize_t config_GetPszChoices (const char *, char ***values, char ***texts)
 Determines a list of suggested values for a string configuration item. More...
 
VLC_EXPORT int config_SaveConfigFile (vlc_object_t *)
 Saves the in-memory configuration into a file. More...
 
VLC_EXPORT void config_ResetAll (void)
 Resets the configuration. More...
 
VLC_EXPORT module_config_tconfig_FindConfig (const char *name)
 Looks up a configuration item. More...
 
VLC_EXPORT char * config_GetSysPath (vlc_sysdir_t dir, const char *filename)
 Gets an installation directory. More...
 
VLC_EXPORT char * config_GetUserDir (vlc_userdir_t)
 
VLC_EXPORT void config_AddIntf (const char *)
 
VLC_EXPORT void config_RemoveIntf (const char *)
 
VLC_EXPORT bool config_ExistIntf (const char *)
 
VLC_EXPORT void config_ChainParse (vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, const config_chain_t *)
 This function will. More...
 
const VLC_EXPORT char * config_ChainParseOptions (config_chain_t **pp_cfg, const char *ppsz_opts)
 This function will parse a configuration string (psz_opts) and. More...
 
VLC_EXPORT char * config_ChainCreate (char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string)
 This function will parse a configuration string (psz_string) and. More...
 
VLC_EXPORT void config_ChainDestroy (config_chain_t *)
 This function will release a linked list of config_chain_t (Including the head) More...
 
VLC_EXPORT config_chain_tconfig_ChainDuplicate (const config_chain_t *)
 This function will duplicate a linked list of config_chain_t. More...
 
VLC_EXPORT char * config_StringUnescape (char *psz_string)
 This function will unescape a string in place and will return a pointer on the given string. More...
 
VLC_EXPORT char * config_StringEscape (const char *psz_string)
 This function will escape a string that can be unescaped by config_StringUnescape. More...
 

Detailed Description

This file describes the programming interface for the configuration module. It includes functions allowing to declare, get or set configuration options.