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

   1 Instructions to code your own VLC Lua services discovery script.
   2 $Id$
   3
   4 See lua/README.txt for generic documentation about Lua usage in VLC.
   5
   6 Examples: See fmc.lua, freebox.lua, frenchtv.lua
   7
   8 VLC Lua SD modules should define two functions:
   9  * descriptor(): returns a table with information about the module.
  10                  The table has the following members:
  11                      .title: the name of the SD
  12  * main(): will be called when the SD is started
  13
  14 User defined modules stored in the share/lua/modules/ directory are
  15 available. For example, to use the sandbox module, just use
  16 'require "sandbox"' in your interface.
  17
  18 Available VLC specific Lua modules: input, msg, misc, net, object, sd,
  19 strings, variables, stream, gettext, xml. See lua/README.txt.