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