Documentation

Welcome to the documentation for OpenMusic! There are 3 sections:

1. declarations.txt versions
2. OpenMusicClient
3. OpenMusic

Declarations

As of right now, there is only one version of declarations.txt - 0.1. Here is the format:

0.1 [API version number]
(plugin name)
(plugin author)
(plugin's own version NOT api version)
(plugin image url, must be relative)
(y/n) [does the plugin modify OpenMusic's behavior?]
(y/n) [does the plugin modify OpenMusic's look/is there a .qss file?]
(dependencies) [python package dependencies, separated by spaces]

Client

class OpenMusicClient
    __init__(self, **kwargs) -> None
        # Called to instantiate client. **kwargs is the following payload:
{
            "app": app,
            "os_player": osPlayer,
            "main_gui": mainGui,
            "classes": {
                "Playlist": Playlist,
                "OSPlayer": OSPlayer,
                "MainGui": MainGui,
                "GlobalUpdater": GlobalUpdater,
                "RightMenu": RightMenu,
                "LeftMenu": LeftMenu,
                "PlaylistMenu": PlaylistMenu,
                "SongMenu": SongMenu,
                "PlaylistEditor": PlaylistEditor,
                "SongEditor": SongEditor,
                "CenterScrollArea": CenterScrollArea,
                "FullPlaylistDisplay": FullPlaylistDisplay,
                "PlaylistBlock": PlaylistBlock,
                "SongBlock": SongBlock
            },
            "statics": {
                "FileHandler": FileHandler,
                "Songs": Songs
            }
        }


    timer_update(self) -> None
        # Called every 50ms by QTimer

    on_launch(self) -> None
        # Called after everything is loaded in

OpenMusic

To view this, go to this page