bauiv1lib.soundtrack package

Submodules

bauiv1lib.soundtrack.browser module

Provides UI for browsing soundtracks.

class bauiv1lib.soundtrack.browser.SoundtrackBrowserWindow(transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for browsing soundtracks.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this specific window.

Used to gracefully return to a window from another window or ui system.

main_window_should_preserve_selection() → bool

Whether this window should auto-save/restore selection.

If enabled, selection will be stored in the window’s shared state. See get_main_window_shared_state_id() for more info about main-window shared-state.

The default value of None results in a warning to explicitly override this (as the implicit default will change from False to True after api 9 support ends).

on_main_window_close() → None

Called before transitioning out a main window.

A good opportunity to save window state/etc.

bauiv1lib.soundtrack.edit module

Provides UI for editing a soundtrack.

class bauiv1lib.soundtrack.edit.SoundtrackEditWindow(existing_soundtrack: str | dict[str, Any] | None, transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for editing a soundtrack.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this specific window.

Used to gracefully return to a window from another window or ui system.

main_window_should_preserve_selection() → bool

Whether this window should auto-save/restore selection.

If enabled, selection will be stored in the window’s shared state. See get_main_window_shared_state_id() for more info about main-window shared-state.

The default value of None results in a warning to explicitly override this (as the implicit default will change from False to True after api 9 support ends).

bauiv1lib.soundtrack.entrytypeselect module

Provides UI for selecting soundtrack entry types.

class bauiv1lib.soundtrack.entrytypeselect.SoundtrackEntryTypeSelectWindow(callback: Callable[[Any], Any], current_entry: Any, selection_target_name: str, *, transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for selecting a soundtrack entry type.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this specific window.

Used to gracefully return to a window from another window or ui system.

main_window_should_preserve_selection() → bool

Whether this window should auto-save/restore selection.

If enabled, selection will be stored in the window’s shared state. See get_main_window_shared_state_id() for more info about main-window shared-state.

The default value of None results in a warning to explicitly override this (as the implicit default will change from False to True after api 9 support ends).

bauiv1lib.soundtrack.macmusicapp module

UI functionality related to using the macOS Music app for soundtracks.

class bauiv1lib.soundtrack.macmusicapp.MacMusicAppPlaylistSelectWindow(callback: Callable[[Any], Any], existing_playlist: str | None, existing_entry: Any, *, transition: str | None = 'in_right', origin_widget: Widget | None = None)

Bases: MainWindow

Window for selecting an iTunes playlist.

get_main_window_state() → MainWindowState

Return a WindowState to recreate this specific window.

Used to gracefully return to a window from another window or ui system.

main_window_should_preserve_selection() → bool

Whether this window should auto-save/restore selection.

If enabled, selection will be stored in the window’s shared state. See get_main_window_shared_state_id() for more info about main-window shared-state.

The default value of None results in a warning to explicitly override this (as the implicit default will change from False to True after api 9 support ends).