sublime_music.app module

class sublime_music.app.SublimeMusicApp(config_file)

Bases: gi.repository.Gtk.Application

Parameters

config_file (pathlib.Path) –

__init__(config_file)

Parameters

config_file (pathlib.Path) –

batch_download_jobs: Set[sublime_music.adapters.manager.Result] = {}

browse_to(action, item_id)

Parameters

• action (Any) –

• item_id (gi.overrides.GLib.Variant) –

do_activate()

activate(self)

do_dbus_register(connection, path)

dbus_register(self, connection:Gio.DBusConnection, object_path:str) -> bool

Parameters

• connection (gi.repository.Gio.DBusConnection) –

• path (str) –

Return type

bool

do_startup()

startup(self)

exiting: bool = False

on_add_new_music_provider(*args)

on_add_to_queue(action, song_ids)

Parameters

• action (Any) –

• song_ids (gi.overrides.GLib.Variant) –

on_app_shutdown(app)

Parameters

app (sublime_music.app.SublimeMusicApp) –

on_current_song_rated(_)

on_dbus_method_call(connection, sender, path, interface, method, params, invocation)

Parameters

• connection (gi.repository.Gio.DBusConnection) –

• sender (str) –

• path (str) –

• interface (str) –

• method (str) –

• params (gi.overrides.GLib.Variant) –

• invocation (gi.repository.Gio.DBusMethodInvocation) –

on_dbus_set_property(connection, sender, path, interface, property_name, value)

Parameters

• connection (gi.repository.Gio.DBusConnection) –

• sender (str) –

• path (str) –

• interface (str) –

• property_name (str) –

• value (gi.overrides.GLib.Variant) –

on_device_update(_, device_id)

Parameters

device_id (str) –

on_edit_current_music_provider(*args)

on_go_online(*args)

on_go_to_album(action, album_id)

Parameters

• action (Any) –

• album_id (gi.overrides.GLib.Variant) –

on_go_to_artist(action, artist_id)

Parameters

• action (Any) –

• artist_id (gi.overrides.GLib.Variant) –

on_go_to_playlist(action, playlist_id)

Parameters

• action (Any) –

• playlist_id (gi.overrides.GLib.Variant) –

on_mute_toggle(*args)

on_next_track(*args)

on_notification_closed(_)

on_play_next(action, song_ids)

Parameters

• action (Any) –

• song_ids (gi.overrides.GLib.Variant) –

on_play_pause(*args)

on_prev_track(*args)

on_refresh_devices(*args)

on_refresh_window(_, state_updates, force=False)

Parameters

• state_updates (Dict[str, Any]) –

• force (bool) –

on_remove_music_provider(_, provider_id)

Parameters

provider_id (gi.overrides.GLib.Variant) –

on_repeat_press(*args)

on_shuffle_press(*args)

on_song_clicked(win, song_index, song_queue, metadata)

Parameters

• win (Any) –

• song_index (int) –

• song_queue (Tuple[str, ...]) –

• metadata (Dict[str, Any]) –

on_song_download_progress(song_id, progress)

Parameters

• song_id (str) –

• progress (sublime_music.adapters.manager.DownloadProgress) –

on_song_scrub(_, scrub_value)

Parameters

scrub_value (float) –

on_songs_removed(win, song_indexes_to_remove)

Parameters

• win (Any) –

• song_indexes_to_remove (List[int]) –

on_stack_change(stack, _)

Parameters

stack (gi.repository.Gtk.Stack) –

on_switch_music_provider(_, provider_id)

Parameters

provider_id (gi.overrides.GLib.Variant) –

on_volume_change(_, value)

Parameters

value (float) –

on_window_go_to(win, action, value)

Parameters

• win (Any) –

• action (str) –

• value (str) –

on_window_key_press(window, event)

Parameters

• window (gi.overrides.Gtk.Window) –

• event (gi.overrides.Gdk.EventKey) –

Return type

bool

play_song(song_index, reset=False, old_play_queue=None, play_queue=None, playable_song_search_direction=1)

Parameters

• song_index (int) –

• reset (bool) –

• old_play_queue (Optional[Tuple[str, ...]]) –

• play_queue (Optional[Tuple[str, ...]]) –

• playable_song_search_direction (int) –

player_manager: sublime_music.players.manager.PlayerManager

reset_state()

save_play_queue(song_playing_order_token=None)

Parameters

song_playing_order_token (Optional[int]) –

show_configure_servers_dialog(provider_config=None)

Show the Connect to Server dialog.

Parameters

provider_config (Optional[sublime_music.config.ProviderConfiguration]) –

song_playing_order_token = 0

update_play_state_from_server(prompt_confirm=False)

Parameters

prompt_confirm (bool) –

update_window(force=False)

Parameters

force (bool) –