PlayerEvents | @discord-rose/lavalink

Hierarchy

PlayerEvents

Index

Properties

CONNECTED

CONNECTED: Player

Emitted when the player connects to a VC.

CREATED

CREATED: Player

Emitted when the player is created.

DESTROYED

DESTROYED: { player: Player; reason: string }

Emitted when the player is destroyed.

Type declaration

player: Player
reason: string

ERROR

ERROR: { error: Error; player: Player }

Emitted when the player encounters an error.

Type declaration

error: Error
player: Player

MOVED

MOVED: { newChannel: null | string; oldChannel: null | string; player: Player }

Emitted when the player manually moved. This includes the bot joining or leaving a VC. The player is also automatically paused or destroyed when this event is emitted.

Type declaration

newChannel: null | string
oldChannel: null | string
player: Player

PAUSED

PAUSED: { player: Player; reason: string }

Emitted when the player is paused.

Type declaration

player: Player
reason: string

RESUMED

RESUMED: { player: Player; reason: string }

Emitted when the player is resumed.

Type declaration

player: Player
reason: string

TRACK_END

TRACK_END: { player: Player; reason: string; track: null | Track }

Emitted when the server sends a track end event.

Type declaration

player: Player
reason: string
track: null | Track

TRACK_EXCEPTION

TRACK_EXCEPTION: { cause: string; message: string; player: Player; severity: string; track: null | Track }

Emitted when the server sends a track exception event.

Type declaration

cause: string
message: string
player: Player
severity: string
track: null | Track

TRACK_START

TRACK_START: { player: Player; track: null | Track }

Emitted when the server sends a track start event.

Type declaration

player: Player
track: null | Track

TRACK_STUCK

TRACK_STUCK: { player: Player; thresholdMs: number; track: null | Track }

Emitted when the server sends a track stuck event.

Type declaration

player: Player
thresholdMs: number
track: null | Track

Generated using TypeDoc