pylav.nodes.api.responses package

Subpackages

• pylav.nodes.api.responses.filters package
  • Subpackages
    • pylav.nodes.api.responses.filters.plugins package
      • Submodules
      • pylav.nodes.api.responses.filters.plugins.echo module
      • Module contents
  • Submodules
  • pylav.nodes.api.responses.filters.channel_mix module
    • ChannelMix
      • ChannelMix.leftToLeft
      • ChannelMix.leftToRight
      • ChannelMix.rightToLeft
      • ChannelMix.rightToRight
      • ChannelMix.to_dict()
  • pylav.nodes.api.responses.filters.distortion module
    • Distortion
      • Distortion.cosOffset
      • Distortion.cosScale
      • Distortion.offset
      • Distortion.scale
      • Distortion.sinOffset
      • Distortion.sinScale
      • Distortion.tanOffset
      • Distortion.tanScale
      • Distortion.to_dict()
  • pylav.nodes.api.responses.filters.equalizer module
    • EqualizerBand
      • EqualizerBand.band
      • EqualizerBand.gain
      • EqualizerBand.to_dict()
  • pylav.nodes.api.responses.filters.karaoke module
    • Karaoke
      • Karaoke.filterBand
      • Karaoke.filterWidth
      • Karaoke.level
      • Karaoke.monoLevel
      • Karaoke.to_dict()
  • pylav.nodes.api.responses.filters.low_pass module
    • LowPass
      • LowPass.smoothing
      • LowPass.to_dict()
  • pylav.nodes.api.responses.filters.misc module
    • ValueRange
      • ValueRange.max
      • ValueRange.min
      • ValueRange.validate_value()
    • ValueRangeList
      • ValueRangeList.max
      • ValueRangeList.min
      • ValueRangeList.validate_value()
  • pylav.nodes.api.responses.filters.rotation module
    • Rotation
      • Rotation.rotationHz
      • Rotation.to_dict()
  • pylav.nodes.api.responses.filters.timescale module
    • Timescale
      • Timescale.pitch
      • Timescale.rate
      • Timescale.speed
      • Timescale.to_dict()
  • pylav.nodes.api.responses.filters.tremolo module
    • Tremolo
      • Tremolo.depth
      • Tremolo.frequency
      • Tremolo.to_dict()
  • pylav.nodes.api.responses.filters.vibrato module
    • Vibrato
      • Vibrato.depth
      • Vibrato.frequency
      • Vibrato.to_dict()
  • Module contents
    • ChannelMix
      • ChannelMix.leftToLeft
      • ChannelMix.leftToRight
      • ChannelMix.rightToLeft
      • ChannelMix.rightToRight
      • ChannelMix.to_dict()
    • Distortion
      • Distortion.cosOffset
      • Distortion.cosScale
      • Distortion.offset
      • Distortion.scale
      • Distortion.sinOffset
      • Distortion.sinScale
      • Distortion.tanOffset
      • Distortion.tanScale
      • Distortion.to_dict()
    • Echo
      • Echo.decay
      • Echo.delay
      • Echo.to_dict()
    • EqualizerBand
      • EqualizerBand.band
      • EqualizerBand.gain
      • EqualizerBand.to_dict()
    • Filters
      • Filters.channelMix
      • Filters.distortion
      • Filters.equalizer
      • Filters.karaoke
      • Filters.lowPass
      • Filters.pluginFilters
      • Filters.rotation
      • Filters.timescale
      • Filters.to_dict()
      • Filters.tremolo
      • Filters.vibrato
      • Filters.volume
    • Karaoke
      • Karaoke.filterBand
      • Karaoke.filterWidth
      • Karaoke.level
      • Karaoke.monoLevel
      • Karaoke.to_dict()
    • LowPass
      • LowPass.smoothing
      • LowPass.to_dict()
    • Reverb
      • Reverb.delays
      • Reverb.gains
      • Reverb.to_dict()
    • Rotation
      • Rotation.rotationHz
      • Rotation.to_dict()
    • Timescale
      • Timescale.pitch
      • Timescale.rate
      • Timescale.speed
      • Timescale.to_dict()
    • Tremolo
      • Tremolo.depth
      • Tremolo.frequency
      • Tremolo.to_dict()
    • Vibrato
      • Vibrato.depth
      • Vibrato.frequency
      • Vibrato.to_dict()
• pylav.nodes.api.responses.plugins package
  • Submodules
  • pylav.nodes.api.responses.plugins.sponsorblock module
    • Segment
      • Segment.category
      • Segment.end
      • Segment.start
    • SegmentSkipped
      • SegmentSkipped.guildId
      • SegmentSkipped.segment
      • SegmentSkipped.type
    • SegmentsLoaded
      • SegmentsLoaded.guildId
      • SegmentsLoaded.segments
      • SegmentsLoaded.type
  • Module contents
    • LyricsLine
      • LyricsLine.duration
      • LyricsLine.line
      • LyricsLine.plugin
      • LyricsLine.timestamp
    • LyricsObject
      • LyricsObject.lines
      • LyricsObject.plugin
      • LyricsObject.provider
      • LyricsObject.sourceName
      • LyricsObject.text
    • Segment
      • Segment.category
      • Segment.end
      • Segment.start
    • SegmentSkipped
      • SegmentSkipped.guildId
      • SegmentSkipped.segment
      • SegmentSkipped.type
    • SegmentsLoaded
      • SegmentsLoaded.guildId
      • SegmentsLoaded.segments
      • SegmentsLoaded.type

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)

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)

Bases: LoadException

cause

class pylav.nodes.api.responses.exceptions.LoadException(*, severity: "Literal['common', 'suspicious', 'fault']", message: 'str | None' = None)

Bases: object

message

severity

pylav.nodes.api.responses.misc module

class pylav.nodes.api.responses.misc.Git(*, branch: 'str', commit: 'str', commitTime: 'int')

Bases: object

branch

commit

commitTime

class pylav.nodes.api.responses.misc.Plugin(*, name: 'str', version: 'str')

Bases: object

name

version

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

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)

Bases: object

connected

ping

position

time

to_dict()

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)

Bases: object

artworkUrl

author

name

selectedTrack

to_dict()

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')

Bases: object

data

loadType

to_dict()

class pylav.nodes.api.responses.rest_api.EmptyResponse(*, loadType: "Literal['empty']", data: 'None' = None)

Bases: BaseTrackResponse

class pylav.nodes.api.responses.rest_api.ErrorResponse(*, loadType: "Literal['error']", data: 'LoadException')

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]')

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)

Bases: object

filters

guildId

paused

state

to_dict()

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]')

Bases: object

albums

artists

playlists

plugins

texts

to_dict()

tracks

class pylav.nodes.api.responses.rest_api.PlaylistData(*, info: 'Info', pluginInfo: 'PlaylistPluginInfo', tracks: 'list[Track]')

Bases: object

info

pluginInfo

to_dict()

tracks

class pylav.nodes.api.responses.rest_api.PlaylistResponse(*, loadType: "Literal['playlist']", data: 'PlaylistData')

Bases: BaseTrackResponse

class pylav.nodes.api.responses.rest_api.SearchResponse(*, loadType: "Literal['search']", data: 'list[Track]')

Bases: BaseTrackResponse

class pylav.nodes.api.responses.rest_api.Stats(*, players: 'int', playingPlayers: 'int', uptime: 'int', memory: 'Memory', cpu: 'CPU', frameStats: 'Frame | None' = None)

Bases: object

cpu

frameStats

memory

players

playingPlayers

uptime

uptime_seconds

class pylav.nodes.api.responses.rest_api.TextInfo(*, text: 'str', plugin: 'PluginInfo')

Bases: object

plugin

text

class pylav.nodes.api.responses.rest_api.TrackResponse(*, loadType: "Literal['track']", data: 'Track')

Bases: BaseTrackResponse

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

Bases: object

endpoint

sessionId

to_dict()

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')

Bases: object

blockIndex

currentAddress

currentAddressIndex

failingAddresses

ipBlock

ipIndex

rotateIndex

class pylav.nodes.api.responses.route_planner.FailingAddress(*, address: 'str', failingTimestamp: 'int', failingTimes: 'str')

Bases: object

address

failingTimes

failingTimestamp

class pylav.nodes.api.responses.route_planner.IPBlock(*, type: "Literal['Inet4Address', 'Inet6Address']", size: 'str')

Bases: object

size

type

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

Bases: object

details

type

pylav.nodes.api.responses.shared module

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

Bases: PluginInfo

template

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

Bases: PluginInfo

artworkUrl

author

identifier

type

url

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

Bases: object

kwargs = None

to_dict()

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

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)

Bases: object

artworkUrl

author

identifier

isSeekable

isStream

isrc

length

position

sourceName

title

to_dict()

uri

version

class pylav.nodes.api.responses.track.Track(*, info: 'Info', encoded: 'str' = None, pluginInfo: 'TrackPluginInfo | None' = None)

Bases: object

encoded

info

pluginInfo

set_version(version)

to_database()

to_dict()

pylav.nodes.api.responses.websocket module

class pylav.nodes.api.responses.websocket.CPU(*, cores: 'int', systemLoad: 'float', lavalinkLoad: 'float')

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')

Bases: Message

byRemote

code

guildId

reason

type

class pylav.nodes.api.responses.websocket.Frame(*, sent: 'int', nulled: 'int', deficit: 'int')

Bases: object

deficit

nulled

sent

class pylav.nodes.api.responses.websocket.Memory(*, free: 'int', allocated: 'int', reservable: 'int', used: 'int')

Bases: object

allocated

free

reservable

used

class pylav.nodes.api.responses.websocket.Message(*, op: 'str')

Bases: object

op

class pylav.nodes.api.responses.websocket.PlayerUpdate(*, op: 'str', guildId: 'str', state: 'State')

Bases: Message

guildId

state

class pylav.nodes.api.responses.websocket.Ready(*, op: 'str', sessionId: 'str', resumed: 'bool')

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)

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']")

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')

Bases: Message

exception

guildId

track

type

class pylav.nodes.api.responses.websocket.TrackStart(*, op: "Literal['event']", type: "Literal['TrackStartEvent']", guildId: 'str', track: 'Track')

Bases: Message

guildId

track

type

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

Bases: Message

guildId

thresholdMs

track

type

Module contents