Node class

Represents an active and running lavalink node

Properties

hashCode int
The hash code for this object.
no setterinherited
options NodeOptions
Node options, such as host, port, etc..
getter/setter pair
players UnmodifiableMapView<Snowflake, GuildPlayer>
Returns a map with all the players the node currently has
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stats StatsEvent?
Returns the last stats received by this node
no setter

Methods

autoSearch(String query, {SearchPlatform platform = SearchPlatform.youtube}) Future<Tracks>
Searches a provided query on selected platform (YouTube by default), if the query is a link it's searched directly by the link
createPlayer(Snowflake guildId) GuildPlayer
Create a new player for a specific guild
destroy(Snowflake guildId) → void
Destroys a player
disconnect() → void
Tells the node to disconnect from lavalink server
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pause(Snowflake guildId) → void
Pauses a guild player
play(Snowflake guildId, Track track, {bool replace = false, Duration startTime = const Duration(), Duration? endTime, Snowflake? requester, Snowflake? channelId}) PlayParameters
Get the PlayParameters object for a specific track
reconnect() → void
Tells the node to reconnect to lavalink server
resume(Snowflake guildId) → void
Resumes the track playback of a guild player
searchTracks(String query) Future<Tracks>
Searches a given query over the lavalink api and returns the results
seek(Snowflake guildId, Duration time) → void
Seeks for a given time at the currently playing track
setPause(Snowflake guildId, bool pauseState) → void
Set the pause state of a player
shutdown() → void
Shuts down the node
skip(Snowflake guildId) → void
Skips a track, starting the next one if available or stopping the player if not
stop(Snowflake guildId) → void
Stops a player
toString() String
A string representation of this object.
override
updateOptions(NodeOptions newOptions) → void
Updates the NodeOptions property of the node, also reconnects the websocket to the new options
volume(Snowflake guildId, int volume) → void
Sets the volume for a guild player, volume should be a number between 1 to 1000

Operators

operator ==(Object other) bool
The equality operator.
inherited