Add a node
-Create a player or return one if it already exists
-Decode the base64 track into TrackData
-Destroy a player if it exist
-Return a player or undefined if it doesn't exist
-Initiate the Lavalink client
-Searches some tracks based off the URL or the source property
Send voice data to the Lavalink server
Generated using TypeDoc
Sums of http request calls since created
-Whether the node already connected via websocket
-The http clients pool for http calls
-The node options
-The node websocket if connected
-The node stats
-Connect to the node via socket
-Destroy the node connection
-Do http(s) request to the node
-Send data to the node
Generated using TypeDoc
The player filters
-The player manager
-The player loop mode
-The player options
-The player play options if its currently playing
-The player position in milliseconds
-The queue for the player
-Whether the player is currently replaying
-The player state
-The player voice payload
-Whether the player is connected to voice on node-side
-The player voice state
-The node used by player
-Connect to the voice channel
-Destroy the player
-Disconnect from the voice channel
-Get a property from metadata
-Patch the player filters
-Pause the current track
-Play the next track in queue
-Seek to the position in current track
-Set a property into metadata
-Set the player filters
-Set the player loop mode
-Move the player to another node
-Set the player volume
-Stops the current track, optionally give an amount to skip to, e.g 5 would play the 5th song
Generated using TypeDoc
The player's queue, the current property is the currently playing track, think of the rest as the up-coming tracks
The current track
-The previous track
-The total duration of the queue
-The size of the tracks in the queue
-The total size of tracks in the queue including the current track
-Add some track to the queue
-Clear the queue
-Progress to next song
-Removes an amount of tracks using a exclusive start and end exclusive index, returning the removed tracks, EXCLUDING THE current TRACK
Shuffle the queue
Generated using TypeDoc
The author of the track
-The base 64 encoded of track
-The duration of the track
-The identifier of the track
-Whether the track is seekable
-Whether the track is a stream
-The requester of the track if any
-The source of the track
-The title of the track
-The url of the track
-Build TrackInfo into ITrack
-Display thumbnail url if source is youtube
-Check if obj is a valid Track
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
ChannelMix filter builder utility
-Build the channel mix filter
-Set left to left mix, must be between 0 to 1
-Set left to right mix, must be between 0 to 1
-Set right to left mix, must be between 0 to 1
-Set right to right mix, must be between 0 to 1
Generated using TypeDoc
Distortion filter builder utility
-Build the distortion filter
-Set the cos offset
-Set the cos scale
-Set the offset
-Set the scale
-Set the sin offset
-Set the sin scale
-Set the tan offset
-Set the tan scale
Generated using TypeDoc
Equalizer filter builder utility
-Build the equalizers
-Clear the equalizers filter
-Set a band equalizer, band must be between 0 to 13
+Set a band equalizer, band must be between 0 to 14, gain must be between -0.25 to 1
Generated using TypeDoc
Filters builder utility
-Build the filters
-Set the filter volume
Generated using TypeDoc
Karaoke filter builder utility
-Build the karaoke filter
-Disable the karaoke filter
-Set the filter band
-Set the filter width
-Set the level
-Set the mono level
Generated using TypeDoc
LowPass filter builder utility
-Build the low pass filter
-Set the smoothing
Generated using TypeDoc
Rotation filter builder utility
-Build the rotation filter
-Set the rotation speed
Generated using TypeDoc
Timescale filter builder utility
-Build the timescale filter
-Set the pitch, must be more than 0
-Set the rate, must be more than 0
-Set the speed, must be more than 0
Generated using TypeDoc
Tremolo filter builder utility
-Build the tremolo filter
-Set the depth, must be between 0 to 1
-Set the frequency, must be more than 0
Generated using TypeDoc
Vibrato filter builder utility
-Build the vibrato filter
-Set the depth, must be between 0 to 1
-Set the frequency, must be between 0 and 15
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
/**
* LavaCoffee also supports lavalink filters
* it also got filters builder to manage filters easier
*/
// Importing filters builder
import { CoffeeFilters } from "lavacoffee"
// Creating filters
const filters = new CoffeeFilters()
// Example on setting equalizer
filters.equalizers
.setBand(2, 1.3)
.setBand(6, -2)
// Example to enable karaoke filter
filters.karaoke.enabled = true
// Example on setting 2x speed and half pitch
filters.timescale
.setSpeed(2)
.setPitch(0.5)
// Example on setting vibrato filter
filters.vibrato
.setFrequency(2)
.setDepth(0.5)
// Example on setting the audio to only left channel
filters.channelMix
.setRightToLeft(1)
.setRightToRight(0)
// Set the filters
player.setFilters(filters)
+/**
* LavaCoffee also supports lavalink filters
* it also got filters builder to manage filters easier
*/
// Importing filters builder
import { CoffeeFilters } from "lavacoffee"
// Creating filters
const filters = new CoffeeFilters()
// Example on setting equalizer
filters.equalizers
.setBand(2, 0.25)
.setBand(6, -0.25)
// Example to enable karaoke filter
filters.karaoke.enabled = true
// Example on setting 2x speed and half pitch
filters.timescale
.setSpeed(2)
.setPitch(0.5)
// Example on setting vibrato filter
filters.vibrato
.setFrequency(2)
.setDepth(0.5)
// Example on setting the audio to only left channel
filters.channelMix
.setRightToLeft(1)
.setRightToRight(0)
// Set the filters
player.setFilters(filters)
diff --git a/docs/interfaces/ITrack.html b/docs/interfaces/ITrack.html
index e7286a5..f805da3 100644
--- a/docs/interfaces/ITrack.html
+++ b/docs/interfaces/ITrack.html
@@ -1,17 +1,17 @@
-ITrack | lavacoffee Interface ITrack
Hierarchy
- ITrack
Implemented by
Index
Properties
author
+ITrack | lavacoffee Interface ITrack
Hierarchy
- ITrack
Implemented by
Index
Properties
author
The author of the track
-duration
+duration
The duration of the track
-identifier
+identifier
The identifier of the track
-is
+is
Whether the track is seekable
-is
+is
Whether the track is a stream
-source
+source
The source of the track
-title
+title
The title of the track
-url
+url
The url of the track
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/LavaEvents.html b/docs/interfaces/LavaEvents.html
index af4c023..1bf7170 100644
--- a/docs/interfaces/LavaEvents.html
+++ b/docs/interfaces/LavaEvents.html
@@ -1,39 +1,39 @@
-LavaEvents | lavacoffee Interface LavaEvents
Hierarchy
- LavaEvents
Index
Methods
node
-
+
LavaEvents | lavacoffee Interface LavaEvents
Hierarchy
- LavaEvents
Index
Methods
node
-
Emitted when a node connects
-Parameters
node: CoffeeNode
Returns void
node
-
+
Parameters
node: CoffeeNode
Returns void
node
-
Emitted when a node is created
-Parameters
node: CoffeeNode
Returns void
node
-
+
Parameters
node: CoffeeNode
Returns void
node
-
Emitted when a node is destroyed
-Parameters
node: CoffeeNode
Returns void
node
-
+
Parameters
node: CoffeeNode
Returns void
node
-
Emitted when a Node disconnects
-Parameters
node: CoffeeNode
reason: { code: number; reason: string }
code: number
reason: string
Returns void
node
-
+
Parameters
node: CoffeeNode
reason: { code: number; reason: string }
code: number
reason: string
Returns void
node
-
Emitted when a Node has an error
-Parameters
node: CoffeeNode
error: Error
Returns void
node
-
+
Parameters
node: CoffeeNode
error: Error
Returns void
node
-
Emitted whenever any Lavalink event is received
-Parameters
node: CoffeeNode
payload: unknown
Returns void
node
-
+
Parameters
node: CoffeeNode
payload: unknown
Returns void
node
-
Emitted when a Node reconnects
-Parameters
node: CoffeeNode
Returns void
player
-
+
Parameters
node: CoffeeNode
Returns void
player
-
Emitted whenever a Player is created
-Parameters
player: CoffeePlayer
Returns void
player
-
+
Parameters
player: CoffeePlayer
Returns void
player
-
Emitted whenever a Player is destroyed
-Parameters
player: CoffeePlayer
Returns void
player
-
+
Parameters
player: CoffeePlayer
Returns void
player
-
Emitted whenever a Player is moved to other channel
-Parameters
player: CoffeePlayer
oldChannel: undefined | string
newChannel: undefined | string
Returns void
player
-
+
Parameters
player: CoffeePlayer
oldChannel: undefined | string
newChannel: undefined | string
Returns void
player
-
Emitted whenever a Player is replaying after moving node
-Parameters
player: CoffeePlayer
Returns void
queue
-
+
Parameters
player: CoffeePlayer
Returns void
queue
-
Emitted whenever queue is ended
-Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackEndPayload
Returns void
queue
-
+
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackEndPayload
Returns void
queue
-
Emitted whenever queue is started
-Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackStartPayload
Returns void
replay
-
+
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackStartPayload
Returns void
replay
-
Emitted whenever an error occured when replaying track
-Parameters
player: CoffeePlayer
error: Error
Returns void
socket
-
+
Parameters
player: CoffeePlayer
error: Error
Returns void
socket
-
Emitted whenever a voice connection is closed
-Parameters
player: CoffeePlayer
payload: WebSocketClosedPayload
Returns void
track
-
+
Parameters
player: CoffeePlayer
payload: WebSocketClosedPayload
Returns void
track
-
Emitted whenever a track end
-Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackEndPayload
Returns void
track
-
+
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackEndPayload
Returns void
track
-
Emitted whenever a track occur an error during playback
-Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackExceptionPayload
Returns void
track
-
+
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackExceptionPayload
Returns void
track
-
Emitted whenever a track start
-Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackStartPayload
Returns void
track
-
+
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackStartPayload
Returns void
track
-
Emitted whenever a track stuck during playback
Parameters
player: CoffeePlayer
track: CoffeeTrack | UnresolvedTrack
payload: TrackStuckPayload
Returns void
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/NodeEvents.html b/docs/interfaces/NodeEvents.html
index dffead8..d2ac9f7 100644
--- a/docs/interfaces/NodeEvents.html
+++ b/docs/interfaces/NodeEvents.html
@@ -1,17 +1,17 @@
-NodeEvents | lavacoffee Interface NodeEvents
Hierarchy
- NodeEvents
Index
Methods
connect
-
+
NodeEvents | lavacoffee Interface NodeEvents
Hierarchy
- NodeEvents
Index
Methods
connect
-
Emitted when node connects
-Returns void
destroy
-
+
Returns void
destroy
-
Emitted when node is destroyed
-Returns void
disconnect
-
+
Returns void
disconnect
-
Emitted when node disconnects
-Parameters
reason: { code: number; reason: string }
code: number
reason: string
Returns void
error
-
+
Parameters
reason: { code: number; reason: string }
code: number
reason: string
Returns void
error
-
Emitted when node has an error
-Parameters
error: Error
Returns void
event
-
+
Parameters
error: Error
Returns void
event
-
Emitted whenever any Lavalink event is received
-Parameters
payload: EventPayloads
Returns void
player
-
+
Parameters
payload: EventPayloads
Returns void
player
-
Emitted whenever playerUpdate is received
-Parameters
guildID: string
state: { connected: boolean; position: number; time: number }
connected: boolean
position: number
time: number
Returns void
raw
-
+
Parameters
guildID: string
state: { connected: boolean; position: number; time: number }
connected: boolean
position: number
time: number
Returns void
raw
-
Emitted whenever any Lavalink incoming message is received
-Parameters
payload: IncomingPayloads
Returns void
reconnect
-
+
Parameters
payload: IncomingPayloads
Returns void
reconnect
-
Emitted when node reconnects
Returns void
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.ChannelMix.html b/docs/interfaces/Utils.ChannelMix.html
index b54da97..f370714 100644
--- a/docs/interfaces/Utils.ChannelMix.html
+++ b/docs/interfaces/Utils.ChannelMix.html
@@ -1 +1 @@
-ChannelMix | lavacoffee Interface ChannelMix
Generated using TypeDoc
\ No newline at end of file
+ChannelMix | lavacoffee Interface ChannelMix
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.DestroyPayload.html b/docs/interfaces/Utils.DestroyPayload.html
index ab69a9e..68ac882 100644
--- a/docs/interfaces/Utils.DestroyPayload.html
+++ b/docs/interfaces/Utils.DestroyPayload.html
@@ -1 +1 @@
-DestroyPayload | lavacoffee Interface DestroyPayload
Generated using TypeDoc
\ No newline at end of file
+DestroyPayload | lavacoffee Interface DestroyPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Distortion.html b/docs/interfaces/Utils.Distortion.html
index 94075aa..bdebb68 100644
--- a/docs/interfaces/Utils.Distortion.html
+++ b/docs/interfaces/Utils.Distortion.html
@@ -1 +1 @@
-Distortion | lavacoffee Interface Distortion
Generated using TypeDoc
\ No newline at end of file
+Distortion | lavacoffee Interface Distortion
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Equalizer.html b/docs/interfaces/Utils.Equalizer.html
index fe1677f..59a2065 100644
--- a/docs/interfaces/Utils.Equalizer.html
+++ b/docs/interfaces/Utils.Equalizer.html
@@ -1,5 +1,5 @@
-Equalizer | lavacoffee Interface Equalizer
Hierarchy
- Equalizer
Index
Properties
band
+Equalizer | lavacoffee Interface Equalizer
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.EventPayload.html b/docs/interfaces/Utils.EventPayload.html
index aedcb4c..4645325 100644
--- a/docs/interfaces/Utils.EventPayload.html
+++ b/docs/interfaces/Utils.EventPayload.html
@@ -1 +1 @@
-EventPayload | lavacoffee Interface EventPayload
Generated using TypeDoc
\ No newline at end of file
+EventPayload | lavacoffee Interface EventPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Filters.html b/docs/interfaces/Utils.Filters.html
index db288ce..e79634f 100644
--- a/docs/interfaces/Utils.Filters.html
+++ b/docs/interfaces/Utils.Filters.html
@@ -1,21 +1,21 @@
-Filters | lavacoffee Interface Filters
Hierarchy
- Filters
Index
Properties
Optional channel
+Filters | lavacoffee Interface Filters
Hierarchy
- Filters
Index
Properties
Optional channel
Mixes both channels (left and right), with a configurable factor on how much each channel affects the other
-Optional distortion
+Optional distortion
Distortion effect. It can generate some pretty unique audio effects
-Optional equalizer
+Optional equalizer
The equalizer filters
-Optional karaoke
+Optional karaoke
Uses equalization to eliminate part of a band, usually targeting vocals
-Optional low
+Optional low
Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass
-Optional rotation
+Optional rotation
Rotates the sound around the stereo channels/user headphones aka Audio Panning
-Optional timescale
+Optional timescale
Changes the speed, pitch, and rate. All default to 1
-Optional tremolo
+Optional tremolo
Uses amplification to create a shuddering effect, where the volume quickly oscillates
-Optional vibrato
+Optional vibrato
Similar to tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch
-Optional volume
+Optional volume
The volume filter
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.FiltersPayload.html b/docs/interfaces/Utils.FiltersPayload.html
index 2bd5c75..b8f0045 100644
--- a/docs/interfaces/Utils.FiltersPayload.html
+++ b/docs/interfaces/Utils.FiltersPayload.html
@@ -1,21 +1,21 @@
-FiltersPayload | lavacoffee Interface FiltersPayload
Hierarchy
- OutgoingPayload
- Filters
- FiltersPayload
Index
Properties
Optional channel
+FiltersPayload | lavacoffee Interface FiltersPayload
Hierarchy
- OutgoingPayload
- Filters
- FiltersPayload
Index
Properties
Optional channel
Mixes both channels (left and right), with a configurable factor on how much each channel affects the other
-Optional distortion
+Optional distortion
Distortion effect. It can generate some pretty unique audio effects
-Optional equalizer
+Optional equalizer
The equalizer filters
-guild
Optional karaoke
+guild
Optional karaoke
Uses equalization to eliminate part of a band, usually targeting vocals
-Optional low
+Optional low
Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass
-op
Optional rotation
+op
Optional rotation
Rotates the sound around the stereo channels/user headphones aka Audio Panning
-Optional timescale
+Optional timescale
Changes the speed, pitch, and rate. All default to 1
-Optional tremolo
+Optional tremolo
Uses amplification to create a shuddering effect, where the volume quickly oscillates
-Optional vibrato
+Optional vibrato
Similar to tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch
-Optional volume
+Optional volume
The volume filter
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.IncomingPayload.html b/docs/interfaces/Utils.IncomingPayload.html
index dae61e9..7071903 100644
--- a/docs/interfaces/Utils.IncomingPayload.html
+++ b/docs/interfaces/Utils.IncomingPayload.html
@@ -1 +1 @@
-IncomingPayload | lavacoffee Interface IncomingPayload
Generated using TypeDoc
\ No newline at end of file
+IncomingPayload | lavacoffee Interface IncomingPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Karaoke.html b/docs/interfaces/Utils.Karaoke.html
index 8c809b9..6915aaf 100644
--- a/docs/interfaces/Utils.Karaoke.html
+++ b/docs/interfaces/Utils.Karaoke.html
@@ -1 +1 @@
-Karaoke | lavacoffee Interface Karaoke
Generated using TypeDoc
\ No newline at end of file
+Karaoke | lavacoffee Interface Karaoke
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.LavaOptions.html b/docs/interfaces/Utils.LavaOptions.html
index 7469c65..c7df090 100644
--- a/docs/interfaces/Utils.LavaOptions.html
+++ b/docs/interfaces/Utils.LavaOptions.html
@@ -1,15 +1,15 @@
-LavaOptions | lavacoffee Interface LavaOptions
Hierarchy
- LavaOptions
Index
Properties
Optional auto
+LavaOptions | lavacoffee Interface LavaOptions
Hierarchy
- LavaOptions
Index
Properties
Optional auto
Wether players should autmotically play next song
-Optional auto
+Optional auto
Whether to replay track automatically when node used on player is disconnected
-Optional auto
+Optional auto
Wether to resume voice connection if socket closed unexpectedly
-Optional client
+Optional client
The value to use for 'Client-Name' header
-Optional default
+Optional default
The default search platform to use, can be "yt" for youtube, "ytm" for youtube music, and "sc" for soundcloud
-Optional shards
+Optional shards
The shards count
-Methods
send
-
+
Methods
send
-
Function to send voice state to the websocket
Parameters
guildID: string
voiceState: VoiceStatePayload
Returns any
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.LowPass.html b/docs/interfaces/Utils.LowPass.html
index 8d32a88..a03b294 100644
--- a/docs/interfaces/Utils.LowPass.html
+++ b/docs/interfaces/Utils.LowPass.html
@@ -1 +1 @@
-LowPass | lavacoffee Interface LowPass
Generated using TypeDoc
\ No newline at end of file
+LowPass | lavacoffee Interface LowPass
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.NodeCPUStats.html b/docs/interfaces/Utils.NodeCPUStats.html
index 0af6a2e..afbdbc9 100644
--- a/docs/interfaces/Utils.NodeCPUStats.html
+++ b/docs/interfaces/Utils.NodeCPUStats.html
@@ -1,7 +1,7 @@
-NodeCPUStats | lavacoffee Interface NodeCPUStats
Hierarchy
- NodeCPUStats
Index
Properties
Properties
cores
+NodeCPUStats | lavacoffee Interface NodeCPUStats
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.NodeFrameStats.html b/docs/interfaces/Utils.NodeFrameStats.html
index 58db5d8..6934d25 100644
--- a/docs/interfaces/Utils.NodeFrameStats.html
+++ b/docs/interfaces/Utils.NodeFrameStats.html
@@ -1,7 +1,7 @@
-NodeFrameStats | lavacoffee Interface NodeFrameStats
Hierarchy
- NodeFrameStats
Index
Properties
deficit
+NodeFrameStats | lavacoffee Interface NodeFrameStats
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.NodeMemoryStats.html b/docs/interfaces/Utils.NodeMemoryStats.html
index a440722..65ed562 100644
--- a/docs/interfaces/Utils.NodeMemoryStats.html
+++ b/docs/interfaces/Utils.NodeMemoryStats.html
@@ -1,9 +1,9 @@
-NodeMemoryStats | lavacoffee Interface NodeMemoryStats
Hierarchy
- NodeMemoryStats
Index
Properties
Properties
allocated
+NodeMemoryStats | lavacoffee Interface NodeMemoryStats
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.NodeOptions.html b/docs/interfaces/Utils.NodeOptions.html
index 38a4742..4fa82c5 100644
--- a/docs/interfaces/Utils.NodeOptions.html
+++ b/docs/interfaces/Utils.NodeOptions.html
@@ -1,17 +1,17 @@
-NodeOptions | lavacoffee Interface NodeOptions
Hierarchy
- NodeOptions
Index
Properties
Optional max
+NodeOptions | lavacoffee Interface NodeOptions
Hierarchy
- NodeOptions
Index
Properties
Optional max
The max http connections that can be opened at once, null for unlimited
-name
+name
The name for the node.
-Optional password
+Optional password
The password for the node
-Optional request
+Optional request
The timeout used for api calls
-Optional retry
+Optional retry
The retryAmount for the node.
-Optional retry
+Optional retry
The retryDelay for the node.
-Optional secure
+Optional secure
Whether the host uses SSL.
-url
+url
The url for the node
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.NodeStats.html b/docs/interfaces/Utils.NodeStats.html
index 7fd49ad..3cbd33b 100644
--- a/docs/interfaces/Utils.NodeStats.html
+++ b/docs/interfaces/Utils.NodeStats.html
@@ -1,15 +1,15 @@
-NodeStats | lavacoffee Interface NodeStats
Hierarchy
- NodeStats
Index
Properties
cpu
+NodeStats | lavacoffee Interface NodeStats
Hierarchy
- NodeStats
Index
Properties
cpu
The cpu stats for the node.
-Optional frame
+Optional frame
The frame stats for the node.
-last
+last
Timestamp of the time the stats was updated
-memory
+memory
The memory stats for the node.
-players
+players
The amount of players on the node.
-playing
+playing
The amount of playing players on the node.
-uptime
+uptime
The uptime for the node.
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.OutgoingPayload.html b/docs/interfaces/Utils.OutgoingPayload.html
index e366a63..6969c00 100644
--- a/docs/interfaces/Utils.OutgoingPayload.html
+++ b/docs/interfaces/Utils.OutgoingPayload.html
@@ -1 +1 @@
-OutgoingPayload | lavacoffee Interface OutgoingPayload
Generated using TypeDoc
\ No newline at end of file
+OutgoingPayload | lavacoffee Interface OutgoingPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.PausePayload.html b/docs/interfaces/Utils.PausePayload.html
index 1d0c7af..23a8f2c 100644
--- a/docs/interfaces/Utils.PausePayload.html
+++ b/docs/interfaces/Utils.PausePayload.html
@@ -1 +1 @@
-PausePayload | lavacoffee Interface PausePayload
Generated using TypeDoc
\ No newline at end of file
+PausePayload | lavacoffee Interface PausePayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.PlayOptions.html b/docs/interfaces/Utils.PlayOptions.html
index ed710d5..7165ba0 100644
--- a/docs/interfaces/Utils.PlayOptions.html
+++ b/docs/interfaces/Utils.PlayOptions.html
@@ -1,5 +1,5 @@
-PlayOptions | lavacoffee Interface PlayOptions
Hierarchy
- PlayOptions
Index
Properties
Optional end
+PlayOptions | lavacoffee Interface PlayOptions
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.PlayPayload.html b/docs/interfaces/Utils.PlayPayload.html
index f188b3a..5c50171 100644
--- a/docs/interfaces/Utils.PlayPayload.html
+++ b/docs/interfaces/Utils.PlayPayload.html
@@ -1 +1 @@
-PlayPayload | lavacoffee Interface PlayPayload
Generated using TypeDoc
\ No newline at end of file
+PlayPayload | lavacoffee Interface PlayPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.PlayerOptions.html b/docs/interfaces/Utils.PlayerOptions.html
index 7d44f61..e648847 100644
--- a/docs/interfaces/Utils.PlayerOptions.html
+++ b/docs/interfaces/Utils.PlayerOptions.html
@@ -1,15 +1,15 @@
-PlayerOptions | lavacoffee Interface PlayerOptions
Hierarchy
- PlayerOptions
Index
Properties
guildID
+PlayerOptions | lavacoffee Interface PlayerOptions
Hierarchy
- PlayerOptions
Index
Properties
guildID
The guild the Player belongs to
-Optional metadata
+Optional metadata
Additional metadata for player, if any
-Optional node
+Optional node
The node the Player use
-Optional self
+Optional self
If the player should deaf itself
-Optional self
+Optional self
If the player should mute itself
-Optional voiceID
+Optional voiceID
The voice channel the Player belongs to
-Optional volume
+Optional volume
The initial volume the Player will use
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.PlayerUpdatePayload.html b/docs/interfaces/Utils.PlayerUpdatePayload.html
index df97cf5..b847fbe 100644
--- a/docs/interfaces/Utils.PlayerUpdatePayload.html
+++ b/docs/interfaces/Utils.PlayerUpdatePayload.html
@@ -1 +1 @@
-PlayerUpdatePayload | lavacoffee Interface PlayerUpdatePayload
Hierarchy
- IncomingPayload
- PlayerUpdatePayload
Index
Properties
guild
op
state
Type declaration
connected: boolean
position: number
time: number
Generated using TypeDoc
\ No newline at end of file
+PlayerUpdatePayload | lavacoffee Interface PlayerUpdatePayload
Hierarchy
- IncomingPayload
- PlayerUpdatePayload
Index
Properties
guild
op
state
Type declaration
connected: boolean
position: number
time: number
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Playlist.html b/docs/interfaces/Utils.Playlist.html
index c84353a..2fa08dc 100644
--- a/docs/interfaces/Utils.Playlist.html
+++ b/docs/interfaces/Utils.Playlist.html
@@ -1,7 +1,7 @@
-Playlist | lavacoffee Interface Playlist
Hierarchy
- Playlist
Index
Properties
Properties
duration
+Playlist | lavacoffee Interface Playlist
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Rotation.html b/docs/interfaces/Utils.Rotation.html
index ca13d60..56c9bb2 100644
--- a/docs/interfaces/Utils.Rotation.html
+++ b/docs/interfaces/Utils.Rotation.html
@@ -1,3 +1,3 @@
-Rotation | lavacoffee Interface Rotation
Hierarchy
- Rotation
Index
Properties
Properties
rotation
+Rotation | lavacoffee Interface Rotation
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.SearchQuery.html b/docs/interfaces/Utils.SearchQuery.html
index 7b02198..41e0770 100644
--- a/docs/interfaces/Utils.SearchQuery.html
+++ b/docs/interfaces/Utils.SearchQuery.html
@@ -1,5 +1,5 @@
-SearchQuery | lavacoffee Interface SearchQuery
Hierarchy
- SearchQuery
Index
Properties
query
+SearchQuery | lavacoffee Interface SearchQuery
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.SearchResult.html b/docs/interfaces/Utils.SearchResult.html
index 0b0c028..b832bb8 100644
--- a/docs/interfaces/Utils.SearchResult.html
+++ b/docs/interfaces/Utils.SearchResult.html
@@ -1,9 +1,9 @@
-SearchResult | lavacoffee Interface SearchResult
Hierarchy
- SearchResult
Index
Properties
Optional error
+SearchResult | lavacoffee Interface SearchResult
Hierarchy
- SearchResult
Index
Properties
Optional error
Error from searching, if failed
-Type declaration
message: string
severity: string
load
+Type declaration
message: string
severity: string
load
Load type from searching
-Optional playlist
+Optional playlist
The playlist info if load type is playlist
-tracks
+tracks
The tracks from searching
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.SeekPayload.html b/docs/interfaces/Utils.SeekPayload.html
index 32fc33a..3064baa 100644
--- a/docs/interfaces/Utils.SeekPayload.html
+++ b/docs/interfaces/Utils.SeekPayload.html
@@ -1 +1 @@
-SeekPayload | lavacoffee Interface SeekPayload
Generated using TypeDoc
\ No newline at end of file
+SeekPayload | lavacoffee Interface SeekPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.StatsPayload.html b/docs/interfaces/Utils.StatsPayload.html
index 3d47c9b..42e9329 100644
--- a/docs/interfaces/Utils.StatsPayload.html
+++ b/docs/interfaces/Utils.StatsPayload.html
@@ -1,15 +1,15 @@
-StatsPayload | lavacoffee Interface StatsPayload
Hierarchy
- IncomingPayload
- NodeStats
- StatsPayload
Index
Properties
cpu
+StatsPayload | lavacoffee Interface StatsPayload
Hierarchy
- IncomingPayload
- NodeStats
- StatsPayload
Index
Properties
cpu
The cpu stats for the node.
-Optional frame
+Optional frame
The frame stats for the node.
-last
+last
Timestamp of the time the stats was updated
-memory
+memory
The memory stats for the node.
-op
players
+op
players
The amount of players on the node.
-playing
+playing
The amount of playing players on the node.
-uptime
+uptime
The uptime for the node.
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.StopPayload.html b/docs/interfaces/Utils.StopPayload.html
index 8016817..ce5b5b0 100644
--- a/docs/interfaces/Utils.StopPayload.html
+++ b/docs/interfaces/Utils.StopPayload.html
@@ -1 +1 @@
-StopPayload | lavacoffee Interface StopPayload
Generated using TypeDoc
\ No newline at end of file
+StopPayload | lavacoffee Interface StopPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TimeScale.html b/docs/interfaces/Utils.TimeScale.html
index d750318..279b774 100644
--- a/docs/interfaces/Utils.TimeScale.html
+++ b/docs/interfaces/Utils.TimeScale.html
@@ -1 +1 @@
-TimeScale | lavacoffee Interface TimeScale
Generated using TypeDoc
\ No newline at end of file
+TimeScale | lavacoffee Interface TimeScale
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackData.html b/docs/interfaces/Utils.TrackData.html
index ab92075..032d200 100644
--- a/docs/interfaces/Utils.TrackData.html
+++ b/docs/interfaces/Utils.TrackData.html
@@ -1 +1 @@
-TrackData | lavacoffee Interface TrackData
Generated using TypeDoc
\ No newline at end of file
+TrackData | lavacoffee Interface TrackData
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackEndPayload.html b/docs/interfaces/Utils.TrackEndPayload.html
index 151a54e..8d51c74 100644
--- a/docs/interfaces/Utils.TrackEndPayload.html
+++ b/docs/interfaces/Utils.TrackEndPayload.html
@@ -1 +1 @@
-TrackEndPayload | lavacoffee Interface TrackEndPayload
Generated using TypeDoc
\ No newline at end of file
+TrackEndPayload | lavacoffee Interface TrackEndPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackExceptionPayload.html b/docs/interfaces/Utils.TrackExceptionPayload.html
index 73cafd9..29792dc 100644
--- a/docs/interfaces/Utils.TrackExceptionPayload.html
+++ b/docs/interfaces/Utils.TrackExceptionPayload.html
@@ -1 +1 @@
-TrackExceptionPayload | lavacoffee Interface TrackExceptionPayload
Generated using TypeDoc
\ No newline at end of file
+TrackExceptionPayload | lavacoffee Interface TrackExceptionPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackInfo.html b/docs/interfaces/Utils.TrackInfo.html
index 6b283c6..ad34366 100644
--- a/docs/interfaces/Utils.TrackInfo.html
+++ b/docs/interfaces/Utils.TrackInfo.html
@@ -1 +1 @@
-TrackInfo | lavacoffee Interface TrackInfo
Generated using TypeDoc
\ No newline at end of file
+TrackInfo | lavacoffee Interface TrackInfo
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackStartPayload.html b/docs/interfaces/Utils.TrackStartPayload.html
index 071698a..4cac8d9 100644
--- a/docs/interfaces/Utils.TrackStartPayload.html
+++ b/docs/interfaces/Utils.TrackStartPayload.html
@@ -1 +1 @@
-TrackStartPayload | lavacoffee Interface TrackStartPayload
Generated using TypeDoc
\ No newline at end of file
+TrackStartPayload | lavacoffee Interface TrackStartPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TrackStuckPayload.html b/docs/interfaces/Utils.TrackStuckPayload.html
index 89406d4..1c04b0f 100644
--- a/docs/interfaces/Utils.TrackStuckPayload.html
+++ b/docs/interfaces/Utils.TrackStuckPayload.html
@@ -1 +1 @@
-TrackStuckPayload | lavacoffee Interface TrackStuckPayload
Generated using TypeDoc
\ No newline at end of file
+TrackStuckPayload | lavacoffee Interface TrackStuckPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.TracksData.html b/docs/interfaces/Utils.TracksData.html
index f602e76..8574dab 100644
--- a/docs/interfaces/Utils.TracksData.html
+++ b/docs/interfaces/Utils.TracksData.html
@@ -1 +1 @@
-TracksData | lavacoffee Interface TracksData
Generated using TypeDoc
\ No newline at end of file
+TracksData | lavacoffee Interface TracksData
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Tremolo.html b/docs/interfaces/Utils.Tremolo.html
index 9d59e1c..7642e50 100644
--- a/docs/interfaces/Utils.Tremolo.html
+++ b/docs/interfaces/Utils.Tremolo.html
@@ -1,5 +1,5 @@
-Tremolo | lavacoffee Interface Tremolo
Hierarchy
- Tremolo
Index
Properties
depth
+Tremolo | lavacoffee Interface Tremolo
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.Vibrato.html b/docs/interfaces/Utils.Vibrato.html
index ae6c348..8a0587f 100644
--- a/docs/interfaces/Utils.Vibrato.html
+++ b/docs/interfaces/Utils.Vibrato.html
@@ -1,5 +1,5 @@
-Vibrato | lavacoffee Interface Vibrato
Hierarchy
- Vibrato
Index
Properties
depth
+Vibrato | lavacoffee Interface Vibrato
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.VoiceServerUpdate.html b/docs/interfaces/Utils.VoiceServerUpdate.html
index 19e68e2..e745636 100644
--- a/docs/interfaces/Utils.VoiceServerUpdate.html
+++ b/docs/interfaces/Utils.VoiceServerUpdate.html
@@ -1 +1 @@
-VoiceServerUpdate | lavacoffee Interface VoiceServerUpdate
Generated using TypeDoc
\ No newline at end of file
+VoiceServerUpdate | lavacoffee Interface VoiceServerUpdate
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.VoiceStatePayload.html b/docs/interfaces/Utils.VoiceStatePayload.html
index afa0712..b1db241 100644
--- a/docs/interfaces/Utils.VoiceStatePayload.html
+++ b/docs/interfaces/Utils.VoiceStatePayload.html
@@ -1 +1 @@
-VoiceStatePayload | lavacoffee Interface VoiceStatePayload
Generated using TypeDoc
\ No newline at end of file
+VoiceStatePayload | lavacoffee Interface VoiceStatePayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.VoiceStateUpdate.html b/docs/interfaces/Utils.VoiceStateUpdate.html
index ea376dc..2d464bc 100644
--- a/docs/interfaces/Utils.VoiceStateUpdate.html
+++ b/docs/interfaces/Utils.VoiceStateUpdate.html
@@ -1 +1 @@
-VoiceStateUpdate | lavacoffee Interface VoiceStateUpdate
Hierarchy
- VoiceStateUpdate
Index
Properties
d
Type declaration
Optional channel_
deaf: boolean
guild_
mute: boolean
Optional request_
self_
self_
Optional self_
self_
session_
suppress: boolean
user_
op
s
t
Generated using TypeDoc
\ No newline at end of file
+VoiceStateUpdate | lavacoffee Interface VoiceStateUpdate
Hierarchy
- VoiceStateUpdate
Index
Properties
d
Type declaration
Optional channel_
deaf: boolean
guild_
mute: boolean
Optional request_
self_
self_
Optional self_
self_
session_
suppress: boolean
user_
op
s
t
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.VoiceUpdatePayload.html b/docs/interfaces/Utils.VoiceUpdatePayload.html
index e2a330c..23ba5a1 100644
--- a/docs/interfaces/Utils.VoiceUpdatePayload.html
+++ b/docs/interfaces/Utils.VoiceUpdatePayload.html
@@ -1 +1 @@
-VoiceUpdatePayload | lavacoffee Interface VoiceUpdatePayload
Hierarchy
- OutgoingPayload
- VoiceUpdatePayload
Index
Properties
event
Type declaration
endpoint: string
guild_
token: string
guild
op
session
Generated using TypeDoc
\ No newline at end of file
+VoiceUpdatePayload | lavacoffee Interface VoiceUpdatePayload
Hierarchy
- OutgoingPayload
- VoiceUpdatePayload
Index
Properties
event
Type declaration
endpoint: string
guild_
token: string
guild
op
session
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.VolumePayload.html b/docs/interfaces/Utils.VolumePayload.html
index 8e1aff4..cb9b84e 100644
--- a/docs/interfaces/Utils.VolumePayload.html
+++ b/docs/interfaces/Utils.VolumePayload.html
@@ -1 +1 @@
-VolumePayload | lavacoffee Interface VolumePayload
Generated using TypeDoc
\ No newline at end of file
+VolumePayload | lavacoffee Interface VolumePayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/interfaces/Utils.WebSocketClosedPayload.html b/docs/interfaces/Utils.WebSocketClosedPayload.html
index cd53240..5881bb6 100644
--- a/docs/interfaces/Utils.WebSocketClosedPayload.html
+++ b/docs/interfaces/Utils.WebSocketClosedPayload.html
@@ -1 +1 @@
-WebSocketClosedPayload | lavacoffee Interface WebSocketClosedPayload
Generated using TypeDoc
\ No newline at end of file
+WebSocketClosedPayload | lavacoffee Interface WebSocketClosedPayload
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/modules.html b/docs/modules.html
index 29fd18c..600ab6e 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1 +1 @@
-lavacoffee lavacoffee
Index
References
Namespaces
Classes
Interfaces
Variables
References
Coffee
Renames and re-exports FilterUtilsVariables
version
Generated using TypeDoc
\ No newline at end of file
+lavacoffee lavacoffee
Index
References
Namespaces
Classes
Interfaces
Variables
References
Coffee
Renames and re-exports FilterUtilsVariables
version
Generated using TypeDoc
\ No newline at end of file
diff --git a/docs/modules/Utils.html b/docs/modules/Utils.html
index c4fc3ac..cf70c53 100644
--- a/docs/modules/Utils.html
+++ b/docs/modules/Utils.html
@@ -1 +1 @@
-Utils | lavacoffee Namespace Utils
Index
Enumerations
Classes
Interfaces
- Channel
- Destroy
- Distortion
- Equalizer
- Event
- Filters
- Filters
- Incoming
- Karaoke
- Lava
- Low
- NodeCPUStats
- Node
- Node
- Node
- Node
- Outgoing
- Pause
- Play
- Play
- Player
- Player
- Playlist
- Rotation
- Search
- Search
- Seek
- Stats
- Stop
- Time
- Track
- Track
- Track
- Track
- Track
- Track
- Tracks
- Tremolo
- Vibrato
- Voice
- Voice
- Voice
- Voice
- Volume
- Web
Type aliases
Type aliases
Event
Incoming
Outgoing
Search
Tracks
Generated using TypeDoc
\ No newline at end of file
+Utils | lavacoffee Namespace Utils
Index
Enumerations
Classes
Interfaces
- Channel
- Destroy
- Distortion
- Equalizer
- Event
- Filters
- Filters
- Incoming
- Karaoke
- Lava
- Low
- NodeCPUStats
- Node
- Node
- Node
- Node
- Outgoing
- Pause
- Play
- Play
- Player
- Player
- Playlist
- Rotation
- Search
- Search
- Seek
- Stats
- Stop
- Time
- Track
- Track
- Track
- Track
- Track
- Track
- Tracks
- Tremolo
- Vibrato
- Voice
- Voice
- Voice
- Voice
- Volume
- Web
Type aliases
Type aliases
Event
Incoming
Outgoing
Search
Tracks
Generated using TypeDoc
\ No newline at end of file
The main hub for interacting with Lavalink and using LavaCoffee
-