diff options
Diffstat (limited to 'DOCS/man/input.rst')
| -rw-r--r-- | DOCS/man/input.rst | 78 |
1 files changed, 36 insertions, 42 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index d58f2dc4d5..9c4df6152b 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -459,6 +459,8 @@ Input Commands that are Possibly Subject to Change Remove all filters. Note that like the other sub-commands, this does not control automatically inserted filters. + The argument is always needed. E.g. in case of ``clr`` use ``vf clr ""``. + You can assign labels to filter by prefixing them with ``@name:`` (where ``name`` is a user-chosen arbitrary identifier). Labels can be used to refer to filters by name in all of the filter chain modification commands. @@ -561,29 +563,20 @@ Input Commands that are Possibly Subject to Change the resolution is reduced to that of the video's. You can read the ``osd-width`` and ``osd-height`` properties. At least with ``--vo-xv`` and anamorphic video (such as DVD), ``osd-par`` should be read as well, and the - overlay should be aspect-compensated. (Future directions: maybe mpv should - take care of some of these things automatically, but it's hard to tell - where to draw the line.) + overlay should be aspect-compensated. ``id`` is an integer between 0 and 63 identifying the overlay element. The ID can be used to add multiple overlay parts, update a part by using this command with an already existing ID, or to remove a part with ``overlay-remove``. Using a previously unused ID will add a new overlay, - while reusing an ID will update it. (Future directions: there should be - something to ensure different programs wanting to create overlays don't - conflict with each others, should that ever be needed.) + while reusing an ID will update it. ``x`` and ``y`` specify the position where the OSD should be displayed. ``file`` specifies the file the raw image data is read from. It can be either a numeric UNIX file descriptor prefixed with ``@`` (e.g. ``@4``), - or a filename. The file will be mapped into memory with ``mmap()``. Some VOs - will pass the mapped pointer directly to display APIs (e.g. opengl or - vdpau), so no actual copying is involved. Truncating the source file while - the overlay is active will crash the player. You shouldn't change the data - while the overlay is active, because the data is essentially accessed at - random points. Instead, call ``overlay-add`` again (preferably with a - different memory region to prevent tearing). + or a filename. The file will be mapped into memory with ``mmap()``, + copied, and unmapped before the command returns (changed in mpv 0.18.1). It is also possible to pass a raw memory address for use as bitmap memory by passing a memory address as integer prefixed with an ``&`` character. @@ -616,15 +609,14 @@ Input Commands that are Possibly Subject to Change (Technically, the minimum size would be ``stride * (h - 1) + w * 4``, but for simplicity, the player will access all ``stride * h`` bytes.) - .. admonition:: Warning + .. note:: - When updating the overlay, you should prepare a second shared memory - region (e.g. make use of the offset parameter) and add this as overlay, - instead of reusing the same memory every time. Otherwise, you might - get the equivalent of tearing, when your application and mpv write/read - the buffer at the same time. Also, keep in mind that mpv might access - an overlay's memory at random times whenever it feels the need to do - so, for example when redrawing the screen. + Before mpv 0.18.1, you had to do manual "double buffering" when updating + an overlay by replacing it with a different memory buffer. Since mpv + 0.18.1, the memory is simply copied and doesn't reference any of the + memory indicated by the command's arguments after the commend returns. + If you want to use this command before mpv 0.18.1, reads the old docs + to see how to handle this correctly. ``overlay-remove <id>`` Remove an overlay added with ``overlay-add`` and the same ID. Does nothing @@ -1242,29 +1234,31 @@ Property list See ``--hr-seek``. ``mixer-active`` - Return ``yes`` if the audio mixer is active, ``no`` otherwise. This has - implications for ``--softvol=no`` mode: if the mixer is inactive, changing - ``volume`` doesn't actually change anything on the system mixer. If the - ``--volume`` or ``--mute`` option are used, these might not be applied - properly until the mixer becomes active either. (The options, if set, will - just overwrite the mixer state at audio initialization.) - - While the behavior with ``mixer-active==yes`` is relatively well-defined, - the ``no`` case will provide possibly wrong or insignificant values. + Return ``yes`` if the audio mixer is active, ``no`` otherwise. - Note that an active mixer does not necessarily imply active audio output, - although this is implied in the current implementation. + This option is relatively useless. Before mpv 0.18.1, it could be used to + infer behavior of the ``volume`` property. ``volume`` (RW) - Current volume (see ``--volume`` for details). Also see ``mixer-active`` - property. + Current volume (see ``--volume`` for details). -``volume-max`` - Current maximum value the volume property can be set to. (This may depend - on the ``--softvol-max`` option.) +``volume-max`` (RW) + Current maximum value the volume property can be set to. (Equivalent to the + ``--volume-max`` option.) ``mute`` (RW) - Current mute status (``yes``/``no``). Also see ``mixer-active`` property. + Current mute status (``yes``/``no``). + +``ao-volume`` (RW) + System volume. This property is available only if mpv audio output is + currently active, and only if the underlying implementation supports volume + control. What this option does depends on the API. For example, on ALSA + this usually changes system-wide audio, while with PulseAudio this controls + per-application volume. + +``ao-mute`` (RW) + Similar to ``ao-volume``, but controls the mute state. May be unimplemented + even if ``ao-volume`` works. ``audio-delay`` (RW) See ``--audio-delay``. @@ -1388,7 +1382,7 @@ Property list properties to see whether this was successful. Unlike in mpv 0.9.x and before, this does not return the currently active - hardware decoder. Since mpv 0.17.1, ``hwdec-current`` is available for + hardware decoder. Since mpv 0.18.0, ``hwdec-current`` is available for this purpose. ``hwdec-current`` @@ -1412,13 +1406,13 @@ Property list platform and VO. ``hwdec-active`` - Deprecated. To be removed in mpv 0.19.0. Use ``hwdec-current`` instead. + Deprecated. To be removed in mpv 0.20.0. Use ``hwdec-current`` instead. Return ``yes`` or ``no``, depending on whether any type of hardware decoding is actually in use. ``hwdec-detected`` - Deprecated. To be removed in mpv 0.19.0. + Deprecated. To be removed in mpv 0.20.0. If hardware decoding is active, this returns the hardware decoder in use. Otherwise, it returns either ``no``, or if applicable, the currently loaded @@ -2134,7 +2128,7 @@ Property list (Note that if an option is marked as file-local, even ``options/`` will access the local value, and the ``old`` value, which will be restored on - end of playback, can not be read or written until end of playback.) + end of playback, cannot be read or written until end of playback.) ``option-info/<name>`` Additional per-option information. |