git.sesse.net Git - vlc/blob - share/lua/README.txt

   1 Instructions to code your own VLC Lua scripts.
   2 $Id$
   3
   4 1 - About Lua
   5 =============
   6
   7 Lua documenation is available on http://www.lua.org . The reference manual
   8 is very usefull: http://www.lua.org/manual/5.1/ .
   9 VLC uses Lua 5.1
  10 All the Lua standard libraries are available.
  11
  12 2 - Lua in VLC
  13 ==============
  14
  15 3 types of VLC Lua scripts can currently be coded:
  16  * Playlist (see playlist/README.txt)
  17  * Art fetcher (see meta/README.txt)
  18  * Interface (see intf/README.txt)
  19
  20 Lua scripts are tried in alphabetical order in the user's VLC config (FIXME)
  21 directory lua/{playlist,meta,intf}/ subdirectory, then in the global VLC
  22 lua/{playlist,meta,intf}/ directory.
  23
  24 3 - VLC specific Lua modules
  25 ============================
  26
  27 All VLC specifc modules are in the "vlc" object. For example, if you want
  28 to use the "info" function of the "msg" VLC specific Lua module:
  29 vlc.msg.info( "This is an info message and will be displayed in the console" )
  30
  31 Note: availability of the different VLC specific Lua modules depends on
  32 the type of VLC Lua script your are in.
  33
  34 Access lists
  35 ------------
  36 local a = vlc.acl(true) -> new ACL with default set to allow
  37 a:check("10.0.0.1") -> 0 == allow, 1 == deny, -1 == error
  38 a("10.0.0.1") -> same as a:check("10.0.0.1")
  39 a:duplicate() -> duplicate ACL object
  40 a:add_host("10.0.0.1",true) -> allow 10.0.0.1
  41 a:add_net("10.0.0.0",24,true) -> allow 10.0.0.0/24 (not sure)
  42 a:load_file("/path/to/acl") -> load ACL from file
  43
  44 Configuration
  45 -------------
  46 config.get( name ): Get the VLC configuration option "name"'s value.
  47 config.set( name, value ): Set the VLC configuration option "name"'s value.
  48
  49 HTTPd
  50 -----
  51 http( host, port, [cert, key, ca, crl]): create a new HTTP (SSL) daemon.
  52
  53 local h = vlc.httpd( "localhost", 8080 )
  54 h:handler( url, user, password, acl, callback, data ) -- add a handler for given url. If user and password are non nil, they will be used to authenticate connecting clients. If acl is non nil, it will be used to restrict access. callback will be called to handle connections. The callback function takes 7 arguments: data, url, request, type, in, addr, host. It returns the reply as a string.
  55 h:file( url, mime, user, password, acl, callback, data ) -- add a file for given url with given mime type. If user and password are non nil, they will be used to authenticate connecting clients. If acl is non nil, it will be used to restrict access. callback will be called to handle connections. The callback function takes 2 arguments: data and request. It returns the reply as a string.
  56 h:redirect( url_dst, url_src ): Redirect all connections from url_src to url_dst.
  57
  58 Input
  59 -----
  60 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.
  61 input.is_playing(): Return true if input exists.
  62 input.get_title(): Get the input's name.
  63 input.stats(): Get statistics about the input. This is a table with the following fields:
  64     .read_bytes
  65     .input_bitrate
  66     .demux_read_bytes
  67     .demux_bitrate
  68     .decoded_video
  69     .displayed_pictures
  70     .lost_pictures
  71     .decoded_audio
  72     .played_abuffers
  73     .lost_abuffers
  74     .sent_packets
  75     .sent_bytes
  76     .send_bitrate
  77
  78 Messages
  79 --------
  80 msg.dbg( [str1, [str2, [...]]] ): Output debug messages (-vv).
  81 msg.warn( [str1, [str2, [...]]] ): Output warning messages (-v).
  82 msg.err( [str1, [str2, [...]]] ): Output error messages.
  83 msg.info( [str1, [str2, [...]]] ): Output info messages.
  84
  85 Misc
  86 ----
  87 misc.version(): Get the VLC version string.
  88 misc.copyright(): Get the VLC copyright statement.
  89 misc.license(): Get the VLC license.
  90
  91 misc.datadir(): Get the VLC data directory.
  92 misc.userdatadir(): Get the user's VLC data directory.
  93 misc.homedir(): Get the user's home directory.
  94 misc.configdir(): Get the user's VLC config directory.
  95 misc.cachedir(): Get the user's VLC cache directory.
  96
  97 misc.datadir_list( name ): FIXME: write description ... or ditch function if it isn't usefull anymore, we have datadir and userdatadir :)
  98
  99 misc.mdate(): Get the current date (in miliseconds).
 100
 101 misc.lock_and_wait(): Lock our object thread and wait for a wake up signal.
 102 misc.signal(): Wake up our object thread.
 103
 104 misc.should_die(): Returns true if the interface should quit.
 105 misc.quit(): Quit VLC.
 106
 107 Net
 108 ---
 109 net.url_parse( url, [option delimiter] ): Parse URL. Returns a table with
 110   fields "protocol", "username", "password", "host", "port", path" and
 111   "option".
 112 net.listen_tcp( host, port ): Listen to TCP connections. This returns an
 113   object with an accept method. This method takes an optional timeout
 114   argument (in miliseconds). For example:
 115 local l = vlc.net.listen_tcp( "localhost", 1234 )
 116 while true do
 117   local fd = l:accept( 500 )
 118   if fd >= 0 do
 119     net.send( fd, "blabla" )
 120     net.close( fd )
 121   end
 122 end
 123 net.close( fd ): Close file descriptor.
 124 net.send( fd, string, [length] ): Send data on fd.
 125 net.recv( fd, [max length] ): Receive data from fd.
 126 net.select( nfds, fds_read, fds_write, timeout ): Monitor a bunch of file descriptors. Returns number of fds to handle and the amount of time not slept. See "man select".
 127 net.fd_set_new(): Create a new fd_set.
 128 local fds = vlc.net.fd_set_new()
 129 fds:clr( fd ) -- remove fd from set
 130 fds:isset( fd ) -- check if fd is set
 131 fds:set( fd ) -- add fd to set
 132 fds:zero() -- clear the set
 133 net.fd_read( fd, [max length] ): Read data from fd.
 134 net.fd_write( fd, string, [length] ): Write data to fd.
 135 net.stat( path ): Stat a file. Returns a table with the following fields:
 136     .type
 137     .mode
 138     .uid
 139     .gid
 140     .size
 141     .access_time
 142     .modification_time
 143     .creation_time
 144 net.opendir( path ): List a directory's contents.
 145
 146 Objects
 147 -------
 148 object.input(): Get the current input object.
 149 object.playlist(): Get the playlist object.
 150 object.libvlc(): Get the libvlc object.
 151
 152 object.find( object, type, mode ): Find an object of given type. mode can
 153   be any of "parent", "child" and "anywhere". If set to "parent", it will
 154   look in "object"'s parent objects. If set to "child" it will look in
 155   "object"'s children. If set to "anywhere", it will look in all the
 156   objects. If object is unset, the current module's object will be used.
 157   Type can be: "libvlc", "module", "intf", "playlist", "input", "decoder",
 158   "vout", "aout", "packetizer", "encoder", "dialogs", "announce", "demux",
 159   "access", "stream", "opengl", "filter", "osdmenu", "httpd_host",
 160   "interaction", "generic". This function is slow and should be avoided.
 161 object.find_name( object, name, mode ): Same as above except that it matches
 162   on the object's name and not type. This function is also slow and should
 163   be avoided if possible.
 164
 165 OSD
 166 ---
 167 osd.icon( type, [id] ): Display an icon on the given OSD channel. Uses the
 168   default channel is none is given. Icon types are: "pause", "play",
 169   "speaker" and "mute".
 170 osd.message( string, [id] ): Display text message on the given OSD channel.
 171 osd.slider( position, type, [id] ): Display slider. Position is an integer
 172   from 0 to 100. Type can be "horizontal" or "vertical".
 173 osd.channel_register(): Register a new OSD channel. Returns the channel id.
 174 osd.channel_clear( id ): Clear OSD channel.
 175
 176 Playlist
 177 --------
 178 playlist.prev(): Play previous track.
 179 playlist.next(): Play next track.
 180 playlist.skip( n ): Skip n tracs.
 181 playlist.play(): Play.
 182 playlist.pause(): Pause.
 183 playlist.stop(): Stop.
 184 playlist.clear(): Clear the playlist.
 185 playlist.repeat( [status] ): Toggle item repeat or set to specified value.
 186 playlist.loop( [status] ): Toggle playlist loop or set to specified value.
 187 playlist.random( [status] ): Toggle playlsit random or set to specified value.
 188 playlist.goto( id ): Go to specified track.
 189 playlist.add( ... ): Add a bunch of items to the playlist.
 190   The playlist is a table of playlist objects.
 191   A playlist object has the following members:
 192       .path: the item's full path / URL
 193       .name: the item's name in playlist (OPTIONAL)
 194       .title: the item's Title (OPTIONAL, meta data)
 195       .artist: the item's Artist (OPTIONAL, meta data)
 196       .genre: the item's Genre (OPTIONAL, meta data)
 197       .copyright: the item's Copyright (OPTIONAL, meta data)
 198       .album: the item's Album (OPTIONAL, meta data)
 199       .tracknum: the item's Tracknum (OPTIONAL, meta data)
 200       .description: the item's Description (OPTIONAL, meta data)
 201       .rating: the item's Rating (OPTIONAL, meta data)
 202       .date: the item's Date (OPTIONAL, meta data)
 203       .setting: the item's Setting (OPTIONAL, meta data)
 204       .url: the item's URL (OPTIONAL, meta data)
 205       .language: the item's Language (OPTIONAL, meta data)
 206       .nowplaying: the item's NowPlaying (OPTIONAL, meta data)
 207       .publisher: the item's Publisher (OPTIONAL, meta data)
 208       .encodedby: the item's EncodedBy (OPTIONAL, meta data)
 209       .arturl: the item's ArtURL (OPTIONAL, meta data)
 210       .trackid: the item's TrackID (OPTIONAL, meta data)
 211       .options: a list of VLC options (OPTIONAL)
 212                 example: .options = { "fullscreen" }
 213       .duration: stream duration in seconds (OPTIONAL)
 214       .meta: custom meta data (OPTIONAL, meta data)
 215              A .meta field is a table of custom meta categories which
 216              each have custom meta properties.
 217              example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }
 218   Invalid playlist items will be discarded by VLC.
 219 playlist.enqueue( ... ): like playlist.add() except that track isn't played.
 220 playlist.get( [what, [tree]] ): Get the playist.
 221   If "what" is a number, then this will return the corresponding playlist
 222   item's playlist hierarchy. If it is "normal" or "playlist", it will
 223   return the normal playlist. If it is "ml" or "media library", it will
 224   return the media library. If it is "root" it will return the full playlist.
 225   If it is a service discovery module's name, it will return that service
 226   discovery's playlist. If it is any other string, it won't return anything.
 227   Else it will return the fullplaylist.
 228   The second argument, "tree", is optional. If set to true or unset, the
 229   playlist will be returned in a tree layout. If set to false, the playlist
 230   will be returned using the flat layout.
 231   Each playlist item returned will have the following members:
 232       .id: The item's id.
 233       .flags: a table with the following members if the corresponing flag is
 234               set:
 235           .save
 236           .skip
 237           .disabled
 238           .ro
 239           .remove
 240           .expanded
 241       .name:
 242       .path:
 243       .duration: (-1 if unknown)
 244       .nb_played:
 245       .children: A table of children playlist items.
 246
 247 FIXME: add methods to get an item's meta, options, es ...
 248
 249 SD
 250 --
 251 sd.get_services_names(): Get a table of all available service discovery
 252   modules. The module name is used as key, the long name is used as value.
 253 sd.add( name ): Add service discovery.
 254 sd.remove( name ): Remove service discovery.
 255 sd.is_loaded( name ): Check if service discovery is loaded.
 256
 257 Stream
 258 ------
 259 stream( url ): Instantiate a stream object for specific url.
 260
 261 s = vlc.stream( "http://www.videolan.org/" )
 262 s:read( 128 ) -- read up to 128 characters. Return 0 if no more data is available (FIXME?).
 263 s:readline() -- read a line. Return nil if EOF was reached.
 264
 265 Strings
 266 -------
 267 strings.decode_uri( [uri1, [uri2, [...]]] ): Decode a list of URIs. This
 268   function returns as many variables as it had arguments.
 269 strings.resolve_xml_special_chars( [str1, [str2, [...]]] ): Resolve XML
 270   special characters in a list of strings. This function returns as many
 271   variables as it had arguments.
 272 strings.convert_xml_special_chars( [str1, [str2, [...]]] ): Do the inverse
 273   operation.
 274
 275 Variables
 276 ---------
 277 var.get( object, name ): Get the object's variable "name"'s value.
 278 var.set( object, name, value ): Set the object's variable "name" to "value".
 279 var.get_list( object, name ): Get the object's variable "name"'s value list.
 280   1st return value is the value list, 2nd return value is the text list.
 281
 282 var.add_callback( object, name, function, data ): Add a callback to the
 283   object's "name" variable. Callback functions take 4 arguments: the
 284   variable name, the old value, the new value and data.
 285 var.del_callback( object, name, function, data ): Delete a callback to
 286   the object's "name" variable. "function" and "data" must be the same as
 287   when add_callback() was called.
 288
 289 var.command( object name, name, argument ): Issue "object name"'s "name"
 290   command with argument "argument".
 291 var.libvlc_command( name, arguement ): Issue libvlc's "name" command with
 292   argument "argument".
 293
 294 Video
 295 -----
 296 video.fullscreen( [status] ):
 297  * toggle fullscreen if no arguments are given
 298  * switch to fullscreen 1st argument is true
 299  * disable fullscreen if 1st argument is false
 300
 301 VLM
 302 ---
 303 vlm(): Instanciate a VLM object.
 304
 305 v = vlc.vlm()
 306 v:execute_command( "new test broadcast" ) -- execute given VLM command
 307
 308 Note: if the VLM object is deleted and you were the last person to hold
 309 a reference to it, all VLM items will be deleted.
 310
 311 Volume
 312 ------
 313 volume.set( level ): Set volume to an absolute level between 0 and 1024.
 314 volume.get(): Get volume.
 315 volume.up( [n] ): Increment volume by n steps of 32. n defaults to 1.
 316 volume.down( [n] ): Decrement volume by n steps of 32. n defaults to 1.
 317