qml: Create VideoGroupsDisplay
[vlc.git] / share / lua / playlist / README.txt
1 Instructions to code your own VLC Lua playlist script.
2 $Id$
3
4 See lua/README.txt for generic documentation about Lua usage in VLC.
5
6 Examples: See liveleak.lua, dailymotion.lua, youtube.lua,
7           soundcloud.lua, cue.lua ...
8
9 VLC Lua playlist modules should define two functions:
10  * probe(): returns true if we want to handle the playlist in this script
11  * parse(): read the incoming data and return playlist item(s)
12             Playlist items use the same format as that expected in the
13             playlist.add() function (see general lua/README.txt)
14
15 VLC defines a global vlc object with the following members:
16  * vlc.path: the URL string (without the leading http:// or file:// element)
17  * vlc.access: the access used ("http" for http://, "file" for file://, etc.)
18  * vlc.peek( <int> ): return the first <int> characters from the playlist file.
19  * vlc.read( <int> ): read <int> characters from the playlist file.
20                       THIS FUNCTION CANNOT BE USED IN probe().
21  * vlc.readline(): return a new line of playlist data on each call.
22                    THIS FUNCTION CANNOT BE USED IN probe().
23
24 Available VLC specific Lua modules: msg, strings, stream, variables and
25 xml. See lua/README.txt.