Note: availability of the different VLC specific Lua modules depends on
the type of VLC Lua script your are in.
-Access lists
-------------
-local a = vlc.acl(true) -> new ACL with default set to allow
-a:check("10.0.0.1") -> 0 == allow, 1 == deny, -1 == error
-a("10.0.0.1") -> same as a:check("10.0.0.1")
-a:duplicate() -> duplicate ACL object
-a:add_host("10.0.0.1",true) -> allow 10.0.0.1
-a:add_net("10.0.0.0",24,true) -> allow 10.0.0.0/24 (not sure)
-a:load_file("/path/to/acl") -> load ACL from file
-
Configuration
-------------
config.get( name ): Get the VLC configuration option "name"'s value.
http( host, port, [cert, key, ca, crl]): create a new HTTP (SSL) daemon.
local h = vlc.httpd( "localhost", 8080 )
-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.
-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.
+h:handler( url, user, password, callback, data ) -- add a handler for given url. If user and password are non nil, they will be used to authenticate connecting clients. 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.
+h:file( url, mime, user, password, 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. callback will be called to handle connections. The callback function takes 2 arguments: data and request. It returns the reply as a string.
h:redirect( url_dst, url_src ): Redirect all connections from url_src to url_dst.
Input
-----
input.is_playing(): Return true if input exists.
-input.add_subtitle(url): Add a subtitle to the current input
+input.add_subtitle(url): Add a subtitle file (by path) 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.
misc.mdate(): Get the current date (in microseconds).
misc.mwait(): Wait for the given date (in microseconds).
-misc.should_die(): Returns true if the interface should quit.
misc.quit(): Quit VLC.
Net
---
+----------------------------------------------------------------
+/!\ NB: this namespace is ONLY usable for interfaces and extensions.
+---
+----------------------------------------------------------------
net.url_parse( url, [option delimiter] ): Parse URL. Returns a table with
fields "protocol", "username", "password", "host", "port", path" and
"option".
net.recv( fd, [max length] ): Receive data from fd.
net.poll( { fd = events } ): Implement poll function.
Returns the numbers of file descriptors with a non 0 revent. The function
- modifies the input table to { fd = revents }. See "man poll".
+ modifies the input table to { fd = revents }. See "man poll". This function
+ is not available on Windows.
net.POLLIN/POLLPRI/POLLOUT/POLLRDHUP/POLLERR/POLLHUP/POLLNVAL: poll event flags
-net.read( fd, [max length] ): Read data from fd.
-net.write( fd, string, [length] ): Write data to fd.
+net.read( fd, [max length] ): Read data from fd. This function is not
+ available on Windows.
+net.write( fd, string, [length] ): Write data to fd. This function is not
+ available on Windows.
net.stat( path ): Stat a file. Returns a table with the following fields:
.type
.mode
from 0 to 100. Type can be "horizontal" or "vertical".
osd.channel_register(): Register a new OSD channel. Returns the channel id.
osd.channel_clear( id ): Clear OSD channel.
-osd.menu.show(): Show the OSD menu.
-osd.menu.hide(): Hide the OSD menu.
-osd.menu.prev(): Select previous/left item.
-osd.menu.next(): Select next/right item.
-osd.menu.up(): Move selection up.
-osd.menu.down(): Move selection down.
-osd.menu.activate(): Activate/validate current selection.
Playlist
--------
.nb_played:
.children: A table of children playlist items.
playlist.search( name ): filter the playlist items with the given string
-playlist.current(): return the current input item
+playlist.current(): return the current input item id
playlist.sort( key ): sort the playlist according to the key.
Key must be one of the followings values: 'id', 'title', 'title nodes first',
'artist', 'genre', 'random', 'duration',
'title numeric' or 'album'.
playlist.status(): return the playlist status: 'stopped', 'playing', 'paused' or 'unknown'.
+playlist.delete( id ): check if item of id is in playlist and delete it. returns -1 when invalid id.
+playlist.move( id_item, id_where ): take id_item and if id_where has children, it put it as first children,
+ if id_where don't have children, id_item is put after id_where in same playlist. returns -1 when invalid ids.
FIXME: add methods to get an item's meta, options, es ...
-SD
---
+Services discovery
+------------------
+
+Interfaces and extensions can use the following SD functions:
+
sd.get_services_names(): Get a table of all available service discovery
modules. The module name is used as key, the long name is used as value.
sd.add( name ): Add service discovery.
sd.remove( name ): Remove service discovery.
sd.is_loaded( name ): Check if service discovery is loaded.
+
+Services discovery scripts can use the following SD functions:
+
sd.add_node( ... ): Add a node to the service discovery.
The node object has the following members:
.title: the node's name
to "value". Created vars can be of type float, string, bool or void.
For a void variable the value has to be 'nil'.
-var.add_callback( object, name, function, data ): Add a callback to the
- object's "name" variable. Callback functions take 4 arguments: the
- variable name, the old value, the new value and data.
-var.del_callback( object, name, function, data ): Delete a callback to
- the object's "name" variable. "function" and "data" must be the same as
- when add_callback() was called.
var.trigger_callback( object, name ): Trigger the callbacks associated with the
object's "name" variable.
-var.command( object name, name, argument ): Issue "object name"'s "name"
- command with argument "argument".
var.libvlc_command( name, argument ): Issue libvlc's "name" command with
argument "argument".
projects / vlc / blobdiff