client API: add a screenshot_raw command

Requested.

The wild code for setting up the mpv_node probably deserves to be
cleaned up later.

Fixes #1800.

1 files changed, 9 insertions, 0 deletions

diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 3c8c51e87b..e1c3a58421 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -631,6 +631,15 @@ Input Commands that are Possibly Subject to Change
     unseekable streams that are going out of sync.
     This command might be changed or removed in the future.
 
+``screenshot_raw [subtitles|video|window]``
+    Return a screenshot in memory. This can be used only through the client
+    API. The MPV_FORMAT_NODE_MAP returned by this command has the ``w``, ``h``,
+    ``stride`` fields set to obvious contents. A ``format`` field is set to
+    ``bgr0`` by default. This format is organized as ``B8G8R8X8`` (where ``B``
+    is the LSB). The contents of the padding ``X`` is undefined. The ``data``
+    field is of type MPV_FORMAT_BYTE_ARRAY with the actual image data. The image
+    is freed as soon as the result node is freed.
+
 Undocumented commands: ``tv_last_channel`` (TV/DVB only),
 ``get_property`` (deprecated), ``ao_reload`` (experimental/internal).