PluginBase

PluginBase

PluginBase(app, pl, info)

The base class of the plugin.

Parameters

Parameter	Default	Description
app SeaPlayer	required	A link to the image of the SeaPlayer class.
pl PluginLoader	required	A link to the image of the PluginLoader class.
info PluginInfo	required	Contains all variables from info.json.

app instance-attribute

app = app

A link to the image of the SeaPlayer class.

info instance-attribute

info = info

Contains all variables from info.json.

pl instance-attribute

pl = pl

A link to the image of the PluginLoader class.

__init_repr__

__init_repr__()

The string that is output to the logs after initialization of the class.

Returns

Name	Type	Description
str	str	A string indicating the initialization of the class.

add_codecs

add_codecs(*codecs)

Adding codecs.

add_value_handlers

add_value_handlers(*handlers)

Adding handlers for user-entered values.

install_screen

install_screen(name, screen)

Adding a new Screen.

Parameters

Parameter	Default	Description
name str	required	The name by which it will be accessed by SeaPlayer.
screen Screen	required	The image of the Screen class.

on_bindings

on_bindings()

A generator for binding information classes about keys.

Yields:

Type	Description
Binding	Generator[Binding, Any, None]: A class with information about key bindings.

on_compose async

on_compose()

A function called after initializing the SeaPlayer widgets.

on_init

on_init()

A function called during the initialization of the SeaPlayer.

on_quit async

on_quit()

The function starts after sending a signal to close the SeaPlayer.

on_ready async

on_ready()

The function starts immediately after the SeaPlayer is fully launched.

on_run

on_run()

A function called before launching SeaPlayer.