Documentation:Modules/lua

Module: lua
Type	Interface
First VLC version	-
Last VLC version	-
Operating system(s)	all
Description	Lua interpreter
Shortcut(s)	luaintf

Options

• lua-intf <string> : Lua interface module to load default value: "dummy"
• lua-config <string> : Lua interface configuration string. Format is: '["<interface module name>"] = { <option> = <value>, ...}, ...'. default value: ""

Lua HTTP

Module: luahttp
Type	Interface
First VLC version	-
Last VLC version	-
Operating system(s)	all
Description	Lua HTTP
Shortcut(s)	luahttp, http

• http-password <password> : A single password restricts access to this interface. default value: NULL
• http-src <string> : Source directory default value: NULL
• http-index <boolean> : Allow to build directory index default value: disabled

Lua Telnet

Module: luatelnet
Type	Interface
First VLC version	-
Last VLC version	-
Operating system(s)	all
Description	Lua Telnet
Shortcut(s)	luatelnet, telnet

• telnet-host <string> : This is the host on which the interface will listen. It defaults to all network interfaces (0.0.0.0). If you want this interface to be available only on the local machine, enter "127.0.0.1". default value: "localhost"
• telnet-port <integer [1 .. 65535]> : This is the TCP port on which this interface will listen. It defaults to 4212. default value: 4212
• telnet-password <password> : A single password restricts access to this interface. default value: NULL

Lua SD Module

Module: luasd
Type	Services discovery
First VLC version	-
Last VLC version	-
Operating system(s)	all
Description	Lua SD Module
Shortcut(s)	luasd

• lua-sd <string> : default value: ""

Other submodules

Name	Description	Capability	Shortcut
Lua Meta Fetcher	Fetch meta data using lua scripts	meta fetcher	(none)
Lua Meta Reader	Read meta data using lua scripts	meta reader	(none)
Lua Playlist	Lua Playlist Parser Interface	stream_filter	luaplaylist
Lua Art	Fetch artwork using lua scripts	art finder	(none)
Lua Extension	Lua Extension	extension	luaextension

Source code

• modules/lua/vlc.c
• modules/lua

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.