mirror of
https://github.com/mpv-player/mpv.git
synced 2026-10-17 06:50:45 +08:00
Kacper Michajłow
2ddd0f027c
Load context_menu.lua when --d3d11-exclusive-fs is enabled and open it instead of the native context menu. Native context menu cannot be displayed over the exlusive window. Fixes: #18181
144 lines
4.1 KiB
ReStructuredText
144 lines
4.1 KiB
ReStructuredText
CONTEXT MENU
|
|
============
|
|
|
|
The context menu is a menu that pops up on the video window. By default, it is
|
|
bound to right click.
|
|
|
|
menu.conf
|
|
---------
|
|
|
|
You can define your own menu in ``~~/menu.conf`` (see `FILES`_), or an
|
|
alternative path specified with ``--script-opt=select-menu_conf_path``. It is
|
|
recommended to use the default ``menu.conf`` from
|
|
https://github.com/mpv-player/mpv/blob/master/etc/menu.conf as an example to get
|
|
started.
|
|
|
|
Each line of ``menu.conf`` is a menu item with fields separated by 1 or more
|
|
tabs. The first field is the text shown in the menu. The second field is usually
|
|
the command that is run when that item is selected. Fields from the third
|
|
onwards can specify ``checked=``, ``disabled=`` and ``hidden=`` states in the
|
|
same way as `Conditional auto profiles`_.
|
|
|
|
When there is no command, the item will open a submenu. Fields below indented
|
|
with leading whitespace are added to this submenu. Nested submenu items are
|
|
defined by adding more leading whitespace than the parent menu entry.
|
|
|
|
Empty lines are interpreted as separators.
|
|
|
|
The second field can also be one of the following tokens to make that entry a
|
|
submenu with the relative items: ``$playlist``, ``$tracks``, ``$video-tracks``,
|
|
``$audio-tracks``, ``$sub-tracks``, ``$secondary-sub-tracks``, ``$chapters``,
|
|
``$editions``, ``$audio-devices``, ``$profiles``. These menus are automatically
|
|
disabled when empty.
|
|
|
|
To use the native context menu, you need to fill the ``menu-data`` property with
|
|
menu definition data, and call the ``context-menu`` command. In builtin scripts,
|
|
this is done by ``select.lua``, which parses ``menu.conf`` to populate
|
|
``menu-data``. It then calls the ``context-menu`` command on platforms where
|
|
integration with the native context menu is implemented, while on platforms
|
|
where it is not, it opens ``context_menu.lua``.
|
|
|
|
On platforms without integration with the native context menu,
|
|
``context_menu.lua`` can be disabled entirely using the
|
|
``--load-context-menu=no`` option. On platforms where the integration is
|
|
implemented, it is already disabled by default, and ``--load-context-menu=yes``
|
|
will make ``select.lua`` use it. It is also loaded when ``--d3d11-exclusive-fs``
|
|
is enabled, and ``select.lua`` uses it in exclusive fullscreen.
|
|
|
|
Script messages
|
|
---------------
|
|
|
|
``open``
|
|
Show the context menu.
|
|
|
|
``select``
|
|
Select the focused item when there is one.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
This script can be customized through a config file
|
|
``script-opts/context_menu.conf`` placed in mpv's user directory and through
|
|
the ``--script-opts`` command-line option. The configuration syntax is
|
|
described in `mp.options functions`_.
|
|
|
|
Configurable Options
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
``font_size``
|
|
Default: 14
|
|
|
|
The font size.
|
|
|
|
``gap``
|
|
Default: 0.2
|
|
|
|
The gap between menu items, specified as a percentage the font size.
|
|
|
|
``padding_x``
|
|
Default: 8
|
|
|
|
The horizontal padding of the menu.
|
|
|
|
``padding_y``
|
|
Default: 4
|
|
|
|
The vertical padding of the menu.
|
|
|
|
``menu_outline_size``
|
|
Default: 0
|
|
|
|
The size of the menu's border.
|
|
|
|
``menu_outline_color``
|
|
Default: ``#FFFFFF``
|
|
|
|
The color of the menu's border.
|
|
|
|
``background_alpha``
|
|
Default: ``0``
|
|
|
|
The transparency of the menu's background. Ranges from 0 (opaque) to 255
|
|
(fully transparent).
|
|
|
|
``corner_radius``
|
|
Default: 5
|
|
|
|
The radius of the menu's corners.
|
|
|
|
``scale_with_window``
|
|
Default: auto
|
|
|
|
Whether to scale sizes with the window height. Can be ``yes``, ``no``, or
|
|
``auto``, which follows the value of ``--osd-scale-by-window``.
|
|
|
|
When sizes aren't scaled with the window, they are scaled by
|
|
``display-hidpi-scale``.
|
|
|
|
``focused_color``
|
|
Default: ``#222222``
|
|
|
|
The color of the focused item.
|
|
|
|
``focused_back_color``
|
|
Default: ``#FFFFFF``
|
|
|
|
The background color of the focused item.
|
|
|
|
``disabled_color``
|
|
Default: ``#555555``
|
|
|
|
The color of disabled items and separators.
|
|
|
|
``seconds_to_open_submenus``
|
|
Default: 0.2
|
|
|
|
The number of seconds to open submenus after the cursor enters items
|
|
associated with one.
|
|
|
|
``seconds_to_close_submenus``
|
|
Default: 0.2
|
|
|
|
The number of seconds to close submenus after the cursor enters a parent
|
|
menu.
|