@@ -5750,6 +5750,12 @@ <h2>OSD</h2>
57505750<dt><tt class="docutils literal"><span class="pre">--osd-color=<color></span></tt></dt>
57515751<dd>Specify the color used for OSD.
57525752See <tt class="docutils literal"><span class="pre">--sub-color</span></tt> for details.</dd>
5753+ <dt><tt class="docutils literal"><span class="pre">--osd-selected-color=<color></span></tt></dt>
5754+ <dd>The color of the selected item in lists.
5755+ See <tt class="docutils literal"><span class="pre">--sub-color</span></tt> for details.</dd>
5756+ <dt><tt class="docutils literal"><span class="pre">--osd-selected-outline-color=<color></span></tt></dt>
5757+ <dd>The outline color of the selected item in lists.
5758+ See <tt class="docutils literal"><span class="pre">--sub-color</span></tt> for details.</dd>
57535759<dt><tt class="docutils literal"><span class="pre">--osd-fractions</span></tt></dt>
57545760<dd>Show OSD times with fractions of seconds (in millisecond precision). Useful
57555761to see the exact timestamp of a video frame.</dd>
@@ -8828,6 +8834,19 @@ <h2>Miscellaneous</h2>
88288834code is the same.)</p>
88298835<p class="last">Conversion is not applied to metadata that is updated at runtime.</p>
88308836</dd>
8837+ <dt><tt class="docutils literal"><span class="pre">--clipboard-enable=<yes|no></span></tt></dt>
8838+ <dd><p class="first">(Windows and Wayland only)</p>
8839+ <p class="last">Enable native clipboard support (default: yes). This allows reading and
8840+ writing to the <tt class="docutils literal">clipboard</tt> property to get and set clipboard contents.</p>
8841+ </dd>
8842+ <dt><tt class="docutils literal"><span class="pre">--clipboard-monitor=<yes|no></span></tt></dt>
8843+ <dd><p class="first">(Windows only)</p>
8844+ <p class="last">Enable clipboard monitoring so that the <tt class="docutils literal">clipboard</tt> property can be
8845+ observed for content changes (default: no). This only affects clipboard
8846+ implementations which use polling to monitor clipboard updates.
8847+ Other platforms currently ignore this option and always/never notify
8848+ changes.</p>
8849+ </dd>
88318850</dl>
88328851</div>
88338852</div>
@@ -11192,7 +11211,10 @@ <h2>Key names</h2>
1119211211<p class="last"><tt class="docutils literal">MBTN*</tt> are aliases for <tt class="docutils literal">MOUSE_BTN*</tt>.</p>
1119311212</dd>
1119411213<dt><tt class="docutils literal">WHEEL_*</tt></dt>
11195- <dd>Mouse wheels (typically).</dd>
11214+ <dd><p class="first">Mouse wheels and touch pads (typically).</p>
11215+ <p class="last">These key are scalable when used with scalable commands if the underlying
11216+ device supports high-resolution scrolling (e.g. touch pads).</p>
11217+ </dd>
1119611218<dt><tt class="docutils literal">AXIS_*</tt></dt>
1119711219<dd>Deprecated aliases for <tt class="docutils literal">WHEEL_*</tt>.</dd>
1119811220<dt><tt class="docutils literal">*_DBL</tt></dt>
@@ -11320,9 +11342,11 @@ <h3>Playback Control</h3>
1132011342<p>By default, <tt class="docutils literal">keyframes</tt> is used for <tt class="docutils literal">relative</tt>, <tt class="docutils literal"><span class="pre">relative-percent</span></tt>,
1132111343and <tt class="docutils literal"><span class="pre">absolute-percent</span></tt> seeks, while <tt class="docutils literal">exact</tt> is used for <tt class="docutils literal">absolute</tt>
1132211344seeks.</p>
11323- <p class="last" >Before mpv 0.9, the <tt class="docutils literal">keyframes</tt> and <tt class="docutils literal">exact</tt> flags had to be passed as
11345+ <p>Before mpv 0.9, the <tt class="docutils literal">keyframes</tt> and <tt class="docutils literal">exact</tt> flags had to be passed as
11324113463rd parameter (essentially using a space instead of <tt class="docutils literal">+</tt>). The 3rd
1132511347parameter is still parsed, but is considered deprecated.</p>
11348+ <p class="last">This is a scalable command. See the documentation of <tt class="docutils literal">nonscalable</tt> input
11349+ command prefix in <a class="reference internal" href="#input-command-prefixes">Input Command Prefixes</a> for details.</p>
1132611350</dd>
1132711351<dt><tt class="docutils literal"><span class="pre">revert-seek</span> [<flags>]</tt></dt>
1132811352<dd><p class="first">Undoes the <tt class="docutils literal">seek</tt> command, and some other commands that seek (but not
@@ -11395,8 +11419,11 @@ <h3>Property Manipulation</h3>
1139511419<dt><tt class="docutils literal">del <name></tt></dt>
1139611420<dd>Delete the given property. Most properties cannot be deleted.</dd>
1139711421<dt><tt class="docutils literal">add <name> [<value>]</tt></dt>
11398- <dd>Add the given value to the property or option. On overflow or underflow,
11399- clamp the property to the maximum. If <tt class="docutils literal"><value></tt> is omitted, assume <tt class="docutils literal">1</tt>.</dd>
11422+ <dd><p class="first">Add the given value to the property or option. On overflow or underflow,
11423+ clamp the property to the maximum. If <tt class="docutils literal"><value></tt> is omitted, assume <tt class="docutils literal">1</tt>.</p>
11424+ <p class="last">This is a scalable command. See the documentation of <tt class="docutils literal">nonscalable</tt> input
11425+ command prefix in <a class="reference internal" href="#input-command-prefixes">Input Command Prefixes</a> for details.</p>
11426+ </dd>
1140011427<dt><tt class="docutils literal">multiply <name> <value></tt></dt>
1140111428<dd>Similar to <tt class="docutils literal">add</tt>, but multiplies the property or option with the numeric
1140211429value.</dd>
@@ -11405,9 +11432,11 @@ <h3>Property Manipulation</h3>
1140511432<tt class="docutils literal">down</tt> to set the cycle direction. On overflow, set the property back to
1140611433the minimum, on underflow set it to the maximum. If <tt class="docutils literal">up</tt> or <tt class="docutils literal">down</tt> is
1140711434omitted, assume <tt class="docutils literal">up</tt>.</p>
11408- <p class="last" >Whether or not key-repeat is enabled by default depends on the property.
11435+ <p>Whether or not key-repeat is enabled by default depends on the property.
1140911436Currently properties with continuous values are repeatable by default (like
1141011437<tt class="docutils literal">volume</tt>), while discrete values are not (like <tt class="docutils literal"><span class="pre">osd-level</span></tt>).</p>
11438+ <p class="last">This is a scalable command. See the documentation of <tt class="docutils literal">nonscalable</tt> input
11439+ command prefix in <a class="reference internal" href="#input-command-prefixes">Input Command Prefixes</a> for details.</p>
1141111440</dd>
1141211441<dt><tt class="docutils literal"><span class="pre">cycle-values</span> <span class="pre">[<"!reverse">]</span> <property> <value1> [<value2> <span class="pre">[...]]</span></tt></dt>
1141311442<dd><p class="first">Cycle through a list of values. Each invocation of the command will set the
@@ -12201,23 +12230,28 @@ <h3>Scripting Commands</h3>
1220112230<p class="last">This command has a variable number of arguments, and cannot be used with
1220212231named arguments.</p>
1220312232</dd>
12204- <dt><tt class="docutils literal"><span class="pre">script-binding</span> <name></tt></dt>
12233+ <dt><tt class="docutils literal"><span class="pre">script-binding</span> <name> [<arg>] </tt></dt>
1220512234<dd><p class="first">Invoke a script-provided key binding. This can be used to remap key
1220612235bindings provided by external Lua scripts.</p>
12207- <p>The argument is the name of the binding.</p>
12236+ <p><tt class="docutils literal"><name></tt> is the name of the binding. <tt class="docutils literal"><arg></tt> is a user-provided
12237+ arbitrary string which can be used to provide extra information.</p>
1220812238<p>It can optionally be prefixed with the name of the script, using <tt class="docutils literal">/</tt> as
1220912239separator, e.g. <tt class="docutils literal"><span class="pre">script-binding</span> scriptname/bindingname</tt>. Note that script
1221012240names only consist of alphanumeric characters and <tt class="docutils literal">_</tt>.</p>
1221112241<p>For completeness, here is how this command works internally. The details
1221212242could change any time. On any matching key event, <tt class="docutils literal"><span class="pre">script-message-to</span></tt>
1221312243or <tt class="docutils literal"><span class="pre">script-message</span></tt> is called (depending on whether the script name is
12214- included), with the following arguments:</p>
12244+ included), with the following arguments in string format :</p>
1221512245<ol class="arabic simple">
1221612246<li>The string <tt class="docutils literal"><span class="pre">key-binding</span></tt>.</li>
1221712247<li>The name of the binding (as established above).</li>
1221812248<li>The key state as string (see below).</li>
1221912249<li>The key name (since mpv 0.15.0).</li>
1222012250<li>The text the key would produce, or empty string if not applicable.</li>
12251+ <li>The scale of the key, such as the ones produced by <tt class="docutils literal">WHEEL_*</tt> keys.
12252+ The scale is 1 if the key is nonscalable.</li>
12253+ <li>The user-provided string <tt class="docutils literal"><arg></tt>, or empty string if the argument is
12254+ not used.</li>
1222112255</ol>
1222212256<p>The 5th argument is only set if no modifiers are present (using the shift
1222312257key with a letter is normally not emitted as having a modifier, and results
@@ -12233,8 +12267,10 @@ <h3>Scripting Commands</h3>
1223312267released but not physically released), either <tt class="docutils literal">c</tt> (canceled) or <tt class="docutils literal">-</tt>
1223412268(something else). Not all types of cancellations set this flag.</li>
1223512269</ol>
12236- <p class="last" >Future versions can add more arguments and more key state characters to
12270+ <p>Future versions can add more arguments and more key state characters to
1223712271support more input peculiarities.</p>
12272+ <p class="last">This is a scalable command. See the documentation of <tt class="docutils literal">nonscalable</tt> input
12273+ command prefix in <a class="reference internal" href="#input-command-prefixes">Input Command Prefixes</a> for details.</p>
1223812274</dd>
1223912275<dt><tt class="docutils literal"><span class="pre">load-script</span> <filename></tt></dt>
1224012276<dd><p class="first">Load a script, similar to the <tt class="docutils literal"><span class="pre">--script</span></tt> option. Whether this waits for
@@ -12468,8 +12504,9 @@ <h3>Miscellaneous Commands</h3>
1246812504<dd>Begin window dragging if supported by the current VO. This command should
1246912505only be called while a mouse button is being pressed, otherwise it will
1247012506be ignored. The exact effect of this command depends on the VO implementation
12471- of window dragging. For example, on Windows only the left mouse button can
12472- begin window dragging, while X11 and Wayland allow other mouse buttons.</dd>
12507+ of window dragging. For example, on Windows and macOS only the left mouse
12508+ button can begin window dragging, while X11 and Wayland allow other mouse
12509+ buttons.</dd>
1247312510<dt><tt class="docutils literal"><span class="pre">context-menu</span></tt></dt>
1247412511<dd>Show context menu on the video window. See <a class="reference internal" href="#context-menu">Context Menu</a> section for details.</dd>
1247512512</dl>
@@ -14451,6 +14488,23 @@ <h2>Property list</h2>
1445114488</dl>
1445214489<p class="last">This property is read-only, and change notification is not supported.</p>
1445314490</dd>
14491+ <dt><tt class="docutils literal">clipboard</tt></dt>
14492+ <dd><p class="first">The clipboard contents, only works when native clipboard
14493+ (<tt class="docutils literal"><span class="pre">--clipboard-enable</span></tt>) is supported on the platform.
14494+ Depending on the platform, some sub-properties, writing to properties,
14495+ or change notifications are not currently functional.</p>
14496+ <p>This has a number of sub-properties:</p>
14497+ <dl class="docutils">
14498+ <dt><tt class="docutils literal">clipboard/text</tt> (RW)</dt>
14499+ <dd>The text content in the clipboard (Windows and Wayland only).
14500+ Writing to this property sets the text clipboard content (Windows only).</dd>
14501+ </dl>
14502+ <div class="admonition note last">
14503+ <p class="first admonition-title">Note</p>
14504+ <p class="last">On Wayland, the clipboard content is only updated when the compositor
14505+ sends a selection data offer (typically when VO window is focused).</p>
14506+ </div>
14507+ </dd>
1445414508</dl>
1445514509</div>
1445614510<div class="section" id="inconsistencies-between-options-and-properties">
@@ -14662,13 +14716,13 @@ <h3>The Interface</h3>
1466214716</colgroup>
1466314717<tbody valign="top">
1466414718<tr><td>left-click</td>
14665- <td>open the playlist selector </td>
14719+ <td>show file and track info </td>
1466614720</tr>
1466714721<tr><td>middle-click</td>
1466814722<td>show the filename</td>
1466914723</tr>
1467014724<tr><td>right-click</td>
14671- <td>show file and track info </td>
14725+ <td>open the playlist selector </td>
1467214726</tr>
1467314727</tbody>
1467414728</table>
@@ -14797,16 +14851,16 @@ <h3>The Interface</h3>
1479714851</colgroup>
1479814852<tbody valign="top">
1479914853<tr><td>left-click</td>
14800- <td>open the audio/sub track selector </td>
14854+ <td>cycle audio/sub tracks forward </td>
1480114855</tr>
1480214856<tr><td>shift+L-click</td>
14803- <td>show available audio/sub tracks</td>
14857+ <td>cycle audio/sub tracks backwards </td>
1480414858</tr>
1480514859<tr><td>middle-click</td>
1480614860<td>show available audio/sub tracks</td>
1480714861</tr>
1480814862<tr><td>right-click</td>
14809- <td>show available audio/sub tracks </td>
14863+ <td>open the audio/sub track selector </td>
1481014864</tr>
1481114865<tr><td>mouse wheel</td>
1481214866<td>cycle audio/sub tracks forward/backwards</td>
@@ -15168,9 +15222,9 @@ <h3>Configurable Options</h3>
1516815222</dl>
1516915223<p>The following options configure what commands are run when the buttons are
1517015224clicked. <tt class="docutils literal">mbtn_mid</tt> commands are also triggered with <tt class="docutils literal">shift+mbtn_left</tt>.</p>
15171- <p><tt class="docutils literal"><span class="pre">title_mbtn_left_command=script-binding</span> <span class="pre">select/select-playlist;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide </span></tt></p>
15225+ <p><tt class="docutils literal"><span class="pre">title_mbtn_left_command=script-binding</span> <span class="pre">stats/display-page-5 </span></tt></p>
1517215226<p><tt class="docutils literal"><span class="pre">title_mbtn_mid_command=show-text</span> ${filename}</tt></p>
15173- <p><tt class="docutils literal"><span class="pre">title_mbtn_right_command=script-binding</span> <span class="pre">stats/display-page-5 </span></tt></p>
15227+ <p><tt class="docutils literal"><span class="pre">title_mbtn_right_command=script-binding</span> <span class="pre">select/select-playlist;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide </span></tt></p>
1517415228<p><tt class="docutils literal"><span class="pre">playlist_prev_mbtn_left_command=playlist-prev;</span> <span class="pre">show-text</span> ${playlist} 3000</tt></p>
1517515229<p><tt class="docutils literal"><span class="pre">playlist_prev_mbtn_mid_command=show-text</span> ${playlist} 3000</tt></p>
1517615230<p><tt class="docutils literal"><span class="pre">playlist_prev_mbtn_right_command=show-text</span> ${playlist} 3000</tt></p>
@@ -15186,14 +15240,14 @@ <h3>Configurable Options</h3>
1518615240<p><tt class="docutils literal"><span class="pre">chapter_next_mbtn_left_command=osd-msg</span> add chapter 1</tt></p>
1518715241<p><tt class="docutils literal"><span class="pre">chapter_next_mbtn_mid_command=show-text</span> <span class="pre">${chapter-list}</span> 3000</tt></p>
1518815242<p><tt class="docutils literal"><span class="pre">chapter_next_mbtn_right_command=script-binding</span> <span class="pre">select/select-chapter;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide</span></tt></p>
15189- <p><tt class="docutils literal"><span class="pre"> audio_track_mbtn_left_command=script-binding</span> <span class="pre">select/select-aid;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide</span> </tt></p>
15190- <p><tt class="docutils literal"><span class="pre"> audio_track_mbtn_mid_command=show-text</span> <span class="pre">${track-list/ audio}</span> 3000 </tt></p>
15191- <p><tt class="docutils literal">audio_track_mbtn_right_command=cycle audio </tt></p>
15243+ <p><tt class="docutils literal">audio_track_mbtn_left_command=cycle audio </tt></p>
15244+ <p><tt class="docutils literal">audio_track_mbtn_mid_command=cycle audio down </tt></p>
15245+ <p><tt class="docutils literal"><span class="pre"> audio_track_mbtn_right_command=script-binding</span> <span class="pre">select/select-aid;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide</span> </tt></p>
1519215246<p><tt class="docutils literal">audio_track_wheel_down_command=cycle audio</tt></p>
1519315247<p><tt class="docutils literal">audio_track_wheel_up_command=cycle audio down</tt></p>
15194- <p><tt class="docutils literal"><span class="pre"> sub_track_mbtn_left_command=script-binding</span> <span class="pre">select/select-sid;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide</span> </tt></p>
15195- <p><tt class="docutils literal"><span class="pre"> sub_track_mbtn_mid_command=show-text</span> <span class="pre">${track-list/ sub}</span> 3000 </tt></p>
15196- <p><tt class="docutils literal">sub_track_mbtn_right_command=cycle sub </tt></p>
15248+ <p><tt class="docutils literal">sub_track_mbtn_left_command=cycle sub </tt></p>
15249+ <p><tt class="docutils literal">sub_track_mbtn_mid_command=cycle sub down </tt></p>
15250+ <p><tt class="docutils literal"><span class="pre"> sub_track_mbtn_right_command=script-binding</span> <span class="pre">select/select-sid;</span> <span class="pre">script-message-to</span> osc <span class="pre">osc-hide</span> </tt></p>
1519715251<p><tt class="docutils literal">sub_track_wheel_down_command=cycle sub</tt></p>
1519815252<p><tt class="docutils literal">sub_track_wheel_up_command=cycle sub down</tt></p>
1519915253<p><tt class="docutils literal"><span class="pre">volume_mbtn_left_command=no-osd</span> cycle mute</tt></p>
@@ -15970,13 +16024,19 @@ <h2>mp functions</h2>
1597016024internally. (Omitting works as follows: either pass <tt class="docutils literal">nil</tt> for <tt class="docutils literal">name</tt>,
1597116025or pass the <tt class="docutils literal">fn</tt> argument in place of the name. The latter is not
1597216026recommended and is handled for compatibility only.)</p>
15973- <p>The last argument is used for optional flags . This is a table, which can
15974- have the following entries:</p>
16027+ <p>The <tt class="docutils literal">flags</tt> argument is used for optional parameters . This is a table,
16028+ which can have the following entries:</p>
1597516029<blockquote>
1597616030<dl class="docutils">
1597716031<dt><tt class="docutils literal">repeatable</tt></dt>
1597816032<dd>If set to <tt class="docutils literal">true</tt>, enables key repeat for this specific binding.
1597916033This option only makes sense when <tt class="docutils literal">complex</tt> is not set to <tt class="docutils literal">true</tt>.</dd>
16034+ <dt><tt class="docutils literal">scalable</tt></dt>
16035+ <dd>If set to <tt class="docutils literal">true</tt>, enables key scaling for this specific binding.
16036+ This option only makes sense when <tt class="docutils literal">complex</tt> is set to <tt class="docutils literal">true</tt>.
16037+ Note that this has no effect if the key binding is invoked by
16038+ <tt class="docutils literal"><span class="pre">script-binding</span></tt> command, where the scalability of the command
16039+ takes precedence.</dd>
1598016040<dt><tt class="docutils literal">complex</tt></dt>
1598116041<dd><p class="first">If set to <tt class="docutils literal">true</tt>, then <tt class="docutils literal">fn</tt> is called on key down, repeat and up
1598216042events, with the first argument being a table. This table has the
@@ -16000,6 +16060,13 @@ <h2>mp functions</h2>
1600016060<dd>Text if triggered by a text key, otherwise <tt class="docutils literal">nil</tt>. See
1600116061description of <tt class="docutils literal"><span class="pre">script-binding</span></tt> command for details (this
1600216062field is equivalent to the 5th argument).</dd>
16063+ <dt><tt class="docutils literal">scale</tt></dt>
16064+ <dd>The scale of the key, such as the ones produced by <tt class="docutils literal">WHEEL_*</tt>
16065+ keys. The scale is 1 if the key is nonscalable.</dd>
16066+ <dt><tt class="docutils literal">arg</tt></dt>
16067+ <dd>User-provided string in the <tt class="docutils literal">arg</tt> argument in the
16068+ <tt class="docutils literal"><span class="pre">script-binding</span></tt> command if the key binding is invoked
16069+ by that command.</dd>
1600316070</dl>
1600416071</blockquote>
1600516072</dd>
0 commit comments