sublime_music.players package

Submodules

• sublime_music.players.base module
• sublime_music.players.chromecast module
• sublime_music.players.manager module
• sublime_music.players.mpv module

Module contents

class sublime_music.players.PlayerDeviceEvent(delta: sublime_music.players.base.PlayerDeviceEvent.Delta, player_type: Type, id: str, name: str)

Bases: object

Parameters

• delta (sublime_music.players.base.PlayerDeviceEvent.Delta) –

• player_type (Type) –

• id (str) –

• name (str) –

Return type

None

class Delta(value)

Bases: enum.Enum

An enumeration.

ADD = 0

REMOVE = 1

__init__(delta, player_type, id, name)

Parameters

• delta (sublime_music.players.base.PlayerDeviceEvent.Delta) –

• player_type (Type) –

• id (str) –

• name (str) –

Return type

None

delta: sublime_music.players.base.PlayerDeviceEvent.Delta

id: str

name: str

player_type: Type

class sublime_music.players.PlayerEvent(type, device_id, playing=None, volume=None, stream_cache_duration=None)

Bases: object

Represents an event triggered by the player. This is a way to signal state changes to Sublime Music if the player can be controlled outside of Sublime Music (for example, Chromecast player).

Each player event has a PlayerEvent.EventType. Additionally, each event type has additional information in the form of additional properties on the PlayerEvent object.

• PlayerEvent.EventType.PLAY_STATE_CHANGE – indicates that the play state of the player has changed. The PlayerEvent.playing property is required for this event type.

• PlayerEvent.EventType.VOLUME_CHANGE – indicates that the player’s volume has changed. The :classs`PlayerEvent.volume` property is required for this event type and should be in the range [0, 100].

• PlayerEvent.EventType.STREAM_CACHE_PROGRESS_CHANGE – indicates that the stream cache progress has changed. When streaming a song, this will be used to show how much of the song has been loaded into the player. The PlayerEvent.stream_cache_duration property is required for this event type and should be a float represent the number of seconds of the song that have been cached.

• PlayerEvent.EventType.CONNECTING – indicates that a device is being connected to. The PlayerEvent.device_id property is required for this event type and indicates the device ID that is being connected to.

• PlayerEvent.EventType.CONNECTED – indicates that a device has been connected to. The PlayerEvent.device_id property is required for this event type and indicates the device ID that has been connected to.

Parameters

• type (sublime_music.players.base.PlayerEvent.EventType) –

• device_id (str) –

• playing (Optional[bool]) –

• volume (Optional[float]) –

• stream_cache_duration (Optional[float]) –

Return type

None

class EventType(value)

Bases: enum.Enum

An enumeration.

CONNECTED = 4

CONNECTING = 3

DISCONNECT = 5

PLAY_STATE_CHANGE = 0

STREAM_CACHE_PROGRESS_CHANGE = 2

VOLUME_CHANGE = 1

__init__(type, device_id, playing=None, volume=None, stream_cache_duration=None)

Parameters

• type (sublime_music.players.base.PlayerEvent.EventType) –

• device_id (str) –

• playing (Optional[bool]) –

• volume (Optional[float]) –

• stream_cache_duration (Optional[float]) –

Return type

None

device_id: str

playing: Optional[bool] = None

stream_cache_duration: Optional[float] = None

type: sublime_music.players.base.PlayerEvent.EventType

volume: Optional[float] = None

class sublime_music.players.PlayerManager(on_timepos_change, on_track_end, on_player_event, player_device_change_callback, config)

Bases: object

Parameters

• on_timepos_change (Callable[[Optional[float]], None]) –

• on_track_end (Callable[[], None]) –

• on_player_event (Callable[[sublime_music.players.base.PlayerEvent], None]) –

• player_device_change_callback (Callable[[sublime_music.players.base.PlayerDeviceEvent], None]) –

• config (Dict[str, Dict[str, Union[Type, Tuple[str, ...]]]]) –

__init__(on_timepos_change, on_track_end, on_player_event, player_device_change_callback, config)

Parameters

• on_timepos_change (Callable[[Optional[float]], None]) –

• on_track_end (Callable[[], None]) –

• on_player_event (Callable[[sublime_music.players.base.PlayerEvent], None]) –

• player_device_change_callback (Callable[[sublime_music.players.base.PlayerDeviceEvent], None]) –

• config (Dict[str, Dict[str, Union[Type, Tuple[str, ...]]]]) –

available_player_types: List[Type] = [<class 'sublime_music.players.mpv.MPVPlayer'>, <class 'sublime_music.players.chromecast.ChromecastPlayer'>]

property can_start_playing_with_no_latency: bool

change_settings(config)

Parameters

config (Dict[str, Dict[str, Union[Type, Tuple[str, ...]]]]) –

property current_device_id: Optional[str]

static get_configuration_options()

Returns

Dictionary of the name of the player -> option configs (see sublime_music.players.base.Player.get_configuration_options for details).

Return type

Dict[str, Dict[str, Union[Type, Tuple[str, …]]]]

get_is_muted()

Return type

bool

get_volume()

Return type

float

next_media_cached(uri, song)

Parameters

• uri (str) –

• song (sublime_music.adapters.api_objects.Song) –

pause()

play_media(uri, progress, song)

Parameters

• uri (str) –

• progress (datetime.timedelta) –

• song (sublime_music.adapters.api_objects.Song) –

property playing: bool

refresh_players()

reset()

seek(position)

Parameters

position (datetime.timedelta) –

set_current_device_id(device_id)

Parameters

device_id (str) –

set_muted(muted)

Parameters

muted (bool) –

set_volume(volume)

Parameters

volume (float) –

shutdown()

property song_loaded: bool

property supported_schemes: Set[str]

toggle_play()