diff options
Diffstat (limited to 'DOCS/man/osc.rst')
| -rw-r--r-- | DOCS/man/osc.rst | 104 |
1 files changed, 86 insertions, 18 deletions
diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst index adcb52cbec..6431495958 100644 --- a/DOCS/man/osc.rst +++ b/DOCS/man/osc.rst @@ -85,6 +85,7 @@ seekbar ============= ================================================ left-click seek to position + mouse wheel seek forward/backward ============= ================================================ time left @@ -101,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 @@ -128,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 ~~~~~~~~~~~~~~~~~~~ @@ -174,7 +163,7 @@ Configurable Options ``seekbarhandlesize`` Default: 0.6 - Size ratio of the seek handle if ``seekbarstyle`` is set to ``dimaond`` + 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`` @@ -209,6 +198,13 @@ Configurable Options 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 @@ -298,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 @@ -310,6 +306,13 @@ 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 @@ -384,6 +387,13 @@ Configurable Options 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 @@ -401,6 +411,13 @@ Configurable Options 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`` @@ -414,6 +431,57 @@ Configurable Options Use a Unicode minus sign instead of an ASCII hyphen when displaying the remaining playback time. +``background_color`` + Default: #000000 + + Sets the background color of the OSC. + +``timecode_color`` + Default: #FFFFFF + + Sets the color of the timecode and seekbar, of the OSC. + +``title_color`` + Default: #FFFFFF + + Sets the color of the video title. Formatted as #RRGGBB. + +``time_pos_color`` + Default: #FFFFFF + + Sets the color of the timecode at hover position in the seekbar. + +``time_pos_outline_color`` + Default: #FFFFFF + + Sets the color of the timecode's outline at hover position in the seekbar. + Also affects the timecode in the slimbox layout. + +``buttons_color`` + Default: #FFFFFF + + Sets the colors of the big buttons. + +``top_buttons_color`` + Default: #FFFFFF + + Sets the colors of the top buttons. + +``small_buttonsL_color`` + Default: #FFFFFF + + Sets the colors of the small buttons on the left in the box layout. + +``small_buttonsR_color`` + Default: #FFFFFF + + Sets the colors of the small buttons on the right in the box layout. + +``held_element_color`` + Default: #999999 + + Sets the colors of the elements that are being pressed or held down. + Script Commands ~~~~~~~~~~~~~~~ |