Something went wrong. Try again.
🎥 Command line media player
Something went wrong. Try again.
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980EMBEDDING INTO OTHER PROGRAMS (LIBMPV)======================================
mpv can be embedded into other programs as video/audio playback backend. Therecommended way to do so is using libmpv. See ``libmpv/client.h`` in the mpvsource code repository. This provides a C API. Bindings for other languagesmight be available (see wiki).
Since libmpv merely allows access to underlying mechanisms that can controlmpv, further documentation is spread over a few places:
- https://github.com/mpv-player/mpv/blob/master/libmpv/client.h- https://mpv.io/manual/master/#options- https://mpv.io/manual/master/#list-of-input-commands- https://mpv.io/manual/master/#properties- https://github.com/mpv-player/mpv-examples/tree/master/libmpv
C PLUGINS=========
You can write C plugins for mpv. These use the libmpv API, although they do notuse the libmpv library itself.
They are enabled by default if compiler supports linking with the ``-rdynamic``flag on Linux/BSD platforms. On Windows the are always enabled.
C plugins location------------------
C plugins are put into the mpv scripts directory in its config directory(see the `FILES`_ section for details). They must have a ``.so`` or ``.dll``file extension. They can also be explicitly loaded with the ``--script`` option.
API---
A C plugin must export the following function::
int mpv_open_cplugin(mpv_handle *handle)
The plugin function will be called on loading time. This function does notreturn as long as your plugin is loaded (it runs in its own thread). The``handle`` will be deallocated as soon as the plugin function returns.
The return value is interpreted as error status. A value of ``0`` isinterpreted as success, while ``-1`` signals an error. In the latter case,the player prints an uninformative error message that loading failed.
Return values other than ``0`` and ``-1`` are reserved, and trigger undefinedbehavior.
Within the plugin function, you can call libmpv API functions. The ``handle``is created by ``mpv_create_client()`` (or actually an internal equivalent),and belongs to you. You can call ``mpv_wait_event()`` to wait for thingshappening, and so on.
Note that the player might block until your plugin calls ``mpv_wait_event()``for the first time. This gives you a chance to install initial hooks etc.before playback begins.
The details are quite similar to Lua scripts.
Linkage to libmpv-----------------
The current implementation requires that your plugins are **not** linked againstlibmpv. What your plugins use are not symbols from a libmpv binary, butsymbols from the mpv host binary.
On Windows to make symbols from the host binary available, you have to defineMPV_CPLUGIN_DYNAMIC_SYM when compiling cplugin. This will load symbolsdynamically, before calling ``mpv_open_cplugin()``.
Examples--------
See:
- https://github.com/mpv-player/mpv-examples/tree/master/cplugins