git.sesse.net Git - vlc/blob - share/lua/meta/README.txt

   1 ## Generic instructions about VLC Lua meta scripts.
   2 $Id$
   3
   4 There is 3 types of Lua meta modules: art, fetcher and reader.
   5 See their own README.txt for documentation.
   6
   7 See lua/README.txt for generic documentation about Lua usage in VLC.
   8
   9 ## API
  10
  11 VLC Lua meta modules should define a descriptor function:
  12   * descriptor(): returns a table with information about the module.
  13     This table has the following member:
  14       .scope: Search scope of the script. Can be "network" or "local".
  15               and defaults to "network".
  16               "local" scripts are considered fast and processed first.
  17               "network" scripts are considered slow and processed in a
  18               second pass only if policy allows it.
  19
  20     Example:
  21     function descriptor()
  22         return { scope="network" }
  23     end
  24