sublime_music.adapters.subsonic.api_objects module

These are the API objects that are returned by Subsonic.

class sublime_music.adapters.subsonic.api_objects.Album(name: str, id: Optional[str], cover_art: Optional[str] = None, song_count: Optional[int] = None, year: Optional[int] = None, duration: Optional[datetime.timedelta] = None, created: Optional[datetime.datetime] = None, songs: List[ForwardRef('Song')] = <factory>, play_count: Optional[int] = None, starred: Optional[datetime.datetime] = None, _artist: Optional[str] = None, artist_id: Optional[str] = None, _genre: Optional[str] = None)[source]

Bases: sublime_music.adapters.api_objects.Album

Parameters
Return type

None

__init__(name, id, cover_art=None, song_count=None, year=None, duration=None, created=None, songs=<factory>, play_count=None, starred=None, _artist=None, artist_id=None, _genre=None)
Parameters
Return type

None

artist: Optional[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo]
artist_id: Optional[str] = None
cover_art: Optional[str] = None
created: Optional[datetime.datetime] = None
dataclass_json_config = {'letter_case': <function camelcase>}
duration: Optional[datetime.timedelta] = None
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

genre: Optional[sublime_music.adapters.subsonic.api_objects.Genre]
id: Optional[str]
name: str
play_count: Optional[int] = None
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

song_count: Optional[int] = None
songs: List[sublime_music.adapters.subsonic.api_objects.Song]
starred: Optional[datetime.datetime] = None
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

year: Optional[int] = None
class sublime_music.adapters.subsonic.api_objects.AlbumList2(album: List[sublime_music.adapters.subsonic.api_objects.Album] = <factory>)[source]

Bases: object

Parameters

album (List[sublime_music.adapters.subsonic.api_objects.Album]) –

Return type

None

__init__(album=<factory>)
Parameters

album (List[sublime_music.adapters.subsonic.api_objects.Album]) –

Return type

None

album: List[sublime_music.adapters.subsonic.api_objects.Album]
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo(name: str, id: Optional[str], albums: List[sublime_music.adapters.subsonic.api_objects.Album] = <factory>, album_count: Optional[int] = None, cover_art: Optional[str] = None, artist_image_url: Optional[str] = None, starred: Optional[datetime.datetime] = None, similar_artists: List[ForwardRef('ArtistAndArtistInfo')] = <factory>, biography: Optional[str] = None, music_brainz_id: Optional[str] = None, last_fm_url: Optional[str] = None)[source]

Bases: sublime_music.adapters.api_objects.Artist

Parameters
Return type

None

__init__(name, id, albums=<factory>, album_count=None, cover_art=None, artist_image_url=None, starred=None, similar_artists=<factory>, biography=None, music_brainz_id=None, last_fm_url=None)
Parameters
Return type

None

album_count: Optional[int] = None
albums: List[sublime_music.adapters.subsonic.api_objects.Album]
artist_image_url: Optional[str] = None
augment_with_artist_info(artist_info)[source]
Parameters

artist_info (Optional[sublime_music.adapters.subsonic.api_objects.ArtistInfo]) –

biography: Optional[str] = None
cover_art: Optional[str] = None
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

id: Optional[str]
last_fm_url: Optional[str] = None
music_brainz_id: Optional[str] = None
name: str
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

starred: Optional[datetime.datetime] = None
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.ArtistInfo(similar_artists: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo] = <factory>, biography: Optional[str] = None, last_fm_url: Optional[str] = None, artist_image_url: Optional[str] = None, music_brainz_id: Optional[str] = None)[source]

Bases: object

Parameters
Return type

None

__init__(similar_artists=<factory>, biography=None, last_fm_url=None, artist_image_url=None, music_brainz_id=None)
Parameters
Return type

None

artist_image_url: Optional[str] = None
biography: Optional[str] = None
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

last_fm_url: Optional[str] = None
music_brainz_id: Optional[str] = None
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

similar_artists: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo]
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.ArtistsID3(ignored_articles: Optional[str] = None, index: List[sublime_music.adapters.subsonic.api_objects.IndexID3] = <factory>)[source]

Bases: object

Parameters
Return type

None

__init__(ignored_articles=None, index=<factory>)
Parameters
Return type

None

dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

ignored_articles: Optional[str] = None
index: List[sublime_music.adapters.subsonic.api_objects.IndexID3]
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Directory(id: str, name: Optional[str] = None, title: Optional[str] = None, parent_id: Optional[str] = None, _children: List[Dict[str, Any]] = <factory>)[source]

Bases: sublime_music.adapters.api_objects.Directory, dataclasses_json.api.DataClassJsonMixin

Parameters
Return type

None

__init__(id, name=None, title=None, parent_id=None, _children=<factory>)
Parameters
Return type

None

children: List[Union[sublime_music.adapters.subsonic.api_objects.Directory, sublime_music.adapters.subsonic.api_objects.Song]]
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

id: str
name: Optional[str] = None
parent_id: Optional[str] = None
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

title: Optional[str] = None
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Genre(name: str, song_count: Optional[int] = None, album_count: Optional[int] = None)[source]

Bases: sublime_music.adapters.api_objects.Genre

Parameters
Return type

None

__init__(name, song_count=None, album_count=None)
Parameters
Return type

None

album_count: Optional[int] = None
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

name: str
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

song_count: Optional[int] = None
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Genres(genre: List[sublime_music.adapters.subsonic.api_objects.Genre] = <factory>)[source]

Bases: object

Parameters

genre (List[sublime_music.adapters.subsonic.api_objects.Genre]) –

Return type

None

__init__(genre=<factory>)
Parameters

genre (List[sublime_music.adapters.subsonic.api_objects.Genre]) –

Return type

None

dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

genre: List[sublime_music.adapters.subsonic.api_objects.Genre]
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Index(name: str, artist: List[Dict[str, Any]] = <factory>)[source]

Bases: object

Parameters
Return type

None

__init__(name, artist=<factory>)
Parameters
Return type

None

artist: List[Dict[str, Any]]
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

name: str
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.IndexID3(name: str, artist: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo] = <factory>)[source]

Bases: object

Parameters
Return type

None

__init__(name, artist=<factory>)
Parameters
Return type

None

artist: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo]
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

name: str
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Indexes(ignored_articles: Optional[str] = None, index: List[sublime_music.adapters.subsonic.api_objects.Index] = <factory>)[source]

Bases: object

Parameters
Return type

None

__init__(ignored_articles=None, index=<factory>)
Parameters
Return type

None

dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

ignored_articles: Optional[str] = None
index: List[sublime_music.adapters.subsonic.api_objects.Index]
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.PlayQueue(songs: List[sublime_music.adapters.subsonic.api_objects.Song] = <factory>, position: datetime.timedelta = datetime.timedelta(0), username: Optional[str] = None, changed: Optional[datetime.datetime] = None, changed_by: Optional[str] = None, value: Optional[str] = None, current: Optional[str] = None, current_index: Optional[int] = None)[source]

Bases: sublime_music.adapters.api_objects.PlayQueue

Parameters
Return type

None

__init__(songs=<factory>, position=datetime.timedelta(0), username=None, changed=None, changed_by=None, value=None, current=None, current_index=None)
Parameters
Return type

None

changed: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
current: Optional[str] = None
current_index: Optional[int] = None
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

position: datetime.timedelta = datetime.timedelta(0)
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

songs: List[sublime_music.adapters.subsonic.api_objects.Song]
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

username: Optional[str] = None
value: Optional[str] = None
class sublime_music.adapters.subsonic.api_objects.Playlist(id: str, name: str, songs: List[sublime_music.adapters.subsonic.api_objects.Song] = <factory>, song_count: Optional[int] = None, duration: Optional[datetime.timedelta] = None, created: Optional[datetime.datetime] = None, changed: Optional[datetime.datetime] = None, comment: Optional[str] = None, owner: Optional[str] = None, public: Optional[bool] = None, cover_art: Optional[str] = None)[source]

Bases: sublime_music.adapters.api_objects.Playlist

Parameters
Return type

None

__init__(id, name, songs=<factory>, song_count=None, duration=None, created=None, changed=None, comment=None, owner=None, public=None, cover_art=None)
Parameters
Return type

None

changed: Optional[datetime.datetime] = None
comment: Optional[str] = None
cover_art: Optional[str] = None
created: Optional[datetime.datetime] = None
dataclass_json_config = {'letter_case': <function camelcase>}
duration: Optional[datetime.timedelta] = None
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

id: str
name: str
owner: Optional[str] = None
public: Optional[bool] = None
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

song_count: Optional[int] = None
songs: List[sublime_music.adapters.subsonic.api_objects.Song]
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Playlists(playlist: List[sublime_music.adapters.subsonic.api_objects.Playlist] = <factory>)[source]

Bases: object

Parameters

playlist (List[sublime_music.adapters.subsonic.api_objects.Playlist]) –

Return type

None

__init__(playlist=<factory>)
Parameters

playlist (List[sublime_music.adapters.subsonic.api_objects.Playlist]) –

Return type

None

dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

playlist: List[sublime_music.adapters.subsonic.api_objects.Playlist]
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Response(artists=None, artist=None, artist_info=None, albums=None, album=None, directory=None, genres=None, indexes=None, playlist=None, playlists=None, play_queue=None, song=None, search_result=None)[source]

Bases: dataclasses_json.api.DataClassJsonMixin

The base Subsonic response object.

Parameters
Return type

None

__init__(artists=None, artist=None, artist_info=None, albums=None, album=None, directory=None, genres=None, indexes=None, playlist=None, playlists=None, play_queue=None, song=None, search_result=None)
Parameters
Return type

None

album: Optional[sublime_music.adapters.subsonic.api_objects.Album] = None
albums: Optional[sublime_music.adapters.subsonic.api_objects.AlbumList2] = None
artist: Optional[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo] = None
artist_info: Optional[sublime_music.adapters.subsonic.api_objects.ArtistInfo] = None
artists: Optional[sublime_music.adapters.subsonic.api_objects.ArtistsID3] = None
directory: Optional[sublime_music.adapters.subsonic.api_objects.Directory] = None
genres: Optional[sublime_music.adapters.subsonic.api_objects.Genres] = None
indexes: Optional[sublime_music.adapters.subsonic.api_objects.Indexes] = None
play_queue: Optional[sublime_music.adapters.subsonic.api_objects.PlayQueue] = None
playlist: Optional[sublime_music.adapters.subsonic.api_objects.Playlist] = None
playlists: Optional[sublime_music.adapters.subsonic.api_objects.Playlists] = None
search_result: Optional[sublime_music.adapters.subsonic.api_objects.SearchResult3] = None
song: Optional[sublime_music.adapters.subsonic.api_objects.Song] = None
class sublime_music.adapters.subsonic.api_objects.SearchResult3(artist: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo] = <factory>, album: List[sublime_music.adapters.subsonic.api_objects.Album] = <factory>, song: List[sublime_music.adapters.subsonic.api_objects.Song] = <factory>)[source]

Bases: object

Parameters
Return type

None

__init__(artist=<factory>, album=<factory>, song=<factory>)
Parameters
Return type

None

album: List[sublime_music.adapters.subsonic.api_objects.Album]
artist: List[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo]
dataclass_json_config = {'letter_case': <function camelcase>}
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

song: List[sublime_music.adapters.subsonic.api_objects.Song]
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

class sublime_music.adapters.subsonic.api_objects.Song(id: str, title: str, path: Optional[str] = None, parent_id: Optional[str] = None, duration: Optional[datetime.timedelta] = None, _artist: Optional[str] = None, artist_id: Optional[str] = None, _album: Optional[str] = None, album_id: Optional[str] = None, _genre: Optional[str] = None, track: Optional[int] = None, disc_number: Optional[int] = None, year: Optional[int] = None, size: Optional[int] = None, cover_art: Optional[str] = None, user_rating: Optional[int] = None, starred: Optional[datetime.datetime] = None)[source]

Bases: sublime_music.adapters.api_objects.Song, dataclasses_json.api.DataClassJsonMixin

Parameters
Return type

None

__init__(id, title, path=None, parent_id=None, duration=None, _artist=None, artist_id=None, _album=None, album_id=None, _genre=None, track=None, disc_number=None, year=None, size=None, cover_art=None, user_rating=None, starred=None)
Parameters
Return type

None

album: Optional[sublime_music.adapters.subsonic.api_objects.Album]
album_id: Optional[str] = None
artist: Optional[sublime_music.adapters.subsonic.api_objects.ArtistAndArtistInfo]
artist_id: Optional[str] = None
cover_art: Optional[str] = None
dataclass_json_config = {'letter_case': <function camelcase>}
disc_number: Optional[int] = None
duration: Optional[datetime.timedelta] = None
classmethod from_dict(kvs, *, infer_missing=False)
Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)
Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

genre: Optional[sublime_music.adapters.subsonic.api_objects.Genre]
id: str
parent_id: Optional[str] = None
path: Optional[str] = None
classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
Parameters

  • infer_missing (bool) –

  • many (bool) –

  • partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

size: Optional[int] = None
starred: Optional[datetime.datetime] = None
title: str
to_dict(encode_json=False)
Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)
Parameters
Return type

str

track: Optional[int] = None
user_rating: Optional[int] = None
year: Optional[int] = None
sublime_music.adapters.subsonic.api_objects.translation_function(t)