Ignore .luac files

[vlc] / share / lua / README.txt

diff --git a/share/lua/README.txt b/share/lua/README.txt
index d29400dc13e8077e27e54cc73a2709a1e3af0fdc..f7e6283edb527b78efc7d5758fbcf23e986f57aa 100644 (file)
--- a/share/lua/README.txt
+++ b/share/lua/README.txt
@@ -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
@@ -98,23 +99,44 @@ h:redirect( url_dst, url_src ): Redirect all connections from url_src to url_dst
 
 Input
 -----
-input.info(): Get the current input's info. Return value is a table of tables. Keys of the top level table are info category labels.
 input.is_playing(): Return true if input exists.
-input.get_title(): Get the input's name.
-input.stats(): Get statistics about the input. This is a table with the following fields:
+input.add_subtitle(url): Add a subtitle to the current input
+input.item(): Get the current input item. Input item methods are:
+  :uri(): Get item's URI.
+  :name(): Get item's name.
+  :duration(): Get item's duration in seconds or negative value if unavailable.
+  :is_preparsed(): Return true if meta data has been preparsed
+  :metas(): Get meta data as a table.
+  :set_meta(key, value): Set meta data.
+  :info(): Get the current input's info. Return value is a table of tables. Keys of the top level table are info category labels.
+  :stats(): Get statistics about the input. This is a table with the following fields:
+    .read_packets
     .read_bytes
     .input_bitrate
+    .average_input_bitrate
+    .demux_read_packets
     .demux_read_bytes
     .demux_bitrate
+    .average_demux_bitrate
+    .demux_corrupted
+    .demux_discontinuity
+    .decoded_audio
     .decoded_video
     .displayed_pictures
     .lost_pictures
-    .decoded_audio
-    .played_abuffers
-    .lost_abuffers
     .sent_packets
     .sent_bytes
     .send_bitrate
+    .played_abuffers
+    .lost_abuffers
+
+MD5
+---
+md5( str ): return the string's hash
+md5(): create an md5 object with the following methods:
+  :add( str ): add a string to the hash
+  :end_(): finish hashing
+  :hash(): return the hash
 
 Messages
 --------
@@ -300,6 +322,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
 ------