Supporting types

Type Aliases:

• DateOrYear –

  A Date or Year.

• DistinctField –

  Field name for get_distinct.

• Query –

  A query mapping field names to lists of QueryValue.

• QueryField –

  A superset of all field names that can be used in any query.

• QueryValue –

  A single query value; either a string or an integer.

• SearchField –

  Field name for search.

• SearchQuery –

  A search query mapping SearchField names

• TracklistField –

  A field name that can be used in a tracklist query.

Classes:

• PlaybackState –

  Enum of playback states.

Attributes:

• Date –

  A date string on the form YYYY-MM-DD.

• DurationMs –

  A duration in milliseconds.

• Percentage –

  An integer in the range 0-100 representing a percentage.

• TracklistId –

  A unique integer ID for a tracklist item.

• Uri –

  A URI string identifying a resource, e.g. a track or stream.

• UriScheme –

  The scheme part of a URI, e.g. spotify or file.

• Year –

  A year string on the form YYYY.

Date = NewType('Date', str)

DurationMs = NewType('DurationMs', int)

Percentage = NewType('Percentage', int)

TracklistId = NewType('TracklistId', int)

Uri = NewType('Uri', str)

UriScheme = NewType('UriScheme', str)

Year = NewType('Year', str)

DateOrYear = Date | Year

DistinctField = Literal[
    "uri",
    "track_name",
    "album",
    "artist",
    "albumartist",
    "composer",
    "performer",
    "track_no",
    "genre",
    "date",
    "comment",
    "disc_no",
    "musicbrainz_albumid",
    "musicbrainz_artistid",
    "musicbrainz_trackid",
]

Query[F] = dict[F, Iterable[QueryValue]]

QueryField = DistinctField | SearchField | TracklistField

QueryValue = str | int

SearchField = DistinctField | Literal['any']

SearchQuery = dict[SearchField, Iterable[QueryValue]]

TracklistField = Literal[
    "tlid", "uri", "name", "genre", "comment", "musicbrainz_id"
]

PAUSED = 'paused'

PLAYING = 'playing'

STOPPED = 'stopped'