Sync readme with wiki page.

[vlc] / share / luaplaylist / README.txt

diff --git a/share/luaplaylist/README.txt b/share/luaplaylist/README.txt
index 641eb2e974b21caf09410acfeb492b9f1c8c5c13..c6c3b5996738287ca132138b9cea93e04124b380 100644 (file)
--- a/share/luaplaylist/README.txt
+++ b/share/luaplaylist/README.txt
@@ -1,7 +1,8 @@
 Instructions to code your own VLC Lua playlist script.
 $Id$
 
-Examples: See dailymotion.lua, googlevideo.lua, metacafe.lua and youbtube.lua.
+Examples: See dailymotion.lua, googlevideo.lua, metacafe.lua, youbtube.lua
+          and youtube_homepage.lua .
 
 VLC Lua playlist modules should define two functions:
  * probe(): returns true if we want to handle the playlist in this script
@@ -27,6 +28,13 @@ VLC Lua playlist modules should define two functions:
                 .encodedby: the item's EncodedBy (OPTIONAL, meta data)
                 .arturl: the item's ArtURL (OPTIONAL, meta data)
                 .trackid: the item's TrackID (OPTIONAL, meta data)
+                .options: a list of VLC options (OPTIONAL)
+                          example: .options = { "fullscreen" }
+                .duration: stream duration in seconds (OPTIONAL)
+                .meta: custom meta data (OPTIONAL, meta data)
+                       A .meta field is a table of custom meta categories which
+                       each have custom meta properties.
+                       example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }
             Invalid playlist items will be discarded by VLC.
 
 VLC defines a global vlc object with the following members:
@@ -45,7 +53,9 @@ VLC defines a global vlc object with the following members:
  * vlc.msg_err( <string> ): print an error message.
  * vlc.msg_info( <string> ): print an info message.
 
-Lua scripts are tried in alphabetical order in the luaplaylist/ directory.
+Lua scripts are tried in alphabetical order in the user's VLC config
+director luaplaylist/ subdirectory, then in the global VLC luaplaylist/
+directory.
 
 Lua documentation is available on http://www.lua.org .
 VLC uses Lua 5.1