summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorMartin Herkt <lachs0r@srsfckn.biz>2016-10-19 19:09:00 +0200
committerMartin Herkt <lachs0r@srsfckn.biz>2016-10-19 19:09:00 +0200
commit5d74fa7dc0fa1617d1d11b69769423b1387ec785 (patch)
tree882752015b3500c91b8ab3a4d669696f23feb817 /DOCS/man
parentc226bc7616ab2ae9de6172660e9cf727f07dc374 (diff)
parenta2fa0d0b68ce200598122145254f56ae1adff91e (diff)
downloadmpv-5d74fa7dc0fa1617d1d11b69769423b1387ec785.tar.bz2
mpv-5d74fa7dc0fa1617d1d11b69769423b1387ec785.tar.xz
Merge branch 'master' into release/current
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/af.rst26
-rw-r--r--DOCS/man/ao.rst191
-rw-r--r--DOCS/man/changes.rst7
-rw-r--r--DOCS/man/input.rst325
-rw-r--r--DOCS/man/ipc.rst4
-rw-r--r--DOCS/man/libmpv.rst16
-rw-r--r--DOCS/man/lua.rst24
-rw-r--r--DOCS/man/mpv.rst72
-rw-r--r--DOCS/man/options.rst1365
-rw-r--r--DOCS/man/osc.rst114
-rw-r--r--DOCS/man/vo.rst1080
11 files changed, 1675 insertions, 1549 deletions
diff --git a/DOCS/man/af.rst b/DOCS/man/af.rst
index c52c422299..4c91b5a9b5 100644
--- a/DOCS/man/af.rst
+++ b/DOCS/man/af.rst
@@ -312,6 +312,13 @@ Available filters are:
``mpv '--af=format=channels=5.1' '--audio-channels=5.1'`` would always force
remixing audio to 5.1 and output it like this.
+ This filter supports the following ``af-command`` commands:
+
+ ``set-matrix``
+ Set the ``<matrix>`` argument dynamically. This can be used to change
+ the mixing matrix at runtime, without reinitializing the entire filter
+ chain.
+
``drc[=method:target]``
Applies dynamic range compression. This maximizes the volume by compressing
the audio signal's dynamic range. (Formerly called ``volnorm``.)
@@ -394,10 +401,6 @@ Available filters are:
``mpv --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg``
Would tweak the quality and performance parameters.
- ``mpv --af=format=float,scaletempo media.ogg``
- Would make scaletempo use float code. Maybe faster on some
- platforms.
-
``mpv --af=scaletempo=scale=1.2:speed=pitch audio.ogg``
Would play media at 1.2x normal speed, with audio at normal pitch.
Changing playback speed would change pitch, leaving audio tempo at
@@ -406,9 +409,13 @@ Available filters are:
``rubberband``
High quality pitch correction with librubberband. This can be used in place
of ``scaletempo``, and will be used to adjust audio pitch when playing
- at speed different from normal.
+ at speed different from normal. It can also be used to adjust audio pitch
+ without changing playback speed.
- This filter has a number of sub-options. You can list them with
+ ``<pitch-scale>``
+ Sets the pitch scaling factor. Frequencies are multiplied by this value.
+
+ This filter has a number of additional sub-options. You can list them with
``mpv --af=rubberband=help``. This will also show the default values
for each option. The options are not documented here, because they are
merely passed to librubberband. Look at the librubberband documentation
@@ -417,6 +424,13 @@ Available filters are:
(The mapping of the mpv rubberband filter sub-option names and values to
those of librubberband follows a simple pattern: ``"Option" + Name + Value``.)
+ This filter supports the following ``af-command`` commands:
+
+ ``set-pitch``
+ Set the ``<pitch-scale>`` argument dynamically. This can be used to
+ change the playback pitch at runtime. Note that speed is controlled
+ using the standard ``speed`` property, not ``af-command``.
+
``lavfi=graph``
Filter audio using FFmpeg's libavfilter.
diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst
index 8bddc98a42..0e45b1e96e 100644
--- a/DOCS/man/ao.rst
+++ b/DOCS/man/ao.rst
@@ -4,18 +4,17 @@ AUDIO OUTPUT DRIVERS
Audio output drivers are interfaces to different audio output facilities. The
syntax is:
-``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
+``--ao=<driver1,driver2,...[,]>``
Specify a priority list of audio output drivers to be used.
If the list has a trailing ',', mpv will fall back on drivers not contained
-in the list. Suboptions are optional and can mostly be omitted.
-
-You can also set defaults for each driver. The defaults are applied before the
-normal driver parameters.
+in the list.
``--ao-defaults=<driver1[:parameter1:parameter2:...],driver2,...>``
Set defaults for each driver.
+ Deprecated. No replacement.
+
.. note::
See ``--ao=help`` for a list of compiled-in audio output drivers. The
@@ -23,87 +22,19 @@ normal driver parameters.
where PulseAudio is used. On BSD systems, ``--ao=oss`` or ``--ao=sndio``
may work (the latter being experimental).
-.. admonition:: Examples
-
- - ``--ao=alsa,oss,`` Try the ALSA driver, then the OSS driver, then others.
- - ``--ao=alsa:resample=yes:device=[plughw:0,3]`` Lets ALSA resample and
- sets the device-name as first card, fourth device.
-
Available audio output drivers are:
``alsa`` (Linux only)
ALSA audio output driver
- ``device=<device>``
- Sets the device name. For ac3 output via S/PDIF, use an "iec958" or
- "spdif" device, unless you really know how to set it correctly.
- ``resample=yes``
- Enable ALSA resampling plugin. (This is disabled by default, because
- some drivers report incorrect audio delay in some cases.)
- ``mixer-device=<device>``
- Set the mixer device used with ``--no-softvol`` (default: ``default``).
- ``mixer-name=<name>``
- Set the name of the mixer element (default: ``Master``). This is for
- example ``PCM`` or ``Master``.
- ``mixer-index=<number>``
- Set the index of the mixer channel (default: 0). Consider the output of
- "``amixer scontrols``", then the index is the number that follows the
- name of the element.
- ``non-interleaved``
- Allow output of non-interleaved formats (if the audio decoder uses
- this format). Currently disabled by default, because some popular
- ALSA plugins are utterly broken with non-interleaved formats.
- ``ignore-chmap``
- Don't read or set the channel map of the ALSA device - only request the
- required number of channels, and then pass the audio as-is to it. This
- option most likely should not be used. It can be useful for debugging,
- or for static setups with a specially engineered ALSA configuration (in
- this case you should always force the same layout with ``--audio-channels``,
- or it will work only for files which use the layout implicit to your
- ALSA device).
-
- .. note::
-
- MPlayer and mplayer2 required you to replace any ',' with '.' and
- any ':' with '=' in the ALSA device name. mpv does not do this anymore.
- Instead, quote the device name:
-
- ``--ao=alsa:device=[plug:surround50]``
-
- Note that the ``[`` and ``]`` simply quote the device name. With some
- shells (like zsh), you have to quote the option string to prevent the
- shell from interpreting the brackets instead of passing them to mpv.
-
- Actually, you should use the ``--audio-device`` option, instead of
- setting the device directly.
+ See `ALSA audio output options`_ for options specific to this AO.
.. warning::
- Handling of multichannel/surround audio changed in mpv 0.8.0 from the
- behavior in MPlayer/mplayer2 and older versions of mpv.
-
- The old behavior is that the player always downmixed to stereo by
- default. The ``--audio-channels`` (or ``--channels`` before that) option
- had to be set to get multichannel audio. Then playing stereo would
- use the ``default`` device (which typically allows multiple programs
- to play audio at the same time via dmix), while playing anything with
- more channels would open one of the hardware devices, e.g. via the
- ``surround51`` alias (typically with exclusive access). Whether the
- player would use exclusive access or not would depend on the file
- being played.
-
- The new behavior since mpv 0.8.0 always enables multichannel audio,
- i.e. ``--audio-channels=auto`` is the default. However, since ALSA
- provides no good way to play multichannel audio in a non-exclusive
- way (without blocking other applications from using audio), the player
- is restricted to the capabilities of the ``default`` device by default,
- which means it supports only stereo and mono (at least with current
- typical ALSA configurations). But if a hardware device is selected,
- then multichannel audio will typically work.
-
- The short story is: if you want multichannel audio with ALSA, use
- ``--audio-device`` to select the device (use ``--audio-device=help``
- to get a list of all devices and their mpv name).
+ To get multichannel/surround audio, use ``--audio-channels=auto``. The
+ default for this option is ``auto-safe``, which makes this audio otuput
+ explicitly reject multichannel output, as there is no way to detect
+ whether a certain channel layout is actually supported.
You can also try `using the upmix plugin <http://git.io/vfuAy>`_.
This setup enables multichannel audio on the ``default`` device
@@ -113,31 +44,36 @@ Available audio output drivers are:
``oss``
OSS audio output driver
- ``<dsp-device>``
+ The following global options are supported by this audio output:
+
+ ``--oss-device``
Sets the audio output device (default: ``/dev/dsp``).
- ``<mixer-device>``
+ Deprecated, use ``--audio-device``.
+ ``--oss-mixer-device``
Sets the audio mixer device (default: ``/dev/mixer``).
- ``<mixer-channel>``
+ ``--oss-mixer-channel``
Sets the audio mixer channel (default: ``pcm``). Other valid values
include **vol, pcm, line**. For a complete list of options look for
``SOUND_DEVICE_NAMES`` in ``/usr/include/linux/soundcard.h``.
``jack``
- JACK (Jack Audio Connection Kit) audio output driver
+ JACK (Jack Audio Connection Kit) audio output driver.
- ``port=<name>``
+ The following global options are supported by this audio output:
+
+ ``--jack-port=<name>``
Connects to the ports with the given name (default: physical ports).
- ``name=<client>``
+ ``--jack-name=<client>``
Client name that is passed to JACK (default: ``mpv``). Useful
if you want to have certain connections established automatically.
- ``(no-)autostart``
+ ``--jack-autostart=<yes|no>``
Automatically start jackd if necessary (default: disabled). Note that
this tends to be unreliable and will flood stdout with server messages.
- ``(no-)connect``
+ ``--jack-connect=<yes|no>``
Automatically create connections to output ports (default: enabled).
When enabled, the maximum number of output channels will be limited to
the number of available output ports.
- ``std-channel-layout=waveext|any``
+ ``--jack-std-channel-layout=<waveext|any>``
Select the standard channel layout (default: waveext). JACK itself has no
notion of channel layouts (i.e. assigning which speaker a given
channel is supposed to map to) - it just takes whatever the application
@@ -157,7 +93,9 @@ Available audio output drivers are:
Automatically redirects to ``coreaudio_exclusive`` when playing compressed
formats.
- ``change-physical-format=<yes|no>``
+ The following global options are supported by this audio output:
+
+ ``--coreaudio-change-physical-format=<yes|no>``
Change the physical format to one similar to the requested audio format
(default: no). This has the advantage that multichannel audio output
will actually work. The disadvantage is that it will change the
@@ -165,11 +103,13 @@ Available audio output drivers are:
setting in the ``Audio Devices`` dialog in the ``Audio MIDI Setup``
utility. Note that this does not affect the selected speaker setup.
- ``exclusive``
+ ``--coreaudio-exclusive``
+ Deprecated, use ``--audio-exclusive``.
Use exclusive mode access. This merely redirects to
``coreaudio_exclusive``, but should be preferred over using that AO
directly.
+
``coreaudio_exclusive`` (Mac OS X only)
Native Mac OS X audio output driver using direct device access and
exclusive mode (bypasses the sound server).
@@ -183,18 +123,21 @@ Available audio output drivers are:
``pulse``
PulseAudio audio output driver
- ``[<host>][:<output sink>]``
+ The following global options are supported by this audio output:
+
+ ``--pulse-host=<host>``, ``--pulse-sink=<sink>``
Specify the host and optionally output sink to use. An empty <host>
string uses a local connection, "localhost" uses network transfer
(most likely not what you want).
+ Deprecated, use ``--audio-device``.
- ``buffer=<1-2000|native>``
+ ``--pulse-buffer=<1-2000|native>``
Set the audio buffer size in milliseconds. A higher value buffers
more data, and has a lower probability of buffer underruns. A smaller
value makes the audio stream react faster, e.g. to playback speed
changes. Default: 250.
- ``latency-hacks=<yes|no>``
+ ``--pulse-latency-hacks=<yes|no>``
Enable hacks to workaround PulseAudio timing bugs (default: no). If
enabled, mpv will do elaborate latency calculations on its own. If
disabled, it will use PulseAudio automatically updated timing
@@ -214,61 +157,67 @@ Available audio output drivers are:
environments, such as systems where none of the other drivers
are available.
- ``buflen=<length>``
+ The following global options are supported by this audio output:
+
+ ``--sdl-buflen=<length>``
Sets the audio buffer length in seconds. Is used only as a hint by the
sound system. Playing a file with ``-v`` will show the requested and
obtained exact buffer size. A value of 0 selects the sound system
default.
- ``bufcnt=<count>``
+ ``--sdl-bufcnt=<count>``
Sets the number of extra audio buffers in mpv. Usually needs not be
changed.
``null``
- Produces no audio output but maintains video playback speed. Use
- ``--ao=null:untimed`` for benchmarking.
+ Produces no audio output but maintains video playback speed. You can use
+ ``--ao=null --ao-null-untimed`` for benchmarking.
+
+ The following global options are supported by this audio output:
- ``untimed``
+ ``--ao-null-untimed``
Do not simulate timing of a perfect audio device. This means audio
decoding will go as fast as possible, instead of timing it to the
system clock.
- ``buffer``
+ ``--ao-null-buffer``
Simulated buffer length in seconds.
- ``outburst``
+ ``--ao-null-outburst``
Simulated chunk size in samples.
- ``speed``
+ ``--ao-null-speed``
Simulated audio playback speed as a multiplier. Usually, a real audio
device will not go exactly as fast as the system clock. It will deviate
just a little, and this option helps to simulate this.
- ``latency``
+ ``--ao-null-latency``
Simulated device latency. This is additional to EOF.
- ``broken-eof``
+ ``--ao-null-broken-eof``
Simulate broken audio drivers, which always add the fixed device
latency to the reported audio playback position.
- ``broken-delay``
+ ``--ao-null-broken-delay``
Simulate broken audio drivers, which don't report latency correctly.
- ``channel-layouts``
+ ``--ao-null-channel-layouts``
If not empty, this is a ``,`` separated list of channel layouts the
AO allows. This can be used to test channel layout selection.
``pcm``
Raw PCM/WAVE file writer audio output
- ``(no-)waveheader``
+ The following global options are supported by this audio output:
+
+ ``--ao-pcm-waveheader=<yes|no>``
Include or do not include the WAVE header (default: included). When
not included, raw PCM will be generated.
- ``file=<filename>``
+ ``--ao-pcm-file=<filename>``
Write the sound to ``<filename>`` instead of the default
``audiodump.wav``. If ``no-waveheader`` is specified, the default is
``audiodump.pcm``.
- ``(no-)append``
+ ``--ao-pcm-append=<yes|no>``
Append to the file, instead of overwriting it. Always use this with the
``no-waveheader`` option - with ``waveheader`` it's broken, because
it will write a WAVE header every time the file is opened.
@@ -280,14 +229,19 @@ Available audio output drivers are:
confused with RoarAudio, which is something completely
different.
- ``host=<name/path>``
+ The following global options are supported by this audio output:
+
+ ``--rsound-host=<name/path>``
Set the address of the server (default: localhost). Can be either a
network hostname for TCP connections or a Unix domain socket path
starting with '/'.
- ``port=<number>``
+ ``--rsound-port=<number>``
Set the TCP port used for connecting to the server (default: 12345).
Not used if connecting to a Unix domain socket.
+ These options are deprecated. If anyone cares enough, their functionality
+ can be added back using ``--audio-device``.
+
``sndio``
Audio output to the OpenBSD sndio sound system
@@ -296,16 +250,24 @@ Available audio output drivers are:
(Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel
layouts.)
- ``device=<device>``
+ The following global options are supported by this audio output:
+
+ ``--ao-sndio-device=<device>``
sndio device to use (default: ``$AUDIODEVICE``, resp. ``snd0``).
+ Deprecated, use ``--audio-device``.
``wasapi``
Audio output to the Windows Audio Session API.
- ``exclusive``
+ The following global options are supported by this audio output:
+
+ ``--ao-wasapi-exclusive``
+ Deprecated, use ``--audio-exclusive``.
Requests exclusive, direct hardware access. By definition prevents
sound playback of any other program until mpv exits.
- ``device=<id>``
+ ``--ao-wasapi-device=<id>``
+ Deprecated, use ``--audio-device``.
+
Uses the requested endpoint instead of the system's default audio
endpoint. Both an ordinal number (0,1,2,...) and the GUID
String are valid; the GUID string is guaranteed to not change
@@ -313,8 +275,3 @@ Available audio output drivers are:
Also supports searching active devices by human-readable name. If more
than one device matches the name, refuses loading it.
-
- This option is mostly deprecated in favour of the more general
- ``--audio-device`` option. That said, ``--audio-device=help`` will give
- a list of valid device GUIDs (prefixed with ``wasapi/``), as well as
- their human readable names, which should work here.
diff --git a/DOCS/man/changes.rst b/DOCS/man/changes.rst
index 92ec3444af..d1daa32bd7 100644
--- a/DOCS/man/changes.rst
+++ b/DOCS/man/changes.rst
@@ -8,6 +8,11 @@ There is no real changelog, but you can look at the following things:
https://github.com/mpv-player/mpv/releases
* The git log, which is the "real" changelog
+* The files ``client-api-changes.rst`` and ``interface-changes.rst`` in the
+ ``DOCS`` sub directoryon the git repository, which document API and user
+ interface changes (the latter usually documents breaking changes only, rather
+ than additions).
* The file ``mplayer-changes.rst`` in the ``DOCS`` sub directory on the git
repository, which used to be in place of this section. It documents some
- changes that happened since mplayer2 forked off MPlayer.
+ changes that happened since mplayer2 forked off MPlayer. (Not updated
+ anymore.)
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 8cdba41a3d..d15aa41903 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -95,7 +95,7 @@ List of Input Commands
relative (default)
Seek relative to current position (a negative value seeks backwards).
absolute
- Seek to a given time.
+ Seek to a given time (a negative value starts from the end of the file).
absolute-percent
Seek to a given percent position.
relative-percent
@@ -665,13 +665,6 @@ Input Commands that are Possibly Subject to Change
(the ``ab-loop-a`` property); the second the ``B`` point, and the third
will clear both points.
-``vo-cmdline "<args>"``
- Reset the sub-option of the current VO. Currently works with ``opengl``
- (including ``opengl-hq``). The argument is the sub-option string usually
- passed to the VO on the command line. Not all sub-options can be set, but
- those which can will be reset even if they don't appear in the argument.
- This command might be changed or removed in the future.
-
``drop-buffers``
Drop audio/video/demuxer buffers, and restart from fresh. Might help with
unseekable streams that are going out of sync.
@@ -698,6 +691,17 @@ Input Commands that are Possibly Subject to Change
``af-command "<label>" "<cmd>" "<args>"``
Same as ``vf-command``, but for audio filters.
+``apply-profile "<name>"``
+ Apply the contents of a named profile. This is like using ``profile=name``
+ in a config file, except you can map it to a key binding to change it at
+ runtime.
+
+ There is no such thing as "unapplying" a profile - applying a profile
+ merely sets all option values listed within the profile.
+
+``load-script "<path>"``
+ Load a script, similar to the ``--script`` option.
+
Undocumented commands: ``tv-last-channel`` (TV/DVB only),
``ao-reload`` (experimental/internal).
@@ -838,20 +842,12 @@ an option at runtime.
Property list
-------------
-``osd-level`` (RW)
- See ``--osd-level``.
+.. note::
-``osd-scale`` (RW)
- OSD font size multiplier, see ``--osd-scale``.
-
-``loop`` (RW)
- See ``--loop``.
-
-``loop-file`` (RW)
- See ``--loop-file`` (uses ``yes``/``no``).
-
-``speed`` (RW)
- See ``--speed``.
+ Most options can be set as runtime via properties as well. Just remove the
+ leading ``--`` from the option name. These are not documented. Only
+ properties which do not exist as option with the same name, or which have
+ very different behavior from the options are documented below.
``audio-speed-correction``, ``video-speed-correction``
Factor multiplied with ``speed`` at which the player attempts to play the
@@ -911,9 +907,11 @@ Property list
list of format names, e.g. mp4 is ``mov,mp4,m4a,3gp,3g2,mj2`` (the list
may grow in the future for any format).
-``demuxer``
+``current-demuxer``
Name of the current demuxer. (This is useless.)
+ (Renamed from ``demuxer``.)
+
``stream-path``
Filename (full path) of the stream layer filename. (This is probably
useless. It looks like this can be different from ``path`` only when
@@ -989,6 +987,12 @@ Property list
Remaining length of the file in seconds. Note that the file duration is not
always exactly known, so this is an estimate.
+``audio-pts`` (R)
+ Current audio playback position in current file in seconds. Unlike time-pos,
+ this updates more often than once per frame. For audio-only files, it is
+ mostly equivalent to time-pos, while for video-only files this property is
+ not available.
+
``playtime-remaining``
``time-remaining`` scaled by the current ``speed``.
@@ -1078,10 +1082,6 @@ Property list
"title" MPV_FORMAT_STRING
"default" MPV_FORMAT_FLAG
-``ab-loop-a``, ``ab-loop-b`` (RW)
- Set/get A-B loop points. See corresponding options and ``ab-loop`` command
- for details.
-
``angle`` (RW)
Current DVD angle.
@@ -1154,13 +1154,12 @@ Property list
``af-metadata/<filter-label>``
Equivalent to ``vf-metadata/<filter-label>``, but for audio filters.
-``pause`` (RW)
- Pause status. This is usually ``yes`` or ``no``. See ``--pause``.
-
-``idle``
+``idle-active``
Return ``yes`` if no file is loaded, but the player is staying around
because of the ``--idle`` option.
+ (Renamed from ``idle``.)
+
``core-idle``
Return ``yes`` if the playback core is paused, otherwise ``no``. This can
be different ``pause`` in special situations, such as when the player
@@ -1236,25 +1235,12 @@ Property list
is loaded, or when switching ordered chapter segments. This is because
the same underlying code is used for seeking and resyncing.)
-``hr-seek`` (RW)
- See ``--hr-seek``.
-
``mixer-active``
Return ``yes`` if the audio mixer is active, ``no`` otherwise.
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).
-
-``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``).
-
``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
@@ -1266,9 +1252,6 @@ Property list
Similar to ``ao-volume``, but controls the mute state. May be unimplemented
even if ``ao-volume`` works.
-``audio-delay`` (RW)
- See ``--audio-delay``.
-
``audio-codec``
Audio codec selected for decoding.
@@ -1316,28 +1299,6 @@ Property list
Same as ``audio-params``, but the format of the data written to the audio
API.
-``aid`` (RW)
- Current audio track (similar to ``--aid``).
-
-``audio`` (RW)
- Alias for ``aid``.
-
-``balance`` (RW)
- Audio channel balance. (The implementation of this feature is rather odd.
- It doesn't change the volumes of each channel, but instead sets up a pan
- matrix to mix the left and right channels.)
-
- Deprecated.
-
-``fullscreen`` (RW)
- See ``--fullscreen``.
-
-``deinterlace`` (RW)
- See ``--deinterlace``.
-
-``field-dominance`` (RW)
- See ``--field-dominance``
-
``colormatrix`` (R)
Redirects to ``video-params/colormatrix``. This parameter (as well as
similar ones) can be overridden with the ``format`` video filter.
@@ -1345,42 +1306,9 @@ Property list
``colormatrix-input-range`` (R)
See ``colormatrix``.
-``video-output-levels`` (RW)
- See ``--video-output-levels``,
-
``colormatrix-primaries`` (R)
See ``colormatrix``.
-``taskbar-progress`` (RW)
- See ``--taskbar-progress``.
-
-``ontop`` (RW)
- See ``--ontop``.
-
-``border`` (RW)
- See ``--border``.
-
-``on-all-workspaces`` (RW)
- See ``--on-all-workspaces``. Unsetting may not work on all WMs.
-
-``framedrop`` (RW)
- See ``--framedrop``.
-
-``gamma`` (RW)
- See ``--gamma``.
-
-``brightness`` (RW)
- See ``--brightness``.
-
-``contrast`` (RW)
- See ``--contrast``.
-
-``saturation`` (RW)
- See ``--saturation``.
-
-``hue`` (RW)
- See ``--hue``.
-
``hwdec`` (RW)
Reflects the ``--hwdec`` option.
@@ -1413,27 +1341,6 @@ Property list
multiple interop drivers for the same hardware decoder, depending on
platform and VO.
-``hwdec-active``
- 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.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
- hardware decoding API. This is known only once the VO has opened (and
- possibly later). With some VOs (like ``opengl``), this is never known in
- advance, but only when the decoder attempted to create the hw decoder
- successfully. Also, hw decoders with ``-copy`` suffix will return ``no``
- while no video is being decoded. All this reflects how detecting hw decoders
- are detected and used internally in mpv.
-
-``panscan`` (RW)
- See ``--panscan``.
-
``video-format``
Video format as string.
@@ -1534,6 +1441,9 @@ Property list
These have the same values as ``video-out-params/dw`` and
``video-out-params/dh``.
+``video-dec-params``
+ Exactly like ``video-params``, but no overrides applied.
+
``video-out-params``
Same as ``video-params``, but after video filters have been applied. If
there are no video filters in use, this will contain the same values as
@@ -1556,10 +1466,12 @@ Property list
``video-frame-info/tff``
``video-frame-info/repeat``
-``fps``
+``container-fps``
Container FPS. This can easily contain bogus values. For videos that use
modern container formats or video codecs, this will often be incorrect.
+ (Renamed from ``fps``.)
+
``estimated-vf-fps``
Estimated/measured FPS of the video filter chain output. (If no filters
are used, this corresponds to decoder output.) This uses the average of
@@ -1580,7 +1492,10 @@ Property list
``display-names``
Names of the displays that the mpv window covers. On X11, these
- are the xrandr names (LVDS1, HDMI1, DP1, VGA1, etc.).
+ are the xrandr names (LVDS1, HDMI1, DP1, VGA1, etc.). On Windows, these
+ are the GDI names (\\.\DISPLAY1, \\.\DISPLAY2, etc.) and the first display
+ in the list will be the one that Windows considers associated with the
+ window (as determined by the MonitorFromWindow API.)
``display-fps`` (RW)
The refresh rate of the current display. Currently, this is the lowest FPS
@@ -1600,6 +1515,9 @@ Property list
``video-aspect`` (RW)
Video aspect, see ``--video-aspect``.
+ If video is active, this reports the effective aspect value, instead of
+ the value of the ``--video-aspect`` option.
+
``osd-width``, ``osd-height``
Last known OSD width (can be 0). This is needed if you want to use the
``overlay-add`` command. It gives you the actual OSD size, which can be
@@ -1608,71 +1526,24 @@ Property list
``osd-par``
Last known OSD display pixel aspect (can be 0).
-``vid`` (RW)
- Current video track (similar to ``--vid``).
-
-``video`` (RW)
- Alias for ``vid``.
-
-``video-align-x``, ``video-align-y`` (RW)
- See ``--video-align-x`` and ``--video-align-y``.
-
-``video-pan-x``, ``video-pan-y`` (RW)
- See ``--video-pan-x`` and ``--video-pan-y``.
-
-``video-zoom`` (RW)
- See ``--video-zoom``.
-
-``video-unscaled`` (W)
- See ``--video-unscaled``.
-
``program`` (W)
Switch TS program (write-only).
``dvb-channel`` (W)
Pair of integers: card,channel of current DVB stream.
- Can be switched to switch to another channel on the same card.
+ Can be switched to switch to another channel on the same card.
``dvb-channel-name`` (RW)
Name of current DVB program.
On write, a channel-switch to the named channel on the same
- card is performed. Can also be used for channel switching.
-
-``sid`` (RW)
- Current subtitle track (similar to ``--sid``).
+ card is performed. Can also be used for channel switching.
-``secondary-sid`` (RW)
- Secondary subtitle track (see ``--secondary-sid``).
+``sub-text``
+ Return the current subtitle text. Formatting is stripped. If a subtitle
+ is selected, but no text is currently visible, or the subtitle is not
+ text-based (i.e. DVD/BD subtitles), an empty string is returned.
-``sub`` (RW)
- Alias for ``sid``.
-
-``sub-delay`` (RW)
- See ``--sub-delay``.
-
-``sub-pos`` (RW)
- See ``--sub-pos``.
-
-``sub-visibility`` (RW)
- See ``--sub-visibility``.
-
-``sub-forced-only`` (RW)
- See ``--sub-forced-only``.
-
-``sub-scale`` (RW)
- Subtitle font size multiplier.
-
-``ass-force-margins`` (RW)
- See ``--ass-force-margins``.
-
-``sub-use-margins`` (RW)
- See ``--sub-use-margins``.
-
-``ass-vsfilter-aspect-compat`` (RW)
- See ``--ass-vsfilter-aspect-compat``.
-
-``ass-style-override`` (RW)
- See ``--ass-style-override``.
+ This property is experimental and might be removed in the future.
``stream-capture`` (RW)
A filename, see ``--stream-capture``. Setting this will start capture using
@@ -1884,11 +1755,8 @@ Property list
"title" MPV_FORMAT_STRING
"time" MPV_FORMAT_DOUBLE
-``af`` (RW)
- See ``--af`` and the ``af`` command.
-
-``vf`` (RW)
- See ``--vf`` and the ``vf`` command.
+``af``, ``vf`` (RW)
+ See ``--vf``/``--af`` and the ``vf``/``af`` command.
When querying the property with the client API using ``MPV_FORMAT_NODE``,
or with Lua ``mp.get_property_native``, this will return a mpv_node with
@@ -1906,12 +1774,6 @@ Property list
It's also possible to write the property using this format.
-``video-rotate`` (RW)
- See ``--video-rotate`` option.
-
-``video-stereo-mode`` (RW)
- See ``--video-stereo-mode`` option.
-
``seekable``
Return whether it's generally possible to seek in the current file.
@@ -2151,6 +2013,10 @@ Property list
require reloading the file for changes to take effect. If there is an
equivalent property, prefer setting