module_t Struct Reference

Internal module descriptor. More...

#include <modules.h>

Collaboration diagram for module_t:

Data Fields
vlc_plugin_t *	plugin
	Plug-in/library containing the module. More...
module_t *	next
unsigned	i_shortcuts
	Shortcuts to the module. More...
const char **	pp_shortcuts
const char *	psz_shortname
	Module name. More...
const char *	psz_longname
	Module descriptive name. More...
const char *	psz_help
	Long help plain string for "special" modules. More...
const char *	psz_help_html
	Long help HTML string, shown instead of the plain help where it makes sense to render HTML. More...
const char *	psz_capability
	Capability. More...
int	i_score
	Score for the capability. More...
const char *	activate_name
const char *	deactivate_name
void *	pf_activate
vlc_deactivate_cb	deactivate

Detailed Description

Internal module descriptor.

Field Documentation

activate_name

const char* module_t::activate_name

Referenced by vlc_module_create(), and vlc_plugin_desc_cb().

deactivate

vlc_deactivate_cb module_t::deactivate

Referenced by module_unneed(), vlc_module_create(), and vlc_plugin_desc_cb().

deactivate_name

const char* module_t::deactivate_name

Referenced by vlc_module_create(), and vlc_plugin_desc_cb().

i_score

int module_t::i_score

Score for the capability.

Referenced by ListModules(), module_get_score(), vlc_module_cmp(), vlc_module_create(), and vlc_plugin_desc_cb().

i_shortcuts

unsigned module_t::i_shortcuts

Shortcuts to the module.

Referenced by ListModules(), module_find(), module_get_object(), module_match(), module_match_name(), vlc_module_create(), and vlc_plugin_desc_cb().

next

module_t* module_t::next

Referenced by module_list_get(), vlc_module_create(), vlc_module_destroy(), vlc_plugin_resolve(), and vlc_plugin_store().

pf_activate

void* module_t::pf_activate

Referenced by vlc_module_create(), vlc_module_map(), and vlc_plugin_desc_cb().

plugin

vlc_plugin_t* module_t::plugin

Plug-in/library containing the module.

Referenced by module_config_get(), module_gettext(), vlc_module_create(), and vlc_module_map().

pp_shortcuts

const char** module_t::pp_shortcuts

Referenced by ListModules(), module_find(), module_get_object(), module_match(), module_match_name(), vlc_module_create(), vlc_module_destroy(), and vlc_plugin_desc_cb().

psz_capability

const char* module_t::psz_capability

Capability.

Referenced by ListModules(), module_get_capability(), vlc_module_create(), and vlc_plugin_desc_cb().

psz_help

const char* module_t::psz_help

Long help plain string for "special" modules.

Referenced by module_get_help(), Usage(), vlc_module_create(), and vlc_plugin_desc_cb().

psz_help_html

const char* module_t::psz_help_html

Long help HTML string, shown instead of the plain help where it makes sense to render HTML.

Supports only a limited HTML4 subset, see https://doc.qt.io/qt-6/richtext-html-subset.html

Referenced by module_get_help_html(), vlc_module_create(), and vlc_plugin_desc_cb().

psz_longname

const char* module_t::psz_longname

Module descriptive name.

Referenced by config_SaveConfigFile(), ListModules(), module_get_name(), Usage(), vlc_module_create(), and vlc_plugin_desc_cb().

psz_shortname

const char* module_t::psz_shortname

Module name.

Referenced by module_get_name(), vlc_module_create(), and vlc_plugin_desc_cb().

---

The documentation for this struct was generated from the following file:

• src/modules/modules.h