Skip to main content

RuvyriasEvents

ruvyrias


ruvyrias / RuvyriasEvents

Interface: RuvyriasEvents

Defined in: src/Ruvyrias.ts:195

Represents the events emitted by Ruvyrias.

Properties

debug()

debug: (...args) => void

Defined in: src/Ruvyrias.ts:200

Emitted when data useful for debugging is produced.

Parameters

args

...any[]

The arguments emitted with the event.

Returns

void


nodeConnect()

nodeConnect: (node) => void

Defined in: src/Ruvyrias.ts:213

Emitted when a Lavalink node is connected to Ruvyrias.

Parameters

node

Node

The connected Lavalink node.

Returns

void


nodeCreate()

nodeCreate: (node) => void

Defined in: src/Ruvyrias.ts:226

Emitted when a Lavalink node is created in Ruvyrias.

Parameters

node

Node

The created Lavalink node.

Returns

void


nodeDestroy()

nodeDestroy: (node) => void

Defined in: src/Ruvyrias.ts:232

Emitted when a Lavalink node is destroyed from Ruvyrias.

Parameters

node

Node

The destroyed Lavalink node.

Returns

void


nodeDisconnect()

nodeDisconnect: (node, event?) => void

Defined in: src/Ruvyrias.ts:220

Emitted when a Lavalink node is disconnected from Ruvyrias.

Parameters

node

Node

The disconnected Lavalink node.

event?

unknown

Additional event data.

Returns

void


nodeError()

nodeError: (node, event) => void

Defined in: src/Ruvyrias.ts:245

Emitted when a Lavalink node encounters an error.

Parameters

node

Node

The Lavalink node that encountered the error.

event

any

The error event.

Returns

void


nodeReconnect()

nodeReconnect: (node) => void

Defined in: src/Ruvyrias.ts:238

Emitted when Ruvyrias attempts to reconnect with a disconnected Lavalink node.

Parameters

node

Node

The Lavalink node being reconnected to.

Returns

void


playerCreate()

playerCreate: (player) => void

Defined in: src/Ruvyrias.ts:287

Emitted when a player is created.

Parameters

player

Player

The player instance.

Returns

void


playerDestroy()

playerDestroy: (player) => void

Defined in: src/Ruvyrias.ts:293

Emitted when a player is destroyed.

Parameters

player

Player

The player instance.

Returns

void


playerUpdate()

playerUpdate: (player) => void

Defined in: src/Ruvyrias.ts:281

Emitted when a player is updated.

Parameters

player

Player

The player instance.

Returns

void


queueEnd()

queueEnd: (player) => void

Defined in: src/Ruvyrias.ts:267

Emitted when a player's queue is completed and going to disconnect.

Parameters

player

Player

The player instance.

Returns

void


raw()

raw: (topic, ...args) => void

Defined in: src/Ruvyrias.ts:207

Emitted when a response is received.

Parameters

topic

string

The section from which the event originates.

args

...unknown[]

The arguments emitted with the event.

Returns

void


socketClose()

socketClose: (player, track, data) => void

Defined in: src/Ruvyrias.ts:301

Emitted when the websocket connection to Discord voice servers is closed.

Parameters

player

Player

The player instance.

track

Track

The track being played.

data

WebSocketClosedEvent

Additional data related to the socket close event.

Returns

void


trackEnd()

trackEnd: (player, track, data) => void

Defined in: src/Ruvyrias.ts:261

Emitted whenever a track ends.

Parameters

player

Player

The player instance.

track

Track

The track that ended.

data

TrackEndEvent

Additional data related to the track end event.

Returns

void


trackError()

trackError: (player, track, data) => void

Defined in: src/Ruvyrias.ts:275

Emitted when a track gets stuck while playing.

Parameters

player

Player

The player instance.

track

Track

The track that got stuck.

data

TrackStuckEvent

Additional data related to the track stuck event.

Returns

void


trackStart()

trackStart: (player, track, data) => void

Defined in: src/Ruvyrias.ts:253

Emitted whenever a player starts playing a new track.

Parameters

player

Player

The player instance.

track

Track

The track being played.

data

TrackStartEvent

Additional data related to the track start event.

Returns

void