pylav.nodes.api.responses package#
Subpackages#
- pylav.nodes.api.responses.filters package
- Subpackages
- Submodules
- pylav.nodes.api.responses.filters.channel_mix module
- pylav.nodes.api.responses.filters.distortion module
- pylav.nodes.api.responses.filters.equalizer module
- pylav.nodes.api.responses.filters.karaoke module
- pylav.nodes.api.responses.filters.low_pass module
- pylav.nodes.api.responses.filters.misc module
- pylav.nodes.api.responses.filters.rotation module
- pylav.nodes.api.responses.filters.timescale module
- pylav.nodes.api.responses.filters.tremolo module
- pylav.nodes.api.responses.filters.vibrato module
- Module contents
- pylav.nodes.api.responses.plugins package
Submodules#
pylav.nodes.api.responses.errors module#
pylav.nodes.api.responses.exceptions module#
- class pylav.nodes.api.responses.exceptions.LavalinkException(*, severity: "Literal['common', 'suspicious', 'fault']", message: 'str | None' = None, cause: 'str | None' = None)[source]#
Bases:
LoadException
- cause#
pylav.nodes.api.responses.misc module#
- class pylav.nodes.api.responses.misc.Git(*, branch: 'str', commit: 'str', commitTime: 'int')[source]#
Bases:
object
- branch#
- commit#
- commitTime#
pylav.nodes.api.responses.player module#
pylav.nodes.api.responses.playlists module#
- class pylav.nodes.api.responses.playlists.Info(*, name: 'str', selectedTrack: 'int', type: 'NotRequired[str]' = 'playlist', url: 'NotRequired[str | None]' = None, artworkUrl: 'NotRequired[str | None]' = None, author: 'NotRequired[str | None]' = None)[source]#
Bases:
object
- artworkUrl#
- author#
- name#
- selectedTrack#
- type#
- url#
pylav.nodes.api.responses.rest_api module#
- class pylav.nodes.api.responses.rest_api.BaseTrackResponse(*, loadType: "Literal['track', 'playlist', 'search', 'empty', 'error']", data: 'Track | PlaylistData | list[Track] | LoadException | None')[source]#
Bases:
object
- data#
- loadType#
- class pylav.nodes.api.responses.rest_api.EmptyResponse(*, loadType: "Literal['empty']", data: 'None' = None)[source]#
Bases:
BaseTrackResponse
- class pylav.nodes.api.responses.rest_api.ErrorResponse(*, loadType: "Literal['error']", data: 'LoadException')[source]#
Bases:
BaseTrackResponse
- class pylav.nodes.api.responses.rest_api.LavalinkInfo(*, version: 'Version', buildTime: 'int', git: 'Git', jvm: 'str', lavaplayer: 'str', sourceManagers: 'list[str]', filters: 'list[str]', plugins: 'list[Plugin]')[source]#
Bases:
object
- buildTime#
- filters#
- git#
- jvm#
- lavaplayer#
- plugins#
- sourceManagers#
- version#
- class pylav.nodes.api.responses.rest_api.LavalinkPlayer(*, guildId: 'str', volume: 'int', paused: 'bool', state: 'State | dict', voice: 'VoiceState | dict', filters: 'Filters | dict', track: 'Track | dict | None' = None)[source]#
Bases:
object
- filters#
- guildId#
- paused#
- state#
- track#
- voice#
- volume#
- class pylav.nodes.api.responses.rest_api.LoadSearchResponses(*, tracks: 'list[Track]', albums: 'list[PlaylistData]', artists: 'list[PlaylistData]', playlists: 'list[PlaylistData]', plugins: 'PluginInfo', texts: 'list[TextInfo]')[source]#
Bases:
object
- albums#
- artists#
- playlists#
- plugins#
- texts#
- tracks#
- class pylav.nodes.api.responses.rest_api.PlaylistData(*, info: 'Info', pluginInfo: 'PlaylistPluginInfo', tracks: 'list[Track]')[source]#
Bases:
object
- info#
- pluginInfo#
- tracks#
- class pylav.nodes.api.responses.rest_api.PlaylistResponse(*, loadType: "Literal['playlist']", data: 'PlaylistData')[source]#
Bases:
BaseTrackResponse
- class pylav.nodes.api.responses.rest_api.SearchResponse(*, loadType: "Literal['search']", data: 'list[Track]')[source]#
Bases:
BaseTrackResponse
- class pylav.nodes.api.responses.rest_api.Stats(*, players: 'int', playingPlayers: 'int', uptime: 'int', memory: 'Memory', cpu: 'CPU', frameStats: 'Frame | None' = None)[source]#
Bases:
object
- cpu#
- frameStats#
- memory#
- players#
- playingPlayers#
- uptime#
- uptime_seconds#
- class pylav.nodes.api.responses.rest_api.TextInfo(*, text: 'str', plugin: 'PluginInfo')[source]#
Bases:
object
- plugin#
- text#
- class pylav.nodes.api.responses.rest_api.TrackResponse(*, loadType: "Literal['track']", data: 'Track')[source]#
Bases:
BaseTrackResponse
pylav.nodes.api.responses.route_planner module#
- class pylav.nodes.api.responses.route_planner.Details(*, ipBlock: 'IPBlock', failingAddresses: 'list[FailingAddress]', rotateIndex: 'str', ipIndex: 'str', currentAddress: 'str', currentAddressIndex: 'str', blockIndex: 'str')[source]#
Bases:
object
- blockIndex#
- currentAddress#
- currentAddressIndex#
- failingAddresses#
- ipBlock#
- ipIndex#
- rotateIndex#
- class pylav.nodes.api.responses.route_planner.FailingAddress(*, address: 'str', failingTimestamp: 'int', failingTimes: 'str')[source]#
Bases:
object
- address#
- failingTimes#
- failingTimestamp#
pylav.nodes.api.responses.track module#
- class pylav.nodes.api.responses.track.Info(*, identifier: 'str', isSeekable: 'bool', author: 'str', length: 'int', isStream: 'bool', position: 'int', title: 'str', uri: 'str | None', sourceName: 'str | None', artworkUrl: 'str | None' = None, isrc: 'str | None' = None, version: 'NotRequired[int]' = 3)[source]#
Bases:
object
- artworkUrl#
- author#
- identifier#
- isSeekable#
- isStream#
- isrc#
- length#
- position#
- sourceName#
- title#
- uri#
- version#
pylav.nodes.api.responses.websocket module#
- class pylav.nodes.api.responses.websocket.CPU(*, cores: 'int', systemLoad: 'float', lavalinkLoad: 'float')[source]#
Bases:
object
- cores#
- lavalinkLoad#
- systemLoad#
- class pylav.nodes.api.responses.websocket.Closed(*, op: "Literal['event']", type: "Literal['WebSocketClosedEvent']", guildId: 'str', code: 'int', reason: 'str', byRemote: 'bool')[source]#
Bases:
Message
- byRemote#
- code#
- guildId#
- reason#
- type#
- class pylav.nodes.api.responses.websocket.Frame(*, sent: 'int', nulled: 'int', deficit: 'int')[source]#
Bases:
object
- deficit#
- nulled#
- sent#
- class pylav.nodes.api.responses.websocket.Memory(*, free: 'int', allocated: 'int', reservable: 'int', used: 'int')[source]#
Bases:
object
- allocated#
- free#
- reservable#
- used#
- class pylav.nodes.api.responses.websocket.PlayerUpdate(*, op: 'str', guildId: 'str', state: 'State')[source]#
Bases:
Message
- guildId#
- state#
- class pylav.nodes.api.responses.websocket.Ready(*, op: 'str', sessionId: 'str', resumed: 'bool')[source]#
Bases:
Message
- resumed#
- sessionId#
- class pylav.nodes.api.responses.websocket.Stats(*, op: 'str', players: 'int', playingPlayers: 'int', uptime: 'int', memory: 'Memory', cpu: 'CPU', frameStats: 'Frame | None' = None)[source]#
Bases:
Message
- cpu#
- frameStats#
- memory#
- players#
- playingPlayers#
- uptime#
- uptime_seconds#
- class pylav.nodes.api.responses.websocket.TrackEnd(*, op: "Literal['event']", type: "Literal['TrackEndEvent']", guildId: 'str', track: 'Track', reason: "Literal['finished', 'loadFailed', 'stopped', 'replaced', 'cleanup']")[source]#
Bases:
Message
- guildId#
- reason#
- track#
- type#
- class pylav.nodes.api.responses.websocket.TrackException(*, op: "Literal['event']", type: "Literal['TrackExceptionEvent']", guildId: 'str', track: 'Track', exception: 'TrackExceptionClass')[source]#
Bases:
Message
- exception#
- guildId#
- track#
- type#