MKV: parse more metadata

[vlc] / share / lua / README.txt

diff --git a/share/lua/README.txt b/share/lua/README.txt
index 15b2115c1283c698df5fac5bc2d9b7c07ffb3d0f..76a1469d29065c6680d7043344a6968a2b0ad5bf 100644 (file)
--- a/share/lua/README.txt
+++ b/share/lua/README.txt
@@ -221,24 +221,17 @@ Objects
 object.input(): Get the current input object.
 object.playlist(): Get the playlist object.
 object.libvlc(): Get the libvlc object.
+object.aout(): Get the audio output object.
+object.vout(): Get the video output object.
 
-object.find( object, type, mode ): Find an object of given type. mode can
-  be "child" and "anywhere". If set to "child" it will look in "object"'s
-  children. If set to "anywhere", it will look in all the objects. If
-  object is unset, the current module's object will be used.
-  Type can be: "libvlc", "playlist", "input", "decoder",
-  "vout", "aout", "packetizer", "generic".
-  This function is deprecated and slow and should be avoided.
-object.find_name( object, name, mode ): Same as above except that it matches
-  on the object's name and not type. This function is also slow and should
-  be avoided if possible.
+object.find( object, type, mode ): Return nil. DO NOT USE.
 
 OSD
 ---
 osd.icon( type, [id] ): Display an icon on the given OSD channel. Uses the
   default channel is none is given. Icon types are: "pause", "play",
   "speaker" and "mute".
-osd.message( string, [id], [position], [duration]: Display the text message on
+osd.message( string, [id], [position], [duration] ): Display the text message on
   the given OSD channel. Position types are: "center", "left", "right", "top",
   "bottom", "top-left", "top-right", "bottom-left" or "bottom-right". The
   duration is set in microseconds.
@@ -293,9 +286,8 @@ playlist.add( ... ): Add a bunch of items to the playlist.
                 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!" } }
+             A .meta field is a table of custom meta key value pairs.
+             example: .meta = { ["GVP docid"] = "-5784010886294950089", ["GVP version] = "1.1", Hello = "World!" }
   Invalid playlist items will be discarded by VLC.
 playlist.enqueue( ... ): like playlist.add() except that track isn't played.
 playlist.get( [what, [tree]] ): Get the playlist.
@@ -383,6 +375,8 @@ strings.from_charset( charset, str ): convert a string from a specified
 
 Variables
 ---------
+var.inherit( object, name ): Find the variable "name"'s value inherited by
+  the object. If object is unset, the current module's object will be used.
 var.get( object, name ): Get the object's variable "name"'s value.
 var.get_list( object, name ): Get the object's variable "name"'s value list.
   1st return value is the value list, 2nd return value is the text list.