coco
47 lines
1.5 KiB
ReStructuredText
47 lines
1.5 KiB
ReStructuredText
CUSTOM BUTTONS
|
|
==============
|
|
|
|
Custom buttons provides a way to execute lua code by pressing a button in the player. mpvKt also provides an interface to interact with some parts of the player.
|
|
|
|
The interface is defined in a file placed in the ``scripts`` directory and can be accessed through the ``mpvkt`` table.
|
|
|
|
Lua interface
|
|
-------------
|
|
|
|
``mpvkt.show_text(text)``
|
|
Display a message on the player.
|
|
|
|
``mpvkt.hide_ui()``
|
|
Hide the player UI.
|
|
|
|
``mpvkt.show_ui()``
|
|
Show the player UI.
|
|
|
|
``mpvkt.toggle_ui()``
|
|
Toggle the visibility of the player UI.
|
|
|
|
``mpvkt.show_subtitle_settings()``
|
|
Show the subtitle settings sheet.
|
|
|
|
``mpvkt.show_subtitle_delay()``
|
|
Show the subtitle delay sheet.
|
|
|
|
``mpvkt.show_audio_delay()``
|
|
Show the subtitle delay sheet.
|
|
|
|
``mpvkt.show_video_filters()``
|
|
Show the video filters sheet.
|
|
|
|
``mpvkt.set_button_title(text)``
|
|
Change the title for the primary custom button.
|
|
|
|
``mpvkt.reset_button_title(text)``
|
|
Reset the title for the primary custom button.
|
|
|
|
Call a custom button from key input or from lua
|
|
-----------------------------------------------
|
|
|
|
Custom buttons can be called from key inputs or from other lua scripts, if so desired. This is done through ``script-message`` with the message ``call_button_<id>`` for normal press and ``call_button_<id>_long`` for long press, where ``<id>`` is the id for the button (shown in top right when editing a button).
|
|
|
|
Example: ``a script-message call_button_1`` will call the button of id 1 when ``a`` is pressed, if added to ``input.conf``.
|