summaryrefslogtreecommitdiffstats
path: root/DOCS/man/input.rst
diff options
context:
space:
mode:
authorChristoph Heinrich <christoph.heinrich@student.tugraz.at>2023-08-31 22:51:15 +0200
committerKacper Michajłow <kasper93@gmail.com>2024-03-21 03:08:52 +0100
commit0c8f3bc73ca3edf1970dd68aa5e085064968bdfd (patch)
treef2584e2750a2c97ae95c0054e8f6878be44c3836 /DOCS/man/input.rst
parent0230a0c25a767f7d285efc2e26d068d4110a0eb3 (diff)
downloadmpv-0c8f3bc73ca3edf1970dd68aa5e085064968bdfd.tar.bz2
mpv-0c8f3bc73ca3edf1970dd68aa5e085064968bdfd.tar.xz
player/command: add term-size/[w,h] property
There was no way for scripts to know the current size of the terminal, which is essintial if they want to provide a good user experience even without a window.
Diffstat (limited to 'DOCS/man/input.rst')
-rw-r--r--DOCS/man/input.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 3d3163eb1c..cf4a43636b 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2804,6 +2804,19 @@ Property list
Any of these properties may be unavailable or set to dummy values if the
VO window is not created or visible.
+``term-size``
+ The current terminal size.
+
+ This has two sub-properties.
+
+ ``term-size/w``
+ width of the terminal in cells
+ ``term-size/h``
+ height of the terminal in cells
+
+ This property is not observable. Reacting to size changes requires
+ polling.
+
``window-id``
Read-only - mpv's window id. May not always be available, i.e due to window
not being opened yet or not being supported by the VO.