View source for Documentation:Modules/lua

{{Module|name=lua|type=Interface|description=[[wikipedia:Lua (programming language)|Lua]] interpreter|sc=luaintf}}

== Options ==
{{Option
|name=lua-intf
|value=string
|default="dummy"
|description=[[wikipedia:Lua (programming language)|Lua]] interface module to load
}}
{{Option
|name=lua-config
|value=string
|default=""
|description=Lua interface configuration string. Format is: <code><nowiki>'["<interface module name>"] = { <option> = <value>, ...}, ...'</nowiki></code>.
}}
{{Clear}}

== Lua HTTP ==
{{Module|name=luahttp|type=Interface|description=Lua [[HTTP]]|sc=luahttp|sc2=http}}
{{Option
|name=http-password
|value=password
|default=NULL
|description=A single password restricts access to this interface.
}}
{{Option
|name=http-src
|value=string
|default=NULL
|description=Source directory
}}
{{Option
|name=http-index
|value=boolean
|default=disabled
|description=Allow to build directory index
}}
{{Clear}}

== Lua Telnet ==
{{Module|name=luatelnet|type=Interface|description=Lua [[Telnet]]|sc=luatelnet|sc2=telnet}}
{{Option
|name=telnet-host
|value=string
|default="localhost"
|description=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 "[[wikipedia:localhost|127.0.0.1]]".
}}
{{Option
|name=telnet-port
|value=integer
|min=1
|max=65535
|default=4212
|description=This is the [[TCP]] [[port]] on which this interface will listen. It defaults to 4212.
}}
{{Option
|name=telnet-password
|value=password
|default=NULL
|description=A single password restricts access to this interface.
}}
{{Clear}}

== Lua SD Module ==
{{Module|name=luasd|type=Services discovery|description=Lua SD Module|sc=luasd}}
{{Option
|name=lua-sd
|value=string
|default=""
|description=
}}
{{Clear}}

== Other submodules ==
{| class="mw-datatable sortable"
! scope="col" | Name !! scope="col" | Description !! scope="col" | Capability !! scope="col" | 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 ==
* {{VLCSourceFile|modules/lua/vlc.c}}
* {{VLCSourceFolder|modules/lua}}

== See also ==
* [[Documentation:Building Lua Playlist Scripts]]
* [[Interfaces]]
* {{docmod|ncurses}}

{{Documentation}}