Something went wrong. Try again.
🎥 Command line media player
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402ON SCREEN CONTROLLER====================
The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv tooffer basic mouse-controllability. It is intended to make interaction easierfor new users and to enable precise and direct seeking.
The OSC is enabled by default if mpv was compiled with Lua support. It can bedisabled entirely using the ``--osc=no`` option.
Using the OSC-------------
By default, the OSC will show up whenever the mouse is moved inside theplayer window and will hide if the mouse is not moved outside the OSC for0.5 seconds or if the mouse leaves the window.
The Interface~~~~~~~~~~~~~
::
+---------+----------+------------------------------------------+----------+ | pl prev | pl next | title | cache | +------+--+---+------+---------+-----------+------+-------+-----+-----+----+ | play | skip | skip | time | seekbar | time | audio | sub | vol | fs | | | back | frwd | elapsed | | left | | | | | +------+------+------+---------+-----------+------+-------+-----+-----+----+
pl prev ============= ================================================ left-click play previous file in playlist right-click show playlist shift+L-click show playlist ============= ================================================
pl next ============= ================================================ left-click play next file in playlist right-click show playlist shift+L-click show playlist ============= ================================================
title | Displays current media-title, filename, or custom title
============= ================================================ left-click show playlist position and length and full title right-click show filename ============= ================================================
cache | Shows current cache fill status
play ============= ================================================ left-click toggle play/pause ============= ================================================
skip back ============= ================================================ left-click go to beginning of chapter / previous chapter right-click show chapters shift+L-click show chapters ============= ================================================
skip frwd ============= ================================================ left-click go to next chapter right-click show chapters shift+L-click show chapters ============= ================================================
time elapsed | Shows current playback position timestamp
============= ================================================ left-click toggle displaying timecodes with milliseconds ============= ================================================
seekbar | Indicates current playback position and position of chapters
============= ================================================ left-click seek to position ============= ================================================
time left | Shows remaining playback time timestamp
============= ================================================ left-click toggle between total and remaining time ============= ================================================
audio and sub | Displays selected track and amount of available tracks
============= ================================================ left-click cycle audio/sub tracks forward right-click cycle audio/sub tracks backwards shift+L-click show available audio/sub tracks ============= ================================================
vol ============= ================================================ left-click toggle mute mouse wheel volume up/down ============= ================================================
fs ============= ================================================ left-click toggle fullscreen ============= ================================================
Key Bindings~~~~~~~~~~~~
These key bindings are active by default if nothing else is already bound tothese keys. In case of collision, the function needs to be bound to adifferent key. See the `Script Commands`_ section.
============= ================================================del Cycles visibility between never / auto (mouse-move) / always============= ================================================
Configuration-------------
The OSC offers limited configuration through a config file``script-opts/osc.conf`` placed in mpv's user dir and through the``--script-opts`` command-line option. Options provided through the command-linewill override those from the config file.
Config Syntax~~~~~~~~~~~~~
The config file must exactly follow the following syntax::
# this is a comment optionA=value1 optionB=value2
``#`` can only be used at the beginning of a line and there may be nospaces around the ``=`` or anywhere else.
Command-line Syntax~~~~~~~~~~~~~~~~~~~
To avoid collisions with other scripts, all options need to be prefixed with``osc-``.
Example::
--script-opts=osc-optionA=value1,osc-optionB=value2
Configurable Options~~~~~~~~~~~~~~~~~~~~
``layout`` Default: bottombar
The layout for the OSC. Currently available are: box, slimbox, bottombar and topbar. Default pre-0.21.0 was 'box'.
``seekbarstyle`` Default: bar
Sets the style of the playback position marker and overall shape of the seekbar: ``bar``, ``diamond`` or ``knob``.
``seekbarhandlesize`` Default: 0.6
Size ratio of the seek handle if ``seekbarstyle`` is set to ``dimaond`` or ``knob``. This is relative to the full height of the seekbar.
``seekbarkeyframes`` Default: yes
Controls the mode used to seek when dragging the seekbar. By default, keyframes are used. If set to false, exact seeking on mouse drags will be used instead. Keyframes are preferred, but exact seeks may be useful in cases where keyframes cannot be found. Note that using exact seeks can potentially make mouse dragging much slower.
``seekrangestyle`` Default: inverted
Display seekable ranges on the seekbar. ``bar`` shows them on the full height of the bar, ``line`` as a thick line and ``inverted`` as a thin line that is inverted over playback position markers. ``none`` will hide them. Additionally, ``slider`` will show a permanent handle inside the seekbar with cached ranges marked inside. Note that these will look differently based on the seekbarstyle option. Also, ``slider`` does not work with ``seekbarstyle`` set to ``bar``.
``seekrangeseparate`` Default: yes
Controls whether to show line-style seekable ranges on top of the seekbar or separately if ``seekbarstyle`` is set to ``bar``.
``seekrangealpha`` Default: 200
Alpha of the seekable ranges, 0 (opaque) to 255 (fully transparent).
``deadzonesize`` Default: 0.5
Size of the deadzone. The deadzone is an area that makes the mouse act like leaving the window. Movement there won't make the OSC show up and it will hide immediately if the mouse enters it. The deadzone starts at the window border opposite to the OSC and the size controls how much of the window it will span. Values between 0.0 and 1.0, where 0 means the OSC will always popup with mouse movement in the window, and 1 means the OSC will only show up when the mouse hovers it. Default pre-0.21.0 was 0.
``minmousemove`` Default: 0
Minimum amount of pixels the mouse has to move between ticks to make the OSC show up. Default pre-0.21.0 was 3.
``showwindowed`` Default: yes
Enable the OSC when windowed
``showfullscreen`` Default: yes
Enable the OSC when fullscreen
``scalewindowed`` Default: 1.0
Scale factor of the OSC when windowed.
``scalefullscreen`` Default: 1.0
Scale factor of the OSC when fullscreen
``scaleforcedwindow`` Default: 2.0
Scale factor of the OSC when rendered on a forced (dummy) window
``vidscale`` Default: yes
Scale the OSC with the video ``no`` tries to keep the OSC size constant as much as the window size allows
``valign`` Default: 0.8
Vertical alignment, -1 (top) to 1 (bottom)
``halign`` Default: 0.0
Horizontal alignment, -1 (left) to 1 (right)
``barmargin`` Default: 0
Margin from bottom (bottombar) or top (topbar), in pixels
``boxalpha`` Default: 80
Alpha of the background box, 0 (opaque) to 255 (fully transparent)
``hidetimeout`` Default: 500
Duration in ms until the OSC hides if no mouse movement, must not be negative
``fadeduration`` Default: 200
Duration of fade out in ms, 0 = no fade
``title`` Default: ${media-title}
String that supports property expansion that will be displayed as OSC title. ASS tags are escaped, and newlines and trailing slashes are stripped.
``tooltipborder`` Default: 1
Size of the tooltip outline when using bottombar or topbar layouts
``timetotal`` Default: no
Show total time instead of time remaining
``timems`` Default: no
Display timecodes with milliseconds
``visibility`` Default: auto (auto hide/show on mouse move)
Also supports ``never`` and ``always``
``boxmaxchars`` Default: 80
Max chars for the osc title at the box layout. mpv does not measure the text width on screen and so it needs to limit it by number of chars. The default is conservative to allow wide fonts to be used without overflow. However, with many common fonts a bigger number can be used. YMMV.
``boxvideo`` Default: no
Whether to overlay the osc over the video (``no``), or to box the video within the areas not covered by the osc (``yes``). If this option is set, the osc may overwrite the ``--video-margin-ratio-*`` options, even if the user has set them. (It will not overwrite them if all of them are set to default values.)
Currently, this is supported for the ``bottombar`` and ``topbar`` layout only. The other layouts do not change if this option is set. Separately, if window controls are present (see below), they will be affected regardless of which osc layout is in use.
The border is static and appears even if the OSC is configured to appear only on mouse interaction. If the OSC is invisible, the border is simply filled with the background color (black by default).
This currently still makes the OSC overlap with subtitles (if the ``--sub-use-margins`` option is set to ``yes``, the default). This may be fixed later.
This does not work correctly with video outputs like ``--vo=xv``, which render OSD into the unscaled video.
``windowcontrols`` Default: auto (Show window controls if there is no window border)
Whether to show window management controls over the video, and if so, which side of the window to place them. This may be desirable when the window has no decorations, either because they have been explicitly disabled (``border=no``) or because the current platform doesn't support them (eg: gnome-shell with wayland).
The set of window controls is fixed, offering ``minimize``, ``maximize``, and ``quit``. Not all platforms implement ``minimize`` and ``maximize``, but ``quit`` will always work.
``windowcontrols_alignment`` Default: right
If window controls are shown, indicates which side should they be aligned to.
Supports ``left`` and ``right`` which will place the controls on those respective sides.
``greenandgrumpy`` Default: no
Set to ``yes`` to reduce festivity (i.e. disable santa hat in December.)
Script Commands~~~~~~~~~~~~~~~
The OSC script listens to certain script commands. These commands can boundin ``input.conf``, or sent by other scripts.
``osc-message`` Show a message on screen using the OSC. First argument is the message, second the duration in seconds.
``osc-visibility`` Controls visibility mode ``never`` / ``auto`` (on mouse move) / ``always`` and also ``cycle`` to cycle between the modes
Example
You could put this into ``input.conf`` to hide the OSC with the ``a`` key andto set auto mode (the default) with ``b``::
a script-message osc-visibility never b script-message osc-visibility auto
``osc-playlist``, ``osc-chapterlist``, ``osc-tracklist`` Shows a limited view of the respective type of list using the OSC. First argument is duration in seconds.