Skip to content

mpv_control

MpvControllable(play_callback=None, **mpv_args)

Bases: PlayerBase

This player can be controlled and it also does not close if the media is changed, the window stays open until kill_player is called. You need libmpv for this, check the python-mpv project's requirements to know where to get it.

For detailed documentation about the functions have a look at the base class.

If you want to use the extra features of the controllable player look here for documentation (or use your LSP), the python-mpv mpv instance lives in the mpv attribute.

Attributes:

Name Type Description
mpv

The python-mpv mpv instance

Parameters:

Name Type Description Default
play_callback Optional[PlayCallback]

Callback called upon starting to play a title with play_title

 None
**mpv_args Optional[Any]

Arguments passed to the MPV instance check the python-mpv repo or check the official list of arguments. There are some default arguments set, if you specify any arguments here, all the defaults will be discarded and this will be used instead.

 {}
Source code in api/src/anipy_api/player/players/mpv_control.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(
    self, play_callback: Optional[PlayCallback] = None, **mpv_args: Optional[Any]
):
    """__init__ of MpvControllable

    Args:
        play_callback: Callback called upon starting to play a title with `play_title`
        **mpv_args: Arguments passed to the MPV instance check the [python-mpv repo](https://github.com/jaseg/python-mpv?tab=readme-ov-file#usage)
            or check the [official list of arguments](https://mpv.io/manual/master/#properties). There are some default arguments set, if you specify
            any arguments here, all the defaults will be discarded and this will be used instead.
    """
    super().__init__(play_callback=play_callback)

    # I know this is a crime, but pytohn-mpv loads the so/dll on import and this will break all the stuff for people that do not have that.
    from mpv import MPV

    if len(mpv_args) <= 1:
        mpv_args = {
            "input_default_bindings": True,
            "input_vo_keyboard": True,
            "force_window": "immediate",
            "title": "MPV - Receiving Links from anipy-cli",
            "osc": True,
        }

    self.mpv = MPV(**mpv_args)