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  * Extensions (see extensions/README.txt)
  20  * Services Discovery (see sd/README.txt)
  21
  22 Lua scripts are tried in alphabetical order in the user's VLC config
  23 directory lua/{playlist,meta,intf}/ subdirectory on Windows and Mac OS X or
  24 in the user's local share directory (~/.local/share/vlc/lua/... on linux),
  25 then in the global VLC lua/{playlist,meta,intf}/ directory.
  26
  27 3 - VLC specific Lua modules
  28 ============================
  29
  30 All VLC specifc modules are in the "vlc" object. For example, if you want
  31 to use the "info" function of the "msg" VLC specific Lua module:
  32 vlc.msg.info( "This is an info message and will be displayed in the console" )
  33
  34 Note: availability of the different VLC specific Lua modules depends on
  35 the type of VLC Lua script your are in.
  36
  37 Access lists
  38 ------------
  39 local a = vlc.acl(true) -> new ACL with default set to allow
  40 a:check("10.0.0.1") -> 0 == allow, 1 == deny, -1 == error
  41 a("10.0.0.1") -> same as a:check("10.0.0.1")
  42 a:duplicate() -> duplicate ACL object
  43 a:add_host("10.0.0.1",true) -> allow 10.0.0.1
  44 a:add_net("10.0.0.0",24,true) -> allow 10.0.0.0/24 (not sure)
  45 a:load_file("/path/to/acl") -> load ACL from file
  46
  47 Configuration
  48 -------------
  49 config.get( name ): Get the VLC configuration option "name"'s value.
  50 config.set( name, value ): Set the VLC configuration option "name"'s value.
  51
  52 Dialog
  53 ------
  54 local d = vlc.dialog( "My VLC Extension" ): Create a new UI dialog, with a human-readble title: "My VLC Extension"
  55 d:show(): Show this dialog.
  56 d:hide(): Hide (but not close) this dialog.
  57 d:close(): Close and delete this dialog.
  58 d:del_widget( widget ): Delete 'widget'. It disappears from the dialog and repositionning may occur.
  59
  60 In the following functions, you can always add some optional parameters: col, row, col_span, row_span.
  61 They define the position of a widget in the dialog:
  62 - row, col are the absolute positions on a grid of widgets. First row, col are 1.
  63 - row_span, col_span represent the relative size of a widget on the grid. A widget with col_span = 4 will be displayed as wide as 4 widgets of col_span = 1.
  64 Example: w = d:add_label( "My Label", 2, 3, 4, 5 ) will create a label at row 3, col 2, with a relative width of 4, height of 5.
  65
  66 d:add_button( text, func, ... ): Create a button with caption "text" (string). When clicked, call function "func". func is a string.
  67 d:add_label( text, ... ): Create a text label with caption "text" (string).
  68 d:add_html( text, ... ): Create a rich text label with caption "text" (string), that supports basic HTML formatting (such as <i> or <h1> for instance).
  69 d:add_text_input( text, ... ): Create an editable text field, in order to read user input.
  70 d:add_password( text, ... ): Create an editable text field, in order to read user input. Text entered in this box will not be readable (replaced by asterisks).
  71 d:add_check_box( text, ... ): Create a check box with a text. They have a boolean state (true/false).
  72 d:add_dropdown( ... ): Create a drop-down widget. Only 1 element can be selected the same time.
  73 d:add_list( ... ): Create a list widget. Allows multiple or empty selections.
  74 d:add_image( path, ... ): Create an image label. path is a relative or absolute path to the image on the local computer.
  75
  76 Some functions can also be applied on widgets:
  77 w:set_text( text ): Change text displayed by the widget. Applies to: button, label, html, text_input, password, check_box.
  78 w:get_text(): Read text displayed by the widget. Returns a string. Applies to: button, label, html, text_input, password, check_box.
  79 w:set_checked( bool ): Set check state of a check box. Applies to: check_box.
  80 w:get_checked(): Read check state of a check box. Returns a boolean. Applies to: check_box.
  81 w:add_value( text, id ): Add a value with identifier 'id' (integer) and text 'text'. It's always best to have unique identifiers. Applies to: drop_down.
  82 w:get_value(): Return identifier of the selected item. Corresponds to the text value chosen by the user. Applies to: drop_down.
  83 w:clear(): Clear a list or drop_down widget. After that, all values previously added are lost.
  84 w:get_selection(): Retrieve a table representing the current selection. Keys are the ids, values are the texts associated. Applies to: list.
  85
  86
  87 Extension
  88 ---------
  89 deactivate(): Deactivate current extension (after the end of the current function).
  90
  91 HTTPd
  92 -----
  93 http( host, port, [cert, key, ca, crl]): create a new HTTP (SSL) daemon.
  94
  95 local h = vlc.httpd( "localhost", 8080 )
  96 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.
  97 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.
  98 h:redirect( url_dst, url_src ): Redirect all connections from url_src to url_dst.
  99
 100 Input
 101 -----
 102 input.is_playing(): Return true if input exists.
 103 input.add_subtitle(url): Add a subtitle to the current input
 104 input.item(): Get the current input item. Input item methods are:
 105   :uri(): Get item's URI.
 106   :name(): Get item's name.
 107   :duration(): Get item's duration in seconds or negative value if unavailable.
 108   :is_preparsed(): Return true if meta data has been preparsed
 109   :metas(): Get meta data as a table.
 110   :set_meta(key, value): Set meta data.
 111   :info(): Get the current input's info. Return value is a table of tables. Keys of the top level table are info category labels.
 112   :stats(): Get statistics about the input. This is a table with the following fields:
 113     .read_packets
 114     .read_bytes
 115     .input_bitrate
 116     .average_input_bitrate
 117     .demux_read_packets
 118     .demux_read_bytes
 119     .demux_bitrate
 120     .average_demux_bitrate
 121     .demux_corrupted
 122     .demux_discontinuity
 123     .decoded_audio
 124     .decoded_video
 125     .displayed_pictures
 126     .lost_pictures
 127     .sent_packets
 128     .sent_bytes
 129     .send_bitrate
 130     .played_abuffers
 131     .lost_abuffers
 132
 133 MD5
 134 ---
 135 md5( str ): return the string's hash
 136 md5(): create an md5 object with the following methods:
 137   :add( str ): add a string to the hash
 138   :end_(): finish hashing
 139   :hash(): return the hash
 140
 141 Messages
 142 --------
 143 msg.dbg( [str1, [str2, [...]]] ): Output debug messages (-vv).
 144 msg.warn( [str1, [str2, [...]]] ): Output warning messages (-v).
 145 msg.err( [str1, [str2, [...]]] ): Output error messages.
 146 msg.info( [str1, [str2, [...]]] ): Output info messages.
 147
 148 Misc
 149 ----
 150 misc.version(): Get the VLC version string.
 151 misc.copyright(): Get the VLC copyright statement.
 152 misc.license(): Get the VLC license.
 153
 154 misc.datadir(): Get the VLC data directory.
 155 misc.userdatadir(): Get the user's VLC data directory.
 156 misc.homedir(): Get the user's home directory.
 157 misc.configdir(): Get the user's VLC config directory.
 158 misc.cachedir(): Get the user's VLC cache directory.
 159
 160 misc.datadir_list( name ): FIXME: write description ... or ditch function
 161   if it isn't usefull anymore, we have datadir and userdatadir :)
 162
 163 misc.mdate(): Get the current date (in milliseconds).
 164 misc.mwait(): Wait for the given date (in milliseconds).
 165
 166 misc.lock_and_wait(): Lock our object thread and wait for a wake up signal.
 167
 168 misc.should_die(): Returns true if the interface should quit.
 169 misc.quit(): Quit VLC.
 170
 171 Net
 172 ---
 173 net.url_parse( url, [option delimiter] ): Parse URL. Returns a table with
 174   fields "protocol", "username", "password", "host", "port", path" and
 175   "option".
 176 net.listen_tcp( host, port ): Listen to TCP connections. This returns an
 177   object with an accept and an fds method. accept is blocking (Poll on the
 178   fds with the net.POLLIN flag if you want to be non blockin).
 179   The fds method returns a list of fds you can call poll on before using
 180   the accept method. For example:
 181 local l = vlc.net.listen_tcp( "localhost", 1234 )
 182 while true do
 183   local fd = l:accept()
 184   if fd >= 0 do
 185     net.send( fd, "blabla" )
 186     net.close( fd )
 187   end
 188 end
 189 net.close( fd ): Close file descriptor.
 190 net.send( fd, string, [length] ): Send data on fd.
 191 net.recv( fd, [max length] ): Receive data from fd.
 192 net.poll( { fd = events }, [timeout in seconds] ): Implement poll function.
 193   Retruns the numbers of file descriptors with a non 0 revent. The function
 194   modifies the input table to { fd = revents }. See "man poll".
 195 net.POLLIN/POLLPRI/POLLOUT/POLLRDHUP/POLLERR/POLLHUP/POLLNVAL: poll event flags
 196 net.fd_read( fd, [max length] ): Read data from fd.
 197 net.fd_write( fd, string, [length] ): Write data to fd.
 198 net.stat( path ): Stat a file. Returns a table with the following fields:
 199     .type
 200     .mode
 201     .uid
 202     .gid
 203     .size
 204     .access_time
 205     .modification_time
 206     .creation_time
 207 net.opendir( path ): List a directory's contents.
 208
 209 Objects
 210 -------
 211 object.input(): Get the current input object.
 212 object.playlist(): Get the playlist object.
 213 object.libvlc(): Get the libvlc object.
 214
 215 object.find( object, type, mode ): Find an object of given type. mode can
 216   be any of "parent", "child" and "anywhere". If set to "parent", it will
 217   look in "object"'s parent objects. If set to "child" it will look in
 218   "object"'s children. If set to "anywhere", it will look in all the
 219   objects. If object is unset, the current module's object will be used.
 220   Type can be: "libvlc", "playlist", "input", "decoder",
 221   "vout", "aout", "packetizer", "generic".
 222   This function is deprecated and slow and should be avoided.
 223 object.find_name( object, name, mode ): Same as above except that it matches
 224   on the object's name and not type. This function is also slow and should
 225   be avoided if possible.
 226
 227 OSD
 228 ---
 229 osd.icon( type, [id] ): Display an icon on the given OSD channel. Uses the
 230   default channel is none is given. Icon types are: "pause", "play",
 231   "speaker" and "mute".
 232 osd.message( string, [id] ): Display text message on the given OSD channel.
 233 osd.slider( position, type, [id] ): Display slider. Position is an integer
 234   from 0 to 100. Type can be "horizontal" or "vertical".
 235 osd.channel_register(): Register a new OSD channel. Returns the channel id.
 236 osd.channel_clear( id ): Clear OSD channel.
 237 osd.menu.show(): Show the OSD menu.
 238 osd.menu.hide(): Hide the OSD menu.
 239 osd.menu.prev(): Select previous/left item.
 240 osd.menu.next(): Select next/right item.
 241 osd.menu.up(): Move selection up.
 242 osd.menu.down(): Move selection down.
 243 osd.menu.activate(): Activate/validate current selection.
 244
 245 Playlist
 246 --------
 247 playlist.prev(): Play previous track.
 248 playlist.next(): Play next track.
 249 playlist.skip( n ): Skip n tracs.
 250 playlist.play(): Play.
 251 playlist.pause(): Pause.
 252 playlist.stop(): Stop.
 253 playlist.clear(): Clear the playlist.
 254 playlist.repeat_( [status] ): Toggle item repeat or set to specified value.
 255 playlist.loop( [status] ): Toggle playlist loop or set to specified value.
 256 playlist.random( [status] ): Toggle playlsit random or set to specified value.
 257 playlist.goto( id ): Go to specified track.
 258 playlist.add( ... ): Add a bunch of items to the playlist.
 259   The playlist is a table of playlist objects.
 260   A playlist object has the following members:
 261       .path: the item's full path / URL
 262       .name: the item's name in playlist (OPTIONAL)
 263       .title: the item's Title (OPTIONAL, meta data)
 264       .artist: the item's Artist (OPTIONAL, meta data)
 265       .genre: the item's Genre (OPTIONAL, meta data)
 266       .copyright: the item's Copyright (OPTIONAL, meta data)
 267       .album: the item's Album (OPTIONAL, meta data)
 268       .tracknum: the item's Tracknum (OPTIONAL, meta data)
 269       .description: the item's Description (OPTIONAL, meta data)
 270       .rating: the item's Rating (OPTIONAL, meta data)
 271       .date: the item's Date (OPTIONAL, meta data)
 272       .setting: the item's Setting (OPTIONAL, meta data)
 273       .url: the item's URL (OPTIONAL, meta data)
 274       .language: the item's Language (OPTIONAL, meta data)
 275       .nowplaying: the item's NowPlaying (OPTIONAL, meta data)
 276       .publisher: the item's Publisher (OPTIONAL, meta data)
 277       .encodedby: the item's EncodedBy (OPTIONAL, meta data)
 278       .arturl: the item's ArtURL (OPTIONAL, meta data)
 279       .trackid: the item's TrackID (OPTIONAL, meta data)
 280       .options: a list of VLC options (OPTIONAL)
 281                 example: .options = { "fullscreen" }
 282       .duration: stream duration in seconds (OPTIONAL)
 283       .meta: custom meta data (OPTIONAL, meta data)
 284              A .meta field is a table of custom meta categories which
 285              each have custom meta properties.
 286              example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }
 287   Invalid playlist items will be discarded by VLC.
 288 playlist.enqueue( ... ): like playlist.add() except that track isn't played.
 289 playlist.get( [what, [tree]] ): Get the playist.
 290   If "what" is a number, then this will return the corresponding playlist
 291   item's playlist hierarchy. If it is "normal" or "playlist", it will
 292   return the normal playlist. If it is "ml" or "media library", it will
 293   return the media library. If it is "root" it will return the full playlist.
 294   If it is a service discovery module's name, it will return that service
 295   discovery's playlist. If it is any other string, it won't return anything.
 296   Else it will return the fullplaylist.
 297   The second argument, "tree", is optional. If set to true or unset, the
 298   playlist will be returned in a tree layout. If set to false, the playlist
 299   will be returned using the flat layout.
 300   Each playlist item returned will have the following members:
 301       .id: The item's id.
 302       .flags: a table with the following members if the corresponing flag is
 303               set:
 304           .save
 305           .skip
 306           .disabled
 307           .ro
 308           .remove
 309           .expanded
 310       .name:
 311       .path:
 312       .duration: (-1 if unknown)
 313       .nb_played:
 314       .children: A table of children playlist items.
 315
 316 FIXME: add methods to get an item's meta, options, es ...
 317
 318 SD
 319 --
 320 sd.get_services_names(): Get a table of all available service discovery
 321   modules. The module name is used as key, the long name is used as value.
 322 sd.add( name ): Add service discovery.
 323 sd.remove( name ): Remove service discovery.
 324 sd.is_loaded( name ): Check if service discovery is loaded.
 325 sd.add_item( ... ): Add an item to the service discovery.
 326   The item object has the same members as the one in playlist.add().
 327   Returns the input item.
 328 sd.add_node( ... ): Add a node to the service discovery.
 329   The node object has the following members:
 330       .title: the node's name
 331       .arturl: the node's ArtURL (OPTIONAL)
 332
 333 n = vlc.sd.add_node( {title="Node"} )
 334 n:add_subitem( ... ): Same as sd.add_item(), but as a subitem of n.
 335 n:add_node( ... ): Same as sd.add_node(), but as a subnode of n.
 336
 337 Stream
 338 ------
 339 stream( url ): Instantiate a stream object for specific url.
 340
 341 s = vlc.stream( "http://www.videolan.org/" )
 342 s:read( 128 ) -- read up to 128 characters. Return 0 if no more data is available (FIXME?).
 343 s:readline() -- read a line. Return nil if EOF was reached.
 344 s:addfilter() -- add a stream filter. If no argument was specified, try to add all automatic stream filters.
 345
 346 Strings
 347 -------
 348 strings.decode_uri( [uri1, [uri2, [...]]] ): Decode a list of URIs. This
 349   function returns as many variables as it had arguments.
 350 strings.encode_uri_component( [uri1, [uri2, [...]]] ): Encode a list of URI
 351   components. This function returns as many variables as it had arguments.
 352 strings.resolve_xml_special_chars( [str1, [str2, [...]]] ): Resolve XML
 353   special characters in a list of strings. This function returns as many
 354   variables as it had arguments.
 355 strings.convert_xml_special_chars( [str1, [str2, [...]]] ): Do the inverse
 356   operation.
 357
 358 Variables
 359 ---------
 360 var.get( object, name ): Get the object's variable "name"'s value.
 361 var.set( object, name, value ): Set the object's variable "name" to "value".
 362 var.get_list( object, name ): Get the object's variable "name"'s value list.
 363   1st return value is the value list, 2nd return value is the text list.
 364 var.create( object, name, value ): Create and set the object's variable "name"
 365   to "value". Created vars can be of type float, string or bool.
 366
 367 var.add_callback( object, name, function, data ): Add a callback to the
 368   object's "name" variable. Callback functions take 4 arguments: the
 369   variable name, the old value, the new value and data.
 370 var.del_callback( object, name, function, data ): Delete a callback to
 371   the object's "name" variable. "function" and "data" must be the same as
 372   when add_callback() was called.
 373 var.trigger_callback( object, name ): Trigger the callbacks associated with the
 374   object's "name" variable.
 375
 376 var.command( object name, name, argument ): Issue "object name"'s "name"
 377   command with argument "argument".
 378 var.libvlc_command( name, arguement ): Issue libvlc's "name" command with
 379   argument "argument".
 380
 381 Video
 382 -----
 383 video.fullscreen( [status] ):
 384  * toggle fullscreen if no arguments are given
 385  * switch to fullscreen 1st argument is true
 386  * disable fullscreen if 1st argument is false
 387
 388 VLM
 389 ---
 390 vlm(): Instanciate a VLM object.
 391
 392 v = vlc.vlm()
 393 v:execute_command( "new test broadcast" ) -- execute given VLM command
 394
 395 Note: if the VLM object is deleted and you were the last person to hold
 396 a reference to it, all VLM items will be deleted.
 397
 398 Volume
 399 ------
 400 volume.set( level ): Set volume to an absolute level between 0 and 1024.
 401   256 is 100%.
 402 volume.get(): Get volume.
 403 volume.up( [n] ): Increment volume by n steps of 32. n defaults to 1.
 404 volume.down( [n] ): Decrement volume by n steps of 32. n defaults to 1.
 405