Plugin Development

Description

Creation/Testing the plugin requires using the Plugin CLI.

It is recommended to read it.

Be sure to read the Plugin CLI guide.

Create Directory

mkdir ExamplePlugin

Create Environment

seaplug create ExamplePlugin

The following file structure will be created:

graph LR
    A{ExamplePlugin} --> B[__init__.py];
    A{ExamplePlugin} --> C[info.json];
    A{ExamplePlugin} --> D[requirements.txt];

About requirements.txt

The default file is requirements.txt it's not being created, you have to create it yourself if our plugin uses third-party modules.

File info.json

Source

This is just information about your plugin.

ExamplePlugin/info.json

{
    "name": "ExamplePlugin",
    "name_id": "seaplayer.plugins.example",
    "version": "1.0.0",
    "author": "Romanin",
    "description": null,    // optional
    "url": null             // optional
}

Very important!

Think carefully about the name_id, because if it matches the name_id of another plugin, there may be a conflict when loading plugins.

File requirements.txt

As mentioned above, the file requirements.txt it is not created after calling seaplug create ExamplePlugin, and it is recommended to create it only if your plugin has dependencies with other modules.

Source

ExamplePlugin/requirements.txt

module>=version
...

Nothing is difficult!

File requirements.txt it is filled in according to the same principle as a regular file requirements.txt in Python. More information.

File __init__.py

Source

ExamplePlugin/__init.py__

from seaplayer.plug import PluginBase

class Plugin(PluginBase):
    pass

__plugin__ = Plugin

Very important!

You don't have to write everything in one __init__.py, the most important thing is that in __init__.py, there was a variable __plugin__ containing a reference to the class.

The queue for launching the SeaPlayer

graph LR
    SP{SeaPlayer} --> SP_RUN[SeaPlayer.run] --> SP_COMPOSE[SeaPlayer.compose] --> SP_ONREADY[SeaPlayer.on_ready];
    SP{SeaPlayer} --> SP_INIT[SeaPlayer.__init__];
    SP_INIT[SeaPlayer.__init__] --> PL_ONINIT[PluginLoader.on_init] --> P_ONINIT[Plugin.on_init];
    SP_INIT[SeaPlayer.__init__] --> PL_INIT[PluginLoader.__init__];
    PL_ONINIT[PluginLoader.on_init] --> P_INIT[Plugin.__init__];
    SP_RUN[SeaPlayer.run] --> PL_ONRUN[PluginLoader.on_run] --> P_ONRUN[Plugin.on_run];
    SP_COMPOSE[SeaPlayer.compose] --> PL_ONCOMPOSE[PluginLoader.on_compose] --> P_ONCOMPOSE[Plugin.on_compose];
    SP_ONREADY[SeaPlayer.on_ready] --> PL_ONREADY[PluginLoader.on_ready] --> P_ONREADY[Plugin.on_ready];

Basic Usage

Method on_init

The method called immediately after initialization of the SeaPlayer.__init__ class.

ExamplePlugin/__init.py__

from seaplayer.plug import PluginBase

class Plugin(PluginBase):
    def on_init(self) -> None:
        pass

__plugin__ = Plugin

Method on_run

This method is called during a call to the SeaPlayer.run function.

ExamplePlugin/__init.py__

from seaplayer.plug import PluginBase

class Plugin(PluginBase):
    def on_run(self) -> None:
        pass

__plugin__ = Plugin

Method on_compose

This method is called after all the interface elements have been arranged SeaPlayer.compose.

A nuance!

It is also important to note that the function is launched via SeaPlayer.run_worker.

ExamplePlugin/__init.py__

from seaplayer.plug import PluginBase

class Plugin(PluginBase):
    async def on_compose(self) -> None: ...
        pass

__plugin__ = Plugin

Method on_ready

The function called after the SeaPlayer is fully started SeaPlayer.on_ready.

ExamplePlugin/__init.py__

class Plugin(PluginBase):
    async def on_ready(self) -> None: ...
        pass

Method on_quit

Called when closing SeaPlayer.on_quit.

ExamplePlugin/__init.py__

class Plugin(PluginBase):
    async def on_quit(self) -> None: ...
        pass