Hacker Guide/How To Write a Module

From VideoLAN Wiki
Revision as of 19:34, 12 February 2007 by Mbarclay (talk | contribs)
Jump to navigation Jump to search
  • 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:

vlc_module_being();

You should set some category information on your module:

    set_shortname( _("DVD without menus") );
    set_description( _("DVDRead Input (DVD without menu support)") );
    set_category( CAT_INPUT );

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
    set_subcategory( SUBCAT_INPUT_ACCESS );

See include/configuration.h for definition of all categories and sub-categories

Open(vlc_object_t *)

Close(vlc_object_t *)