Interface LavaEvents

Hierarchy

LavaEvents

Methods

nodeConnect

nodeConnect(node: CoffeeNode): void

- Defined in src/structures/CoffeeLava.ts:21
Emitted when a node connects

Parameters
- node: CoffeeNode
Returns void

nodeCreate

nodeCreate(node: CoffeeNode): void

- Defined in src/structures/CoffeeLava.ts:17
Emitted when a node is created

Parameters
- node: CoffeeNode
Returns void

nodeDestroy

nodeDestroy(node: CoffeeNode): void

- Defined in src/structures/CoffeeLava.ts:19
Emitted when a node is destroyed

Parameters
- node: CoffeeNode
Returns void

nodeDisconnect

nodeDisconnect(node: CoffeeNode, reason: { code: number; reason: string }): void

- Defined in src/structures/CoffeeLava.ts:27
Emitted when a Node disconnects

Parameters
- node: CoffeeNode
- reason: { code: number; reason: string }
  - code: number
  - reason: string
Returns void

nodeError

nodeError(node: CoffeeNode, error: Error): void

- Defined in src/structures/CoffeeLava.ts:29
Emitted when a Node has an error

Parameters
- node: CoffeeNode
- error: Error
Returns void

nodeMissingPlugins

nodeMissingPlugins(node: CoffeeNode, missing: string[]): any

- Defined in src/structures/CoffeeLava.ts:23
Emitted when a node lack required plugins after connected

Parameters
- node: CoffeeNode
- missing: string[]
Returns any

nodeRaw

nodeRaw(node: CoffeeNode, payload: unknown): void

- Defined in src/structures/CoffeeLava.ts:31
Emitted whenever any Lavalink event is received

Parameters
- node: CoffeeNode
- payload: unknown
Returns void

nodeReconnect

nodeReconnect(node: CoffeeNode): void

- Defined in src/structures/CoffeeLava.ts:25
Emitted when a Node reconnects

Parameters
- node: CoffeeNode
Returns void

playerCreate

playerCreate(player: CoffeePlayer): void

- Defined in src/structures/CoffeeLava.ts:33
Emitted whenever a Player is created

Parameters
- player: CoffeePlayer
Returns void

playerDestroy

playerDestroy(player: CoffeePlayer): void

- Defined in src/structures/CoffeeLava.ts:35
Emitted whenever a Player is destroyed

Parameters
- player: CoffeePlayer
Returns void

playerMove

playerMove(player: CoffeePlayer, oldChannel: undefined | string, newChannel: undefined | string): void

- Defined in src/structures/CoffeeLava.ts:41
Emitted whenever a Player is moved to other channel

Parameters
- player: CoffeePlayer
- oldChannel: undefined | string
- newChannel: undefined | string
Returns void

playerReplay

playerReplay(player: CoffeePlayer): void

- Defined in src/structures/CoffeeLava.ts:37
Emitted whenever a Player is replaying after moving node

Parameters
- player: CoffeePlayer
Returns void

queueEnd

queueEnd(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackEndPayload | TrackExceptionPayload | TrackStuckPayload): void

- Defined in src/structures/CoffeeLava.ts:45
Emitted whenever queue is ended

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackEndPayload | TrackExceptionPayload | TrackStuckPayload
Returns void

queueStart

queueStart(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackStartPayload): void

- Defined in src/structures/CoffeeLava.ts:43
Emitted whenever queue is started

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackStartPayload
Returns void

replayError

replayError(player: CoffeePlayer, error: Error): void

- Defined in src/structures/CoffeeLava.ts:39
Emitted whenever an error occured when replaying track

Parameters
- player: CoffeePlayer
- error: Error
Returns void

socketClosed

socketClosed(player: CoffeePlayer, payload: WebSocketClosedPayload): void

- Defined in src/structures/CoffeeLava.ts:55
Emitted whenever a voice connection is closed

Parameters
- player: CoffeePlayer
- payload: WebSocketClosedPayload
Returns void

trackEnd

trackEnd(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackEndPayload): void

- Defined in src/structures/CoffeeLava.ts:49
Emitted whenever a track end

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackEndPayload
Returns void

trackError

trackError(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackExceptionPayload): void

- Defined in src/structures/CoffeeLava.ts:53
Emitted whenever a track occur an error during playback

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackExceptionPayload
Returns void

trackStart

trackStart(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackStartPayload): void

- Defined in src/structures/CoffeeLava.ts:47
Emitted whenever a track start

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackStartPayload
Returns void

trackStuck

trackStuck(player: CoffeePlayer, track: CoffeeTrack | UnresolvedTrack, payload: TrackStuckPayload): void

- Defined in src/structures/CoffeeLava.ts:51
Emitted whenever a track stuck during playback

Parameters
- player: CoffeePlayer
- track: CoffeeTrack | UnresolvedTrack
- payload: TrackStuckPayload
Returns void

Generated using TypeDoc