.. _api:

API Reference
=============

`tidalapi.session`
------------------

.. automodule:: tidalapi.session

.. autoclass:: Session
    :members:
    :undoc-members:

.. autoclass:: Config
    :members:
    :undoc-members:

.. autoclass:: Quality
    :members:
    :undoc-members:

.. autoclass:: VideoQuality
    :members:
    :undoc-members:

.. autoclass:: LinkLogin
    :members:
    :undoc-members:

`tidalapi.artist`
-----------------

.. automodule:: tidalapi.artist

.. autoclass:: Artist
    :members:
    :undoc-members:


`tidalapi.user`
---------------

.. automodule:: tidalapi.user

.. autoclass:: User
    :members:
    :undoc-members:

.. autoclass:: FetchedUser
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: LoggedInUser
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: PlaylistCreator
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: Favorites
    :members:
    :undoc-members:


`tidalapi.playlist`
-------------------

.. automodule:: tidalapi.playlist

.. autoclass:: Playlist
    :members:
    :undoc-members:

.. autoclass:: UserPlaylist
    :members:
    :undoc-members:
    :show-inheritance:

`tidalapi.album`
----------------

.. automodule:: tidalapi.album

.. autoclass:: Album
    :members:
    :undoc-members:


`tidalapi.media`
----------------

.. automodule:: tidalapi.media

.. autoclass:: Media
    :members:
    :undoc-members:

.. autoclass:: Track
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: Video
    :members:
    :undoc-members:
    :show-inheritance:

`tidalapi.genre`
----------------

.. automodule:: tidalapi.genre

.. autoclass:: Genre
    :members:
    :undoc-members:

`tidalapi.page`
---------------

.. automodule:: tidalapi.page

.. autoclass:: Page
    :members:
    :undoc-members:

.. autoclass:: PageCategory
    :members:
    :undoc-members:

.. autoclass:: FeaturedItems
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: PageLinks
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: ItemList
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: PageItem
    :members:
    :undoc-members:

.. autoclass:: PageLink
    :members:
    :undoc-members:

`tidalapi.mix`
---------------

.. automodule:: tidalapi.mix

.. autoclass:: MixType
    :members:
    :undoc-members:

.. autoclass:: Mix
    :members:
    :undoc-members: