Add initial Lua scripting support
This is preliminary. There are still tons of issues, and any aspect
of scripting may change in the future. I decided to merge this
(preliminary) work now because it makes it easier to develop it, not
because it's done. lua.rst is clear enough about it (plus some
sarcasm).
This requires linking to Lua. Lua has no official pkg-config file, but
there are distribution specific .pc files, all with different names.
Adding a non-pkg-config based configure test was considered, but we'd
rather not.
One major complication is that libquvi links against Lua too, and if
the Lua version is different from mpv's, you will get a crash as soon
as libquvi uses Lua. (libquvi by design always runs when a file is
opened.) I would consider this the problem of distros and whoever
builds mpv, but to make things easier for users, we add a terrible
runtime test to the configure script, which probes whether libquvi
will crash. This is disabled when cross-compiling, but in that case
we hope the user knows what he is doing.
2013-09-25 22:41:14 +00:00
|
|
|
LUA SCRIPTING
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
mpv can load Lua scripts. These scripts can be used to control mpv in a similar
|
|
|
|
|
way to slave mode. mpv provides the builtin module ``mp`` (can be loaded
|
2014-01-05 18:28:45 +00:00
|
|
|
with ``require 'mp'``), which provides functions to send commands to the
|
Add initial Lua scripting support
This is preliminary. There are still tons of issues, and any aspect
of scripting may change in the future. I decided to merge this
(preliminary) work now because it makes it easier to develop it, not
because it's done. lua.rst is clear enough about it (plus some
sarcasm).
This requires linking to Lua. Lua has no official pkg-config file, but
there are distribution specific .pc files, all with different names.
Adding a non-pkg-config based configure test was considered, but we'd
rather not.
One major complication is that libquvi links against Lua too, and if
the Lua version is different from mpv's, you will get a crash as soon
as libquvi uses Lua. (libquvi by design always runs when a file is
opened.) I would consider this the problem of distros and whoever
builds mpv, but to make things easier for users, we add a terrible
runtime test to the configure script, which probes whether libquvi
will crash. This is disabled when cross-compiling, but in that case
we hope the user knows what he is doing.
2013-09-25 22:41:14 +00:00
|
|
|
mpv core and to retrieve information about playback state, user settings,
|
|
|
|
|
file information, and so on.
|
|
|
|
|
|
|
|
|
|
.. admonition:: Warning
|
|
|
|
|
|
|
|
|
|
Lua scripting is work in progress, and it's in a very early stage. When
|
|
|
|
|
writing scripts, rely only on the features and functions documented here.
|
|
|
|
|
Everything else is subject to change.
|
|
|
|
|
|
|
|
|
|
.. admonition:: Warning
|
|
|
|
|
|
|
|
|
|
Nothing is finished and documented yet.
|