videolan/vlc
1
Fork 0
mirror of https://code.videolan.org/videolan/vlc synced 2024-08-31 06:46:39 +02:00
Code Releases Activity

Lua SD: add a bit of documentation

Browse Source
This commit is contained in:
Fabio Ritrovato 2010-02-20 15:53:40 +01:00
parent 3590d1c30e
commit 809e98a6d1
3 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
share/Makefile.am
View File

@ -274,6 +274,7 @@ EXTRA_DIST += \
lua/intf/dumpmeta.lua \
lua/modules/sandbox.lua \
lua/modules/simplexml.lua \
lua/sd/README.txt \
lua/sd/fmc.lua \
lua/sd/freebox.lua \
lua/sd/frenchtv.lua

12
share/lua/README.txt
View File

@ -17,6 +17,7 @@ All the Lua standard libraries are available.
* Art fetcher (see meta/README.txt)
* Interface (see intf/README.txt)
* Extensions (see extensions/README.txt)
* Services Discovery (see sd/README.txt)
Lua scripts are tried in alphabetical order in the user's VLC config
directory lua/{playlist,meta,intf}/ subdirectory on Windows and Mac OS X or
@ -313,6 +314,17 @@ sd.get_services_names(): Get a table of all available service discovery
sd.add( name ): Add service discovery.
sd.remove( name ): Remove service discovery.
sd.is_loaded( name ): Check if service discovery is loaded.
sd.add_item( ... ): Add an item to the service discovery.
The item object has the same members as the one in playlist.add().
Returns the input item.
sd.add_node( ... ): Add a node to the service discovery.
The node object has the following members:
.title: the node's name
.arturl: the node's ArtURL (OPTIONAL)
n = vlc.sd.add_node( {title="Node"} )
n:add_subitem( ... ): Same as sd.add_item(), but as a subitem of n.
n:add_node( ... ): Same as sd.add_node(), but as a subnode of n.
Stream
------

19
share/lua/sd/README.txt Normal file
View File

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