Commit 9e3b790f authored by François Cartegnie's avatar François Cartegnie 🤞

lua: add missing documentation for scopes

parent 9667e896
......@@ -160,6 +160,7 @@ nobase_doc_DATA = \
lua/extensions/README.txt \
lua/intf/README.txt \
lua/intf/dumpmeta.lua \
lua/meta/README.txt \
lua/meta/art/README.txt \
lua/meta/art/01_googleimage.lua \
lua/meta/fetcher/README.txt \
......@@ -198,6 +199,7 @@ EXTRA_DIST += \
lua/intf/modules/host.lua \
lua/intf/modules/httprequests.lua \
lua/intf/telnet.lua \
lua/meta/README.txt \
lua/meta/art/README.txt \
lua/meta/art/02_frenchtv.lua \
lua/meta/art/03_lastfm.lua \
......
## Generic instructions about VLC Lua meta scripts.
$Id$
There is 3 types of Lua meta modules: art, fetcher and reader.
See their own README.txt for documentation.
See lua/README.txt for generic documentation about Lua usage in VLC.
## API
VLC Lua meta modules should define a descriptor function:
* descriptor(): returns a table with information about the module.
This table has the following member:
.scope: Search scope of the script. Can be "network" or "local".
and defaults to "network".
"local" scripts are considered fast and processed first.
"network" scripts are considered slow and processed in a
second pass only if policy allows it.
Example:
function descriptor()
return { scope="network" }
end
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment