.. currentmodule:: sonolink

REST API
========


Filter payloads
---------------

.. autoclass:: sonolink.rest.schemas.PlayerFilters
   :members:
   

.. autoclass:: sonolink.rest.schemas.EqualizerFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.KaraokeFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.TimescaleFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.TremoloFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.VibratoFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.RotationFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.DistortionFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.ChannelMixFilter
   :members:
   

.. autoclass:: sonolink.rest.schemas.LowPassFilter
   :members:
   

Info payloads
-------------

.. autoclass:: sonolink.rest.schemas.InfoResponse
   :members:
   

.. autoclass:: sonolink.rest.schemas.VersionObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.GitObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.PluginObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.MemoryObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.CPUObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.FrameStatsObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.StatsResponse
   :members:
   

.. autodata:: sonolink.rest.schemas.VersionResponse

Route planner payloads
----------------------

.. autoclass:: sonolink.rest.schemas.DetailsObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.IPBlockObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.FailingAddressObject
   :members:
   

.. autoclass:: sonolink.rest.schemas.RoutePlannerStatusResponse
   :members:
   

.. autoclass:: sonolink.rest.schemas.UnmarkFailedAddressRequest
   :members:
   

Player payloads
---------------

.. autoclass:: sonolink.rest.schemas.Player
   :members:
   

.. autoclass:: sonolink.rest.schemas.PlayerState
   :members:
   

.. autoclass:: sonolink.rest.schemas.PlayerVoiceState
   :members:
   

.. autoclass:: sonolink.rest.schemas.UpdatePlayerTrackRequest
   :members:
   

.. autoclass:: sonolink.rest.schemas.UpdatePlayerRequest
   :members:
   

.. autodata:: sonolink.rest.schemas.GetPlayersResponse

.. autodata:: sonolink.rest.schemas.GetPlayerResponse

.. autodata:: sonolink.rest.schemas.UpdatePlayerResponse

.. autodata:: sonolink.rest.schemas.DestroyPlayerResponse

Playlist and session payloads
-----------------------------

.. autoclass:: sonolink.rest.schemas.PlaylistInfo
   :members:
   

.. autoclass:: sonolink.rest.schemas.UpdateSessionRequest
   :members:
   

Track payloads
--------------

.. autoclass:: sonolink.rest.schemas.TrackInfo
   :members:
   

.. autoclass:: sonolink.rest.schemas.Track
   :members:
   

.. autoclass:: sonolink.rest.schemas.TrackLoadingResponse
   :members:
   

.. autoclass:: sonolink.rest.schemas.PlaylistData
   :members:
   

.. autodata:: sonolink.rest.schemas.TrackDecodeResponse

.. autodata:: sonolink.rest.schemas.TracksDecodeResponse