summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorAvi Halachmi (:avih) <avihpit@yahoo.com>2016-02-09 14:07:00 +0200
committerChrisK2 <spam@kalania.de>2016-02-27 22:19:30 +0100
commitad2d10af1993591e8b175b10cb83f91fa13e8fe8 (patch)
treecbcb913445fc7364dd4831c2dc5a28b1d99e018e /DOCS/man
parent3ab6af4f59dd21e3c9c514a25be380f883d608fe (diff)
downloadmpv-ad2d10af1993591e8b175b10cb83f91fa13e8fe8.tar.bz2
mpv-ad2d10af1993591e8b175b10cb83f91fa13e8fe8.tar.xz
osc: add always-on mode and unify visibility mode (always/never/auto)
Adds always-on mode by internally utilizing hidetimeout as negative and forbidding the user to set negative values. This removes script-message to enable/disable the osc, and instead introduces a combined 'visibility' control with the values never/auto/always. It's available via script_opts and script_message as 'osc-visibility'. As message, it also supports a 'cycle' value. The del key is bound to cycling the visibility modes.
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/osc.rst25
1 files changed, 13 insertions, 12 deletions
diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst
index f4f8d66496..587b8104d2 100644
--- a/DOCS/man/osc.rst
+++ b/DOCS/man/osc.rst
@@ -130,7 +130,7 @@ these keys. In case of collision, the function needs to be bound to a
different key. See the `Script Commands`_ section.
============= ================================================
-del Hide the OSC permanently until mpv is restarted.
+del Cycles visibility between never / auto (mouse-move) / always
============= ================================================
Configuration
@@ -206,8 +206,8 @@ Configurable Options
``hidetimeout``
| Default: 500
- | Duration in ms until the OSC hides if no mouse movement, negative value
- disables auto-hide
+ | Duration in ms until the OSC hides if no mouse movement, must not be
+ negative
``fadeduration``
| Default: 200
@@ -243,28 +243,29 @@ Configurable Options
| Default: no
| Display timecodes with milliseconds
+``visibility``
+ | Default: auto (auto hide/show on mouse move)
+ | Also supports ``never`` and ``always``
+
Script Commands
~~~~~~~~~~~~~~~
The OSC script listens to certain script commands. These commands can bound
in ``input.conf``, or sent by other scripts.
-``enable-osc``
- Undoes ``disable-osc`` or the effect of the ``del`` key.
-
-``disable-osc``
- Hide the OSC permanently. This is also what the ``del`` key does.
-
``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 and
-to unhide it with ``b``::
+to set auto mode (the default) with ``b``::
- a script_message disable-osc
- b script_message enable-osc
+ a script_message osc-visibility never
+ b script_message osc-visibility auto