pylav.events.track package

Submodules

pylav.events.track.track_start module

class pylav.events.track.track_start.TrackStartAppleMusicEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play an Apple Music track.

Event can be listened to by adding a listener with the name pylav_track_start_apple_music_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartBandcampEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Bandcamp track.

Event can be listened to by adding a listener with the name pylav_track_start_bandcamp_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartClypitEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Clyp.it track.

Event can be listened to by adding a listener with the name pylav_track_start_clypit_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartDeezerEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Deezer track.

Event can be listened to by adding a listener with the name pylav_track_start_deezer_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartEvent(player, track, node, event_object)

Bases: PyLavEvent

This event is dispatched when the player starts to play a track.

Event can be listened to by adding a listener with the name pylav_track_start_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartGCTTSEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Google Cloud TTS track.

Event can be listened to by adding a listener with the name pylav_track_start_gctts_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartGetYarnEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a GetYarn track.

Event can be listened to by adding a listener with the name pylav_track_start_get_yarn_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartHTTPEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play an HTTP track.

Event can be listened to by adding a listener with the name pylav_track_start_http_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartLocalFileEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a local file track.

Event can be listened to by adding a listener with the name pylav_track_start_local_file_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartMixCloudEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a MixCloud track.

Event can be listened to by adding a listener with the name pylav_track_start_mix_cloud_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartNicoNicoEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a NicoNico track.

Event can be listened to by adding a listener with the name pylav_track_start_nico_nico_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartOCRMixEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a OCR Mix track.

Event can be listened to by adding a listener with the name pylav_track_start_ocr_mix_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartPornHubEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Pornhub track.

Event can be listened to by adding a listener with the name pylav_track_start_porn_hub_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartRedditEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Reddit track.

Event can be listened to by adding a listener with the name pylav_track_start_reddit_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartSoundCloudEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a SoundCloud track.

Event can be listened to by adding a listener with the name pylav_track_start_soundcloud_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartSoundgasmEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Soundgasm track.

Event can be listened to by adding a listener with the name pylav_track_start_soundgasm_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartSpeakEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Speak track.

Event can be listened to by adding a listener with the name pylav_track_start_speak_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartSpotifyEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Spotify track.

Event can be listened to by adding a listener with the name pylav_track_start_spotify_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartTikTokEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a TikTok track.

Event can be listened to by adding a listener with the name pylav_track_start_tik_tok_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartTwitchEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Twitch track.

Event can be listened to by adding a listener with the name pylav_track_start_twitch_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartVimeoEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Vimeo track.

Event can be listened to by adding a listener with the name pylav_track_start_vimeo_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartYandexMusicEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a Yandex Music track.

Event can be listened to by adding a listener with the name pylav_track_start_yandex_music_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartYouTubeEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a YouTube track.

Event can be listened to by adding a listener with the name pylav_track_start_youtube_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

class pylav.events.track.track_start.TrackStartYouTubeMusicEvent(player, track, node, event_object)

Bases: TrackStartEvent

This event is dispatched when the player starts to play a YouTube Music track.

Event can be listened to by adding a listener with the name pylav_track_start_youtube_music_event.

player

The player that started to play the track.

Type:

Player

track

The track that was started.

Type:

Track

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStart

event

node

player

track

Module contents

class pylav.events.track.TrackAutoPlayEvent(player, track)

Bases: PyLavEvent

This event is dispatched when the player starts to play a track.

Event can be listened to by adding a listener with the name pylav_track_start_event.

player

The player that started playing the track.

Type:

Player

track

The track that started playing.

Type:

Track

player

track

class pylav.events.track.TrackEndEvent(player, track, node, event_object)

Bases: PyLavEvent

This event is dispatched when the player finished playing a track.

Event can be listened to by adding a listener with the name pylav_track_end_event.

player

The player that finished playing the track.

Type:

Player

track

The track that finished playing.

Type:

Track

reason

The reason why the track finished playing.

Type:

str

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackEnd

event

node

player

reason

track

class pylav.events.track.TrackExceptionEvent(player, track, node, event_object)

Bases: PyLavEvent

This event is dispatched when an exception occurs while playing a track.

Event can be listened to by adding a listener with the name pylav_track_exception_event.

player

The player that encountered the exception.

Type:

Player

track

The track that encountered the exception.

Type:

Track

exception

The exception that was encountered.

Type:

str

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackException

event

exception

node

player

track

class pylav.events.track.TrackPreviousRequestedEvent(player, requester, track)

Bases: PyLavEvent

This event is dispatched when a history track is requested.

Event can be listened to by adding a listener with the name pylav_track_previous_requested_event.

player

The player that requested the track.

Type:

Player

track

The track that was requested.

Type:

Track

requester

The member that requested the track.

Type:

discord.Member

player

requester

track

class pylav.events.track.TrackResumedEvent(player, track, requester)

Bases: PyLavEvent

This event is dispatched when the player resumes playing a track.

Event can be listened to by adding a listener with the name pylav_track_resume_event.

player

The player that resumed playing the track.

Type:

Player

track

The track that resumed playing.

Type:

Track

requester

The member that requested the resume.

Type:

discord.Member

player

requester

track

class pylav.events.track.TrackSeekEvent(player, requester, track, before, after)

Bases: PyLavEvent

This event is dispatched when the player is moved.

Event can be listened to by adding a listener with the name pylav_track_seek_event.

player

The player that moved.

Type:

Player

track

The track that was moved.

Type:

Track

requester

The member that requested the move.

Type:

discord.Member

before

The position before the move.

Type:

float

after

The position after the move.

Type:

float

after

before

player

requester

track

class pylav.events.track.TrackSkippedEvent(player, requester, track, position)

Bases: PyLavEvent

This event is dispatched when a track is skipped.

Event can be listened to by adding a listener with the name pylav_track_skipped_event.

player

The player that skipped the track.

Type:

Player

track

The track that was skipped.

Type:

Track

requester

The member that requested the skip.

Type:

discord.Member

player

position

requester

track

class pylav.events.track.TrackStuckEvent(player, track, node, event_object)

Bases: PyLavEvent

This event is dispatched when the currently playing track is stuck. This normally has something to do with the stream you are playing and not Lavalink itself.

Event can be listened to by adding a listener with the name pylav_track_stuck_event.

player

The player that is stuck.

Type:

Player

track

The track that is stuck.

Type:

Track

threshold

The threshold in milliseconds.

Type:

int

node

The node that dispatched the event.

Type:

Node

event

The raw event object.

Type:

TrackStuck

event

node

player

threshold

track