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. accept is blocking (Poll on the
 116   fds with the net.POLLIN flag if you want to be non blockin).
 117   The fds method returns a list of fds you can call poll on before using
 118   the accept method. For example:
 119 local l = vlc.net.listen_tcp( "localhost", 1234 )
 120 while true do
 121   local fd = l:accept()
 122   if fd >= 0 do
 123     net.send( fd, "blabla" )
 124     net.close( fd )
 125   end
 126 end
 127 net.close( fd ): Close file descriptor.
 128 net.send( fd, string, [length] ): Send data on fd.
 129 net.recv( fd, [max length] ): Receive data from fd.
 130 net.poll( { fd = events }, [timeout in seconds] ): Implement poll function.
 131   Retruns the numbers of file descriptors with a non 0 revent. The function
 132   modifies the input table to { fd = revents }. See "man poll".
 133 net.POLLIN/POLLPRI/POLLOUT/POLLRDHUP/POLLERR/POLLHUP/POLLNVAL: poll event flags
 134 net.fd_read( fd, [max length] ): Read data from fd.
 135 net.fd_write( fd, string, [length] ): Write data to fd.
 136 net.stat( path ): Stat a file. Returns a table with the following fields:
 137     .type
 138     .mode
 139     .uid
 140     .gid
 141     .size
 142     .access_time
 143     .modification_time
 144     .creation_time
 145 net.opendir( path ): List a directory's contents.
 146
 147 Objects
 148 -------
 149 object.input(): Get the current input object.
 150 object.playlist(): Get the playlist object.
 151 object.libvlc(): Get the libvlc object.
 152
 153 object.find( object, type, mode ): Find an object of given type. mode can
 154   be any of "parent", "child" and "anywhere". If set to "parent", it will
 155   look in "object"'s parent objects. If set to "child" it will look in
 156   "object"'s children. If set to "anywhere", it will look in all the
 157   objects. If object is unset, the current module's object will be used.
 158   Type can be: "libvlc", "playlist", "input", "decoder",
 159   "vout", "aout", "packetizer", "generic".
 160   This function is deprecated and 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 osd.menu.show(): Show the OSD menu.
 176 osd.menu.hide(): Hide the OSD menu.
 177 osd.menu.prev(): Select previous/left item.
 178 osd.menu.next(): Select next/right item.
 179 osd.menu.up(): Move selection up.
 180 osd.menu.down(): Move selection down.
 181 osd.menu.activate(): Activate/validate current selection.
 182
 183 Playlist
 184 --------
 185 playlist.prev(): Play previous track.
 186 playlist.next(): Play next track.
 187 playlist.skip( n ): Skip n tracs.
 188 playlist.play(): Play.
 189 playlist.pause(): Pause.
 190 playlist.stop(): Stop.
 191 playlist.clear(): Clear the playlist.
 192 playlist.repeat_( [status] ): Toggle item repeat or set to specified value.
 193 playlist.loop( [status] ): Toggle playlist loop or set to specified value.
 194 playlist.random( [status] ): Toggle playlsit random or set to specified value.
 195 playlist.goto( id ): Go to specified track.
 196 playlist.add( ... ): Add a bunch of items to the playlist.
 197   The playlist is a table of playlist objects.
 198   A playlist object has the following members:
 199       .path: the item's full path / URL
 200       .name: the item's name in playlist (OPTIONAL)
 201       .title: the item's Title (OPTIONAL, meta data)
 202       .artist: the item's Artist (OPTIONAL, meta data)
 203       .genre: the item's Genre (OPTIONAL, meta data)
 204       .copyright: the item's Copyright (OPTIONAL, meta data)
 205       .album: the item's Album (OPTIONAL, meta data)
 206       .tracknum: the item's Tracknum (OPTIONAL, meta data)
 207       .description: the item's Description (OPTIONAL, meta data)
 208       .rating: the item's Rating (OPTIONAL, meta data)
 209       .date: the item's Date (OPTIONAL, meta data)
 210       .setting: the item's Setting (OPTIONAL, meta data)
 211       .url: the item's URL (OPTIONAL, meta data)
 212       .language: the item's Language (OPTIONAL, meta data)
 213       .nowplaying: the item's NowPlaying (OPTIONAL, meta data)
 214       .publisher: the item's Publisher (OPTIONAL, meta data)
 215       .encodedby: the item's EncodedBy (OPTIONAL, meta data)
 216       .arturl: the item's ArtURL (OPTIONAL, meta data)
 217       .trackid: the item's TrackID (OPTIONAL, meta data)
 218       .options: a list of VLC options (OPTIONAL)
 219                 example: .options = { "fullscreen" }
 220       .duration: stream duration in seconds (OPTIONAL)
 221       .meta: custom meta data (OPTIONAL, meta data)
 222              A .meta field is a table of custom meta categories which
 223              each have custom meta properties.
 224              example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }
 225   Invalid playlist items will be discarded by VLC.
 226 playlist.enqueue( ... ): like playlist.add() except that track isn't played.
 227 playlist.get( [what, [tree]] ): Get the playist.
 228   If "what" is a number, then this will return the corresponding playlist
 229   item's playlist hierarchy. If it is "normal" or "playlist", it will
 230   return the normal playlist. If it is "ml" or "media library", it will
 231   return the media library. If it is "root" it will return the full playlist.
 232   If it is a service discovery module's name, it will return that service
 233   discovery's playlist. If it is any other string, it won't return anything.
 234   Else it will return the fullplaylist.
 235   The second argument, "tree", is optional. If set to true or unset, the
 236   playlist will be returned in a tree layout. If set to false, the playlist
 237   will be returned using the flat layout.
 238   Each playlist item returned will have the following members:
 239       .id: The item's id.
 240       .flags: a table with the following members if the corresponing flag is
 241               set:
 242           .save
 243           .skip
 244           .disabled
 245           .ro
 246           .remove
 247           .expanded
 248       .name:
 249       .path:
 250       .duration: (-1 if unknown)
 251       .nb_played:
 252       .children: A table of children playlist items.
 253
 254 FIXME: add methods to get an item's meta, options, es ...
 255
 256 SD
 257 --
 258 sd.get_services_names(): Get a table of all available service discovery
 259   modules. The module name is used as key, the long name is used as value.
 260 sd.add( name ): Add service discovery.
 261 sd.remove( name ): Remove service discovery.
 262 sd.is_loaded( name ): Check if service discovery is loaded.
 263
 264 Stream
 265 ------
 266 stream( url ): Instantiate a stream object for specific url.
 267
 268 s = vlc.stream( "http://www.videolan.org/" )
 269 s:read( 128 ) -- read up to 128 characters. Return 0 if no more data is available (FIXME?).
 270 s:readline() -- read a line. Return nil if EOF was reached.
 271 s:addfilter() -- add a stream filter. If no argument was specified, try to add all automatic stream filters.
 272
 273 Strings
 274 -------
 275 strings.decode_uri( [uri1, [uri2, [...]]] ): Decode a list of URIs. This
 276   function returns as many variables as it had arguments.
 277 strings.encode_uri_component( [uri1, [uri2, [...]]] ): Encode a list of URI
 278   components. This function returns as many variables as it had arguments.
 279 strings.resolve_xml_special_chars( [str1, [str2, [...]]] ): Resolve XML
 280   special characters in a list of strings. This function returns as many
 281   variables as it had arguments.
 282 strings.convert_xml_special_chars( [str1, [str2, [...]]] ): Do the inverse
 283   operation.
 284
 285 Variables
 286 ---------
 287 var.get( object, name ): Get the object's variable "name"'s value.
 288 var.set( object, name, value ): Set the object's variable "name" to "value".
 289 var.get_list( object, name ): Get the object's variable "name"'s value list.
 290   1st return value is the value list, 2nd return value is the text list.
 291 var.create( object, name, value ): Create and set the object's variable "name"
 292   to "value". Created vars can be of type float, string or bool.
 293
 294 var.add_callback( object, name, function, data ): Add a callback to the
 295   object's "name" variable. Callback functions take 4 arguments: the
 296   variable name, the old value, the new value and data.
 297 var.del_callback( object, name, function, data ): Delete a callback to
 298   the object's "name" variable. "function" and "data" must be the same as
 299   when add_callback() was called.
 300 var.trigger_callback( object, name ): Trigger the callbacks associated with the
 301   object's "name" variable.
 302
 303 var.command( object name, name, argument ): Issue "object name"'s "name"
 304   command with argument "argument".
 305 var.libvlc_command( name, arguement ): Issue libvlc's "name" command with
 306   argument "argument".
 307
 308 Video
 309 -----
 310 video.fullscreen( [status] ):
 311  * toggle fullscreen if no arguments are given
 312  * switch to fullscreen 1st argument is true
 313  * disable fullscreen if 1st argument is false
 314
 315 VLM
 316 ---
 317 vlm(): Instanciate a VLM object.
 318
 319 v = vlc.vlm()
 320 v:execute_command( "new test broadcast" ) -- execute given VLM command
 321
 322 Note: if the VLM object is deleted and you were the last person to hold
 323 a reference to it, all VLM items will be deleted.
 324
 325 Volume
 326 ------
 327 volume.set( level ): Set volume to an absolute level between 0 and 1024.
 328   256 is 100%.
 329 volume.get(): Get volume.
 330 volume.up( [n] ): Increment volume by n steps of 32. n defaults to 1.
 331 volume.down( [n] ): Decrement volume by n steps of 32. n defaults to 1.
 332