Custom buttons

This sections deals with custom buttons and how they work.

WARNING

This page explores some advanced features.

What are custom buttons?

Custom buttons provides a way to execute lua code by pressing a button in the player. Aniyomi also provides an interface to interact with some parts of the player. By default, Aniyomi comes with a button to seek 85 seconds forward which is meant to skip intros. The duration can be changed by long pressing the button.

Adding a custom button

To add a custom button, press the Add button in the bottom right. A button must have a unique title, as long with some lua code that will be executed when pressed. Additionally, the custom button may include some code that will be executed when long pressed, and code that will be executed once on player startup.

Editing a custom button

The up or down arrow will the determine the order of the custom buttons. Press the button to set a button as the primary one, to edit a custom button, and to delete a custom button.

For your information

Only one button can be set as a primary, which will appear in the player. The rest will appear in the More sheet.

Examples

+85 s

This one is added in as default. Tapping the custom button will seek ahead by the skip intro length, and long pressing will change the intro length for the anime.

Lua code:

local intro_length = mp.get_property_number("user-data/current-anime/intro-length")
aniyomi.right_seek_by(intro_length)

Lua code (on long press):

aniyomi.int_picker("Change intro length", "%ds", 0, 255, 1, "user-data/current-anime/intro-length")

On startup:

function update_button(_, length)
  if length ~= nil then
    if length == 0 then
      aniyomi.hide_button()
      return
    else
      aniyomi.show_button()
    end
    aniyomi.set_button_title("+" .. length .. " s")
  end
end

if $isPrimary then
  mp.observe_property("user-data/current-anime/intro-length", "number", update_button)
end

Toggle debanding

This button will toggle debanding when pressed, and will open up a picker to choose the deband threshold on long press.

Lua code:

local deband = mp.get_property_bool("deband")
mp.set_property_bool("deband", not deband)
aniyomi.show_text("Debanding: " .. (deband and "off" or "on"))

Lua code (on long press):

aniyomi.int_picker("Change deband threshold", "%d", 0, 4096, 4, "deband-threshold")

Advanced

Internally, buttons are dispatched through mp.register_script_message() with the name call_button_<id> and call_button_<id>_long where <id> is the button id (it is shown in the top right when editing a button). This means they can be invoked through a keybind for example. If Double tap (center) is set to custom under More -> Player settings -> Gestures, then 0x10002 script-message call_button_1_long will invoke the long press of the custom button with id 1.

Additionally, $id can be used as a placeholder in a custom button for its own id, and $isPrimary will result in a boolean whether the current button is the primary one. This can be useful if you only want to execute some code on startup if it's the primary one, see +85s for an example.

Lua interface

Aniyomi provides a lua interface that can be used both in custom buttons and in lua scripts.

aniyomi.show_text(text)

Display some Text on the player.

• text (string) - The text to display.

aniyomi.hide_ui()

Hide the ui.

aniyomi.show_ui()

Show the ui.

aniyomi.toggle_ui()

Toggle the visibility of the ui.

aniyomi.show_subtitle_settings()

Show the Subtitle settings panel.

aniyomi.show_subtitle_delay()

Show the Subtitle delay panel.

aniyomi.show_audio_delay()

Show the Audio delay panel.

aniyomi.show_video_filters()

Show the Video filters panel.

aniyomi.set_button_title(text)

Set the title of the custom button.

• text (string) - The text to set the button to.

aniyomi.reset_button_title()

Reset the custom button title.

aniyomi.previous_episode()

Switch to the previous episode.

aniyomi.next_episode()

Switch to the next episode.

aniyomi.int_picker(title, name_format, start, stop, step, property)

Open up a wheel picker to set an integer value to a property.

• title (string) - Title of the dialog.
• name_format (string) - Format of each entry. Set to %d to just display the number.
• start (integer) - Start value for integer range.
• stop (integer) - Stop value for integer range.
• step (integer) - Step value for integer range.
• property (string) - mpv property to assign value to.

aniyomi.pause()

Pause the player.

aniyomi.unpause()

Resume the player.

aniyomi.pauseunpause()

Toggle pausing.

aniyomi.seek_to_with_text(value, text)

Seek to a position and display some text in the seek ripple.

• value (integer) - Position to seek to (in seconds).
• text (string) - Text to display.

aniyomi.hide_button()

Hide the primary button from the player.

aniyomi.show_button()

Show the primary button.

aniyomi.left_seek_by(value)

Seek backwards.

• value (integer) - Seconds to seek back by.

aniyomi.right_seek_by(value)

Seek forwards.

• value (integer) - Seconds to seek forwards by.