diff options
Diffstat (limited to 'DOCS/man/osc.rst')
| -rw-r--r-- | DOCS/man/osc.rst | 195 |
1 files changed, 166 insertions, 29 deletions
diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst index 8cddaa268c..97b4f4818e 100644 --- a/DOCS/man/osc.rst +++ b/DOCS/man/osc.rst @@ -43,7 +43,8 @@ pl next ============= ================================================ title - | Displays current media-title, filename, or custom title + | Displays current media-title, filename, custom title, or target chapter + name while hovering the seekbar. ============= ================================================ left-click show playlist position and length and full title @@ -84,6 +85,7 @@ seekbar ============= ================================================ left-click seek to position + mouse wheel seek forward/backward ============= ================================================ time left @@ -100,6 +102,7 @@ audio and sub left-click cycle audio/sub tracks forward right-click cycle audio/sub tracks backwards shift+L-click show available audio/sub tracks + mouse wheel cycle audio/sub tracks forward/backwards ============= ================================================ vol @@ -127,22 +130,9 @@ 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-line -will 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 no -spaces around the ``=`` or anywhere else. +This script can be customized through a config file ``script-opts/osc.conf`` +placed in mpv's user directory and through the ``--script-opts`` command-line +option. The configuration syntax is described in `mp.options functions`_. Command-line Syntax ~~~~~~~~~~~~~~~~~~~ @@ -167,18 +157,53 @@ Configurable Options ``seekbarstyle`` Default: bar - Sets the style of the seekbar, slider (diamond marker), knob (circle - marker with guide), or bar (fill). - Default pre-0.21.0 was 'slider'. + 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 ``diamond`` + 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. + Controls the mode used to seek when dragging the seekbar. If set to ``yes``, + default seeking mode is used (usually keyframes, but player defaults and + heuristics can change it to exact). If set to ``no``, 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). + +``scrollcontrols`` + Default: yes + + By default, going up or down with the mouse wheel can trigger certain + actions (such as seeking) if the mouse is hovering an OSC element. + Set to ``no`` to disable any special mouse wheel behavior. ``deadzonesize`` Default: 0.5 @@ -207,6 +232,11 @@ Configurable Options Enable the OSC when fullscreen +``idlescreen`` + Default: yes + + Show the mpv logo and message when idle + ``scalewindowed`` Default: 1.0 @@ -264,7 +294,7 @@ Configurable Options String that supports property expansion that will be displayed as OSC title. - ASS tags are escaped, and newlines and trailing slashes are stripped. + ASS tags are escaped and newlines are converted to spaces. ``tooltipborder`` Default: 1 @@ -276,15 +306,25 @@ Configurable Options Show total time instead of time remaining +``remaining_playtime`` + Default: yes + + Whether the time-remaining display takes speed into account. + ``yes`` - how much playback time remains at the current speed. + ``no`` - how much video-time remains. + ``timems`` Default: no Display timecodes with milliseconds -``seekranges`` - Default: yes +``tcspace`` + Default: 100 (allowed: 50-200) - Display seekable ranges on the seekbar + Adjust space reserved for timecodes (current time and time remaining) in + the ``bottombar`` and ``topbar`` layouts. The timecode width depends on the + font, and with some fonts the spacing near the timecodes becomes too small. + Use values above 100 to increase that spacing, or below 100 to decrease it. ``visibility`` Default: auto (auto hide/show on mouse move) @@ -299,6 +339,99 @@ Configurable Options 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.) Additionally, ``visibility`` must be set to ``always``. + Otherwise, this option does nothing. + + 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. + +``windowcontrols_title`` + Default: ${media-title} + + String that supports property expansion that will be displayed as the + windowcontrols title. + ASS tags are escaped, and newlines and trailing slashes are stripped. + +``greenandgrumpy`` + Default: no + + Set to ``yes`` to reduce festivity (i.e. disable santa hat in December.) + +``livemarkers`` + Default: yes + + Update chapter markers positions on duration changes, e.g. live streams. + The updates are unoptimized - consider disabling it on very low-end systems. + +``chapters_osd``, ``playlist_osd`` + Default: yes + + Whether to display the chapters/playlist at the OSD when left-clicking the + next/previous OSC buttons, respectively. + +``playlist_media_title`` + Default: yes + + Whether to display playlist entries in media titles. If set to ``no``, file + names are used instead. Note that media title of a file is only available + once it has been loaded. + +``chapter_fmt`` + Default: ``Chapter: %s`` + + Template for the chapter-name display when hovering the seekbar. + Use ``no`` to disable chapter display on hover. Otherwise it's a lua + ``string.format`` template and ``%s`` is replaced with the actual name. + +``unicodeminus`` + Default: no + + Use a Unicode minus sign instead of an ASCII hyphen when displaying + the remaining playback time. + + Script Commands ~~~~~~~~~~~~~~~ @@ -321,6 +454,10 @@ to set auto mode (the default) with ``b``:: a script-message osc-visibility never b script-message osc-visibility auto +``osc-idlescreen`` + Controls the visibility of the mpv logo on idle. Valid arguments are ``yes``, + ``no``, and ``cycle`` to toggle between yes and no. + ``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. |