pylav.nodes.api.responses package#

Subpackages#

Submodules#

pylav.nodes.api.responses.errors module#

class pylav.nodes.api.responses.errors.LavalinkError(*, timestamp: 'int | datetime', status: 'int', error: 'str', message: 'str', path: 'str', trace: 'str | None' = None)[source]#

Bases: object

error#
message#
path#
status#
timestamp#
trace#

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#
class pylav.nodes.api.responses.exceptions.LoadException(*, severity: "Literal['common', 'suspicious', 'fault']", message: 'str | None' = None)[source]#

Bases: object

message#
severity#

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#
class pylav.nodes.api.responses.misc.Plugin(*, name: 'str', version: 'str')[source]#

Bases: object

name#
version#
class pylav.nodes.api.responses.misc.Version(*, semver: 'str', major: 'int', minor: 'int', patch: 'int', preRelease: 'str | None' = None)[source]#

Bases: object

major#
minor#
patch#
preRelease#
semver#

pylav.nodes.api.responses.player module#

class pylav.nodes.api.responses.player.State(*, time: 'int', connected: 'bool', ping: 'int', position: 'int | None' = 0)[source]#

Bases: object

connected#
ping#
position#
time#
to_dict()[source]#

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#
to_dict()[source]#
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#
to_dict()[source]#
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#
to_dict()[source]#
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#
to_dict()[source]#
tracks#
class pylav.nodes.api.responses.rest_api.PlaylistData(*, info: 'Info', pluginInfo: 'PlaylistPluginInfo', tracks: 'list[Track]')[source]#

Bases: object

info#
pluginInfo#
to_dict()[source]#
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

class pylav.nodes.api.responses.rest_api.VoiceState(*, token: 'str', endpoint: 'str', sessionId: 'str')[source]#

Bases: object

endpoint#
sessionId#
to_dict()[source]#
token#

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#
class pylav.nodes.api.responses.route_planner.IPBlock(*, type: "Literal['Inet4Address', 'Inet6Address']", size: 'str')[source]#

Bases: object

size#
type#
class pylav.nodes.api.responses.route_planner.Status(*, details: 'Details | None', type: "Literal['RotatingIpRoutePlanner', 'NanoIpRoutePlanner', 'RotatingNanoIpRoutePlanner'] | None" = None)[source]#

Bases: object

details#
type#

pylav.nodes.api.responses.shared module#

class pylav.nodes.api.responses.shared.PlaylistPluginInfo(*, kwargs: 'InitVar[_JSON_DICT_TYPE | None]' = None)[source]#

Bases: PluginInfo

artworkUrl#
author#
identifier#
type#
url#
class pylav.nodes.api.responses.shared.PluginInfo(*, kwargs: 'InitVar[_JSON_DICT_TYPE | None]' = None)[source]#

Bases: object

kwargs = None#
to_dict()[source]#
class pylav.nodes.api.responses.shared.TrackPluginInfo(*, kwargs: 'InitVar[_JSON_DICT_TYPE | None]' = None)[source]#

Bases: PluginInfo

probeInfo#

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#
to_dict()[source]#
uri#
version#
class pylav.nodes.api.responses.track.Track(*, info: 'Info', encoded: 'str' = None, pluginInfo: 'TrackPluginInfo | None' = None)[source]#

Bases: object

encoded#
info#
pluginInfo#
set_version(version)[source]#
to_database()[source]#
to_dict()[source]#

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.Message(*, op: 'str')[source]#

Bases: object

op#
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#
class pylav.nodes.api.responses.websocket.TrackStart(*, op: "Literal['event']", type: "Literal['TrackStartEvent']", guildId: 'str', track: 'Track')[source]#

Bases: Message

guildId#
track#
type#
class pylav.nodes.api.responses.websocket.TrackStuck(*, op: "Literal['event']", type: "Literal['TrackStuckEvent']", guildId: 'str', track: 'Track', thresholdMs: 'int')[source]#

Bases: Message

guildId#
thresholdMs#
track#
type#

Module contents#