vlc_configuration.h File Reference

This file describes the programming interface for the configuration module. More...

Include dependency graph for vlc_configuration.h:

Go to the source code of this file.

Data Structures
union	module_value_t
struct	module_config_t
	Configuration item. More...
struct	config_chain_t

Macros
#define	config_SaveConfigFile(a)   config_SaveConfigFile(vlc_object_instance(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.
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 ,   VLC_SNAPSHOTS_DIR }

Functions
int	config_GetType (const char *name)
	Gets a configuration item type.
int64_t	config_GetInt (const char *name)
	Gets an integer configuration item's value.
void	config_PutInt (const char *name, int64_t val)
	Sets an integer configuration item's value.
float	config_GetFloat (const char *name)
	Gets a floating point configuration item's value.
void	config_PutFloat (const char *name, float val)
	Sets a floating point configuration item's value.
char *	config_GetPsz (const char *name)
	Gets a string configuration item's value.
void	config_PutPsz (const char *name, const char *val)
	Sets a string configuration item's value.
ssize_t	config_GetIntChoices (const char *, int64_t **values, char ***texts)
	Enumerates integer configuration choices.
ssize_t	config_GetPszChoices (const char *, char ***values, char ***texts)
	Determines a list of suggested values for a string configuration item.
int	config_SaveConfigFile (libvlc_int_t *)
	Saves the in-memory configuration into a file.
void	config_ResetAll (void)
	Resets the configuration.
module_config_t *	config_FindConfig (const char *name)
	Looks up a configuration item.
static const char *	config_GetLabel (const char *const psz_name)
	Gets the config label string for a configuration item, acquired by name.
char *	config_GetSysPath (vlc_sysdir_t dir, const char *filename)
	Gets an installation directory.
char *	config_GetUserDir (vlc_userdir_t)
void	config_AddIntf (const char *)
void	config_RemoveIntf (const char *)
bool	config_ExistIntf (const char *)
void	config_ChainParse (vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, const config_chain_t *)
	This function will.
const char *	config_ChainParseOptions (config_chain_t **pp_cfg, const char *ppsz_opts)
	This function will parse a configuration string (psz_opts) and.
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.
void	config_ChainDestroy (config_chain_t *)
	This function will release a linked list of config_chain_t (Including the head)
config_chain_t *	config_ChainDuplicate (const config_chain_t *)
	This function will duplicate a linked list of config_chain_t.
char *	config_StringUnescape (char *psz_string)
	This function will unescape a string in place and will return a pointer on the given string.
char *	config_StringEscape (const char *psz_string)
	This function will escape a string that can be unescaped by config_StringUnescape.

Detailed Description

This file describes the programming interface for the configuration module.

It includes functions allowing to declare, get or set configuration options.