🎵 LavaPlayer

Success

This documentation page includes all the elements from the module LavaPlayer.

Load Local Track

|Since|v2.0.0|class:version|

Loads a local track from the files of your server. The supported file types are: - MP3 - FLAC - WAV - Matroska/WebM (AAC, Opus or Vorbis codecs) - MP4/M4A (AAC codec) - OGG streams (Opus, Vorbis and FLAC codecs) - AAC streams - Stream playlists (M3U and PLS)

ExamplesPatterns

load local track from "plugins/music/mytrack.mp3" and store it in {_track}

load local track [from] [the] [file] %string% and store (it|the track) in %-objects%

Pause Track

|Since|v2.0.0|class:version|

Pause the current track & player. This won't clear the queue, nor will remove the current track. You can use 'resume track' to resume the track.

ExamplesPatterns

pause the track of event-guild

pause [the] (audio|track) (in|of) [the] [guild] %guild% [with [the] [bot] %bot%]

Resume Track

|Since|v2.0.0|class:version|

Resume the current track & player, if it's paused.

ExamplesPatterns

resume the track of event-guild

resume [the] (audio|track) (in|of) [the] [guild] %guild% [with [the] [bot] %bot%]

Skip Track

|Since|v2.0.0|class:version|

Skip the current track of a guild player. The new track will be returned.

ExamplesPatterns

skip the track of event-guild and store it in {_track}
skip track of event-guild

skip [the] (audio|track) (in|of) [the] [guild] %guild% [with [the] [bot] %bot%] [and store (it|[the] audiotrack) in %-objects%]

Stop Track

|Since|v2.0.0|class:version|

Stop the current track of a guild player. This will also remove the current track from the queue.

ExamplesPatterns

stop the track of event-guild

stop [the] (audio|track) (in|of) [the] [guild] %guild% [with [the] [bot] %bot%]

Loaded Playlist

Represent the loaded playlist in a 'on playlist loaded' sub-load section.

ExamplesPatterns

loaded playlist

[the] loaded playlist

Loaded Track

Represent the loaded track in a 'on single load' sub-load section.

ExamplesPatterns

loaded track

[the] loaded track

Load Exception

Represent the exception that occurred during the load of a research or items. This is the message only.

ExamplesPatterns

the exception

[the] exception

Guild Playing Track

Get the current track playing in a guild. This cannot be changed via this expression, but you can use the 'play' effect to play a track.

ExamplesPatterns

set {_track} to playing track of event-guild

[all] [the] [audio] playing track of %guild%
[all] [the] %guild%'[s] [audio] playing track

Guild Queue

Represents the audio queue of a guild. You can get the queue, but also add or remove tracks from it.

ExamplesPatterns

if queue of event-guild is empty:
add {_track} to queue of event-guild

[all] [the] [audio] queue of %guild%
[all] [the] %guild%'[s] [audio] queue

Playlist Tracks

Get all the ordered tracks of a loaded playlist.

ExamplesPatterns

set {_tracks::*} to tracks of the loaded playlist

[all] [the] [audio[ ]]tracks of %audioplaylist%
[all] [the] %audioplaylist%'[s] [audio[ ]]tracks

Audio Mono Level

This is an audio effect/filter. Set the mono level of the current audio track. The default value is 1.0

ExamplesPatterns

set mono level of event-guild to 0.5

[the] (audio|track) mono [level] of %guild%
%guild%'[s] (audio|track) mono [level]

Audio Pitch

This is an audio effect/filter. Change the pitch of the current audio track. The default pitch is 1.0.

ExamplesPatterns

set audio speed of event-guild to 1.5

[the] (audio|track) pitch [level] of %guild%
%guild%'[s] (audio|track) pitch [level]

Audio Rotation

This is an audio effect/filter. Change the rotation of the current audio track. (Sort of 8D effect) The default rotation is 1

ExamplesPatterns

set audio rotation of event-guild to 2

[the] (audio|track) rotation [level] of %guild%
%guild%'[s] (audio|track) rotation [level]

Audio Speed

This is an audio effect/filter. Change the speed of the current audio track. The default speed is 1.0.

ExamplesPatterns

set audio speed of event-guild to 2

[the] (audio|track) speed [level] of %guild%
%guild%'[s] (audio|track) speed [level]

Guild Auto Play

If enabled, when a track ends, the next will be played automatically. By default, this is disabled.

ExamplesPatterns

set auto play of event-guild to true

[the] [auto[( |-)]]play [state] of %guild%
%guild%'[s] [auto[( |-)]]play [state]

Guild Repeat

If enabled, when a track ends, the same track will be played again. By default, this is disabled.

ExamplesPatterns

set repeat of event-guild to true

[the] [auto[( |-)]]repeat [state] of %guild%
%guild%'[s] [auto[( |-)]]repeat [state]

Guild Volume

Get the volume of a guild, or null if the guild have not player. This can be changed to change the audio volume of a guild. If the guild does not have any player, nothing will change. Note that the volume is a number between 0 and 1000.

ExamplesPatterns

set guild volume of event-guild to 100
set {_volume} to guild volume of event-guild

[the] [audio[ ]]guild volume of %guild%
%guild%'[s] [audio[ ]]guild volume

Playlist Name

Get the name of a loaded playlist.

ExamplesPatterns

playlist name of the loaded playlist

[the] [audio[ ]]playlist name of %audioplaylist%
%audioplaylist%'[s] [audio[ ]]playlist name