VideoLAN Wiki - User contributions [en]

Plugin Writers Guide

2007-02-12T20:35:28Z

Mbarclay: Plugin Writers Guide moved to Module Writers Guide: VLC doesn't have plugins, it has Modules

#REDIRECT [[Module Writers Guide]]

Hacker Guide/How To Write a Module

2007-02-12T20:35:28Z

Mbarclay: Plugin Writers Guide moved to Module Writers Guide: VLC doesn't have plugins, it has Modules

*This guide is being written by a VLC novice. Please verify all statements below
*Using dvdread.c as the template

== Module Descriptor ==
A VLC Module must include a description of itself, and the parameters it accepts.

The module descriptor begins with:
<pre>
vlc_module_being();
</pre>

You should set some category information on your module:
<pre>
set_shortname( _("DVD without menus") );
set_description( _("DVDRead Input (DVD without menu support)") );
set_category( CAT_INPUT );
</pre>
Note the use of _("") to create a string. -- Is this required??

Predefined Categories include:
* CAT_INTERFACE
* CAT_AUDIO
* CAT_VIDEO
* CAT_INPUT
* CAT_SOUT
* CAT_ADVANCED
* CAT_PLAYLIST

<pre>
set_subcategory( SUBCAT_INPUT_ACCESS );
</pre>
See include/configuration.h for definition of all categories and sub-categories

=== Adding Parameters ===
All macros take the following argument list:
<pre> add_integer(name, value, p_callback, text, longtext, advc) </pre>
* '''name''' is the string that identifies this parameter in the configuration. This name may be used at the command prompt to set the configuration value
* '''value''' is the default value for this parameter
* '''p_callback''' is a function pointer that will be called when the value of this parameter is changed.
** p_callback is called with the following arguments:
<pre>( p_this, psz_name, oldval, val, p_config->p_callback_data )</pre>
*** '''p_this''' is a pointer to a vlc_object_t struct
*** '''psz_name''' is the '''name''' of your parameter that is being changed
*** '''oldval''' is the old value of the parameter
*** '''val''' is the new value of the parameter
*** '''p_call_back_data''' is void* data that you can assign for each parameter. Usually NULL.
* '''text''' A short description of the parameter
* '''longtext''' A complete description of the parameter
* '''advc''' Boolean, ADVanced Configuration. If TRUE, this parameter will only be displayed when using the --advanced flag. e.g.
<pre>vlc -p dvdread --advanced</pre>

e.g.
<pre> add_integer("dvdread-angle", 1, NULL, "DVD Angle", "Default DVD Angle", NULL") </pre>

You may add the following parameters to your module:
* add_integer
* add_string
* add_float
* add_bool
* add_key
* add_file
* add_directory

For complete definitions, see include/configuration.h

== Open(vlc_object_t *) ==

== Close(vlc_object_t *) ==

Hacker Guide/How To Write a Module

2007-02-12T20:01:38Z

Mbarclay:

Hacker Guide/How To Write a Module

2007-02-12T19:55:50Z

Mbarclay:

*This guide is being written by a VLC novice. Please verify all statements below
*Using dvdread.c as the template

== Module Descriptor ==
A VLC Module must include a description of itself, and the parameters it accepts.

The module descriptor begins with:
<pre>
vlc_module_being();
</pre>

You should set some category information on your module:
<pre>
set_shortname( _("DVD without menus") );
set_description( _("DVDRead Input (DVD without menu support)") );
set_category( CAT_INPUT );
</pre>
Note the use of _("") to create a string. -- Is this required??

Predefined Categories include:
* CAT_INTERFACE
* CAT_AUDIO
* CAT_VIDEO
* CAT_INPUT
* CAT_SOUT
* CAT_ADVANCED
* CAT_PLAYLIST

<pre>
set_subcategory( SUBCAT_INPUT_ACCESS );
</pre>
See include/configuration.h for definition of all categories and sub-categories

=== Adding Parameters ===
All macros take the following argument list:
<pre> add_integer(name, value, p_callback, text, longtext, advc) </pre>
* '''name''' is the string that identifies this parameter in the configuration. This name may be used at the command prompt to set the configuration value
* '''value''' is the default value for this parameter
* '''p_callback''' is a function pointer that will be called when the value of this parameter is changed.
** p_callback is called with the following arguments:
<pre>( p_this, psz_name, oldval, val, p_config->p_callback_data )</pre>
*** '''p_this''' is a pointer to a vlc_object_t struct
*** '''psz_name''' is the '''name''' of your parameter that is being changed
*** '''oldval''' is the old value of the parameter
*** '''val''' is the new value of the parameter
*** '''p_call_back_data''' is void* data that you can assign for each parameter. Usually NULL.
* '''text''' A short description of the parameter
* '''longtext''' A complete description of the parameter
* '''advc''' Boolean, ADVanced Configuration. If TRUE, this parameter will only be displayed when using the --advanced flag. e.g.
<pre>vlc -p dvdread --advanced</pre>

e.g.
<pre> add_integer("dvdread-angle", 1, NULL, "DVD Angle", "Default DVD Angle", NULL") </pre>

You may add the following parameters to your module:
* add_integer
* add_string
* add_double

== Open(vlc_object_t *) ==

== Close(vlc_object_t *) ==

Hacker Guide/How To Write a Module

2007-02-12T19:34:42Z

Mbarclay:

*This guide is being written by a VLC novice. Please verify all statements below
*Using dvdread.c as the template

== Module Descriptor ==
A VLC plugin must include a description of itself, and the parameters it accepts.

The module descriptor begins with:
<pre>
vlc_module_being();
</pre>

You should set some category information on your module:
<pre>
set_shortname( _("DVD without menus") );
set_description( _("DVDRead Input (DVD without menu support)") );
set_category( CAT_INPUT );
</pre>
Note the use of _("") to create a string. -- Is this required??

Predefined Categories include:
* CAT_INTERFACE
* CAT_AUDIO
* CAT_VIDEO
* CAT_INPUT
* CAT_SOUT
* CAT_ADVANCED
* CAT_PLAYLIST

<pre>
set_subcategory( SUBCAT_INPUT_ACCESS );
</pre>
See include/configuration.h for definition of all categories and sub-categories

== Open(vlc_object_t *) ==

== Close(vlc_object_t *) ==

Hacker Guide/How To Write a Module

2007-02-12T19:28:39Z

Mbarclay:

*This guide is being written by a VLC novice. Please verify all statements below
*Using dvdread.c as the template

== Module Descriptor ==
A VLC plugin must include a description of itself, and the parameters it accepts.

The module descriptor begins with:
<pre>
vlc_module_being();
</pre>

You should set some category information on your module:
<pre>
set_shortname( _("DVD without menus") );
set_description( _("DVDRead Input (DVD without menu support)") );
set_category( CAT_INPUT );
set_subcategory( SUBCAT_INPUT_ACCESS );
</pre>
Note the use of _("") to create a string. -- Is this required??

Predefined Categories include:
* CAT_INTERFACE
* CAT_AUDIO
* CAT_VIDEO
* CAT_INPUT
* CAT_SOUT
* CAT_ADVANCED
* CAT_PLAYLIST

== Open(vlc_object_t *) ==

== Close(vlc_object_t *) ==