vlc_modules.h File Reference

Include dependency graph for vlc_modules.h:

Go to the source code of this file.

Defines
#define	module_Need(a, b, c, d)   __module_Need(VLC_OBJECT(a),b,c,d)
#define	module_Unneed(a, b)   __module_Unneed(VLC_OBJECT(a),b)
#define	module_Exists(a, b)   __module_Exists(VLC_OBJECT(a),b)
#define	module_Find(a, b)   __module_Find(VLC_OBJECT(a),b)
#define	module_GetModulesNamesForCapability(a, b, c)   __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)
#define	module_GetLongName(m)   module_GetName( m, true )
#define	module_GetMainModule(a)   __module_GetMainModule(VLC_OBJECT(a))
Functions
module_t *	__module_Need (vlc_object_t *, const char *, const char *, bool)
	module Need
void	__module_Unneed (vlc_object_t *, module_t *)
	Module unneed.
bool	__module_Exists (vlc_object_t *, const char *)
	Tell if a module exists and release it in thic case.
module_t *	__module_Find (vlc_object_t *, const char *)
	Get a pointer to a module_t given it's name.
void	module_Put (module_t *module)
	Release a module_t pointer from module_Find().
module_config_t *	module_GetConfig (const module_t *, unsigned *)
void	module_PutConfig (module_config_t *)
	Release the configuration.
char **	__module_GetModulesNamesForCapability (vlc_object_t *p_this, const char *psz_capability, char ***psz_longname)
	GetModuleNamesForCapability.
bool	module_IsCapable (const module_t *m, const char *cap)
	Checks whether a module implements a capability.
const char *	module_GetObjName (const module_t *m)
	Get the internal name of a module.
const char *	module_GetName (const module_t *m, bool long_name)
	Get the human-friendly name of a module.
const char *	module_GetHelp (const module_t *m)
	Get the help for a module.
static module_t *	__module_GetMainModule (vlc_object_t *p_this)
static bool	module_IsMainModule (const module_t *p_module)

---

Define Documentation

#define module_Exists	(	a,
		b		)	__module_Exists(VLC_OBJECT(a),b)

#define module_Find	(	a,
		b		)	__module_Find(VLC_OBJECT(a),b)

#define module_GetLongName

(

m

)

module_GetName( m, true )

#define module_GetMainModule

(

a

)

__module_GetMainModule(VLC_OBJECT(a))

#define module_GetModulesNamesForCapability	(	a,
		b,
		c		)	__module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)

#define module_Need	(	a,
		b,
		c,
		d		)	__module_Need(VLC_OBJECT(a),b,c,d)

#define module_Unneed	(	a,
		b		)	__module_Unneed(VLC_OBJECT(a),b)

---

Function Documentation

bool __module_Exists	(	vlc_object_t *	p_this,
		const char *	psz_name
	)

Tell if a module exists and release it in thic case.

Parameters:

	p_this	vlc object structure
	psz_name	th name of the module

Returns:

TRUE if the module exists

module_t* __module_Find	(	vlc_object_t *	p_this,
		const char *	psz_name
	)

Get a pointer to a module_t given it's name.

Parameters:

	p_this	vlc object structure
	psz_name	the name of the module

Returns:

a pointer to the module or NULL in case of a failure

static module_t* __module_GetMainModule

(

vlc_object_t *

p_this

)

[inline, static]

char** __module_GetModulesNamesForCapability	(	vlc_object_t *	p_this,
		const char *	psz_capability,
		char ***	pppsz_longname
	)

GetModuleNamesForCapability.

Return a NULL terminated array with the names of the modules that have a certain capability. Free after uses both the string and the table.

Parameters:

	p_this	vlc object structure
	psz_capability	the capability asked
	pppsz_longname	an pointer to an array of string to contain the long names of the modules. If set to NULL the function don't use it.

Returns:

the NULL terminated array

module_t* __module_Need	(	vlc_object_t *	p_this,
		const char *	psz_capability,
		const char *	psz_name,
		bool	b_strict
	)

module Need

Return the best module function, given a capability list.

Parameters:

	p_this	the vlc object
	psz_capability	list of capabilities needed
	psz_name	name of the module asked
	b_strict	TRUE yto use the strict mode

Returns:

the module or NULL in case of a failure

void __module_Unneed	(	vlc_object_t *	p_this,
		module_t *	p_module
	)

Module unneed.

This function must be called by the thread that called module_Need, to decrease the reference count and allow for hiding of modules.

Parameters:

	p_this	vlc object structure
	p_module	the module structure

Returns:

nothing

module_config_t* module_GetConfig	(	const module_t *	,
		unsigned *
	)

const char* module_GetHelp

(

const module_t *

m

)

Get the help for a module.

Parameters:

m

the module

Returns:

the help

const char* module_GetName	(	const module_t *	m,
		bool	long_name
	)

Get the human-friendly name of a module.

Parameters:

	m	the module
	long_name	TRUE to have the long name of the module

Returns:

the short or long name of the module

const char* module_GetObjName

(

const module_t *

m

)

Get the internal name of a module.

Parameters:

m

the module

Returns:

the module name

bool module_IsCapable	(	const module_t *	m,
		const char *	cap
	)

Checks whether a module implements a capability.

Parameters:

	m	the module
	cap	the capability to check

Returns:

TRUE if the module have the capability

static bool module_IsMainModule

(

const module_t *

p_module

)

[inline, static]

void module_Put

(

module_t *

module

)

Release a module_t pointer from module_Find().

Parameters:

module

the module to release

Returns:

nothing

void module_PutConfig

(

module_config_t *

config

)

Release the configuration.

Parameters:

the

configuration

Returns:

nothing

---