misc.should_die(): Returns true if the interface should quit.
misc.quit(): Quit VLC.
+misc.timer(callback): Create a timer which call the callback function
+ :schedule(relative, value, interval): schedule the timer
+ :getoverrun(): number of time the timer got overrun (normally 0)
+
Net
---
net.url_parse( url, [option delimiter] ): Parse URL. Returns a table with
net.close( fd ): Close file descriptor.
net.send( fd, string, [length] ): Send data on fd.
net.recv( fd, [max length] ): Receive data from fd.
-net.poll( { fd = events }, [timeout in seconds] ): Implement poll function.
+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".
net.POLLIN/POLLPRI/POLLOUT/POLLRDHUP/POLLERR/POLLHUP/POLLNVAL: poll event flags
object.playlist(): Get the playlist object.
object.libvlc(): Get the libvlc object.
-object.find( object, type, mode ): Find an object of given type. mode can
- be any of "parent", "child" and "anywhere". If set to "parent", it will
- look in "object"'s parent objects. If set to "child" it will look in
- "object"'s children. If set to "anywhere", it will look in all the
- objects. If object is unset, the current module's object will be used.
- Type can be: "libvlc", "playlist", "input", "decoder",
- "vout", "aout", "packetizer", "generic".
- This function is deprecated and slow and should be avoided.
-object.find_name( object, name, mode ): Same as above except that it matches
- on the object's name and not type. This function is also slow and should
- be avoided if possible.
+object.find( object, type, mode ): Return nil. DO NOT USE.
OSD
---
function returns as many variables as it had arguments.
strings.encode_uri_component( [uri1, [uri2, [...]]] ): Encode a list of URI
components. This function returns as many variables as it had arguments.
+strings.make_uri( path, [scheme] ): Convert a file path to a URI.
strings.resolve_xml_special_chars( [str1, [str2, [...]]] ): Resolve XML
special characters in a list of strings. This function returns as many
variables as it had arguments.
strings.convert_xml_special_chars( [str1, [str2, [...]]] ): Do the inverse
operation.
-strings.iconv( str1 to, str2 from, str ): use vlc_iconv to convert string
- from encoding to another
+strings.from_charset( charset, str ): convert a string from a specified
+ character encoding into UTF-8.
Variables
---------
1st return value is the value list, 2nd return value is the text list.
var.set( object, name, value ): Set the object's variable "name" to "value".
var.create( object, name, value ): Create and set the object's variable "name"
- to "value". Created vars can be of type float, string or bool.
+ 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
var.libvlc_command( name, argument ): Issue libvlc's "name" command with
argument "argument".
+var.inc_integer( name ): Increment the given integer.
+var.dec_integer( name ): Decrement the given integer.
+var.count_choices( name ): Return the number of choices.
+var.toggle_bool( name ): Toggle the given boolean.
+
Video
-----
video.fullscreen( [status] ):
volume.up( [n] ): Increment volume by n steps of 32. n defaults to 1.
volume.down( [n] ): Decrement volume by n steps of 32. n defaults to 1.
+XML
+---
+xml = vlc.xml(): Create an xml object.
+reader = xml:create_reader( stream ): create an xml reader that use the given stream.
+reader:read(): read some data, return -1 on error, 0 on EOF, 1 on start of XML
+ element, 2 on end of XML element, 3 on text
+reader:name(): name of the element
+reader:value(): value of the element
+reader:next_attr(): next attribute of the element
+
+The simplexml module can also be used to parse XML documents easily.
projects / vlc / blobdiff