LavalinkPlayerController class

Controls player operations and manages queue with advanced features

Available extensions

• AudioFiltersExtension
• QueueExtension
• SeekExtension
• VolumeExtension

Constructors

LavalinkPlayerController({required LavalinkRestClient restClient, required LavalinkWebSocket webSocket, required String guildId, bool autoPlay = true})

Properties

activeFilters → Map<String, dynamic>?

no setter

autoPlay → bool

no setter

currentTrack → Track?

no setter

guildId → String

final

hashCode → int

The hash code for this object.

no setter, inherited

hasNext → bool

no setter

hasPrevious → bool

no setter

history → List<Track>

no setter

isPaused → bool

no setter

isPlaying → bool

no setter

isStopped → bool

no setter

position → Duration

no setter

queue → List<Track>

no setter

queueDuration → Duration

Get total queue duration

no setter

queueDuration → Duration

Available on LavalinkPlayerController, provided by the QueueExtension extension

Get total queue duration

no setter

queueLength → int

Get queue length

no setter

queueLength → int

Available on LavalinkPlayerController, provided by the QueueExtension extension

Get queue length

no setter

queueStream → Stream<List<Track>>

no setter

repeatMode → RepeatMode

no setter

repeatStream → Stream<RepeatMode>

no setter

restClient → LavalinkRestClient

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stateStream → Stream<PlayerState>

no setter

trackStream → Stream<Track?>

no setter

volume → int

no setter

webSocket → LavalinkWebSocket

final

Methods

addAllToQueue(List<Track> tracks) → void

Add multiple tracks to queue

addToQueue(Track track) → void

Add track to queue

apply8D() → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply 8D audio effect

applyBassBoost([int level = 2]) → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply bass boost filter

applyKaraoke() → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply karaoke filter (remove vocals)

applyNightcore() → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply nightcore filter (speed up + pitch up)

applyTremolo({double frequency = 2.0, double depth = 0.5}) → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply tremolo effect

applyVaporwave() → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply vaporwave filter (slow down + pitch down)

applyVibrato({double frequency = 2.0, double depth = 0.5}) → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Apply vibrato effect

clearFilters() → Future<void>

Clear all filters

clearHistory() → void

Clear history

clearQueue() → void

Clear entire queue

cycleRepeatMode() → void

Cycle through repeat modes (off -> track -> queue -> off)

dispose() → Future<void>

Dispose the controller and cleanup

getPlayerInfo() → Future<Player>

Get current player info from server

getQueueInfo() → String

Get formatted queue information

insertInQueue(Track track, int position) → void

Insert track at specific position in queue

insertInQueue(Track track, int position) → void

Available on LavalinkPlayerController, provided by the QueueExtension extension

Insert track at specific position in queue

moveInQueue(int from, int to) → void

Move track from one position to another

moveInQueue(int from, int to) → void

Available on LavalinkPlayerController, provided by the QueueExtension extension

Move track from one position to another

mute() → Future<void>

Available on LavalinkPlayerController, provided by the VolumeExtension extension

Mute audio (volume to 0)

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pause() → Future<void>

Pause playback (can be resumed)

play(Track track, {bool immediate = true, bool addToHistory = false}) → Future<void>

Play a track immediately or add to queue

playNext() → Future<void>

Play next track in queue

playPrevious() → Future<void>

Play previous track from history

removeFromQueue(int index) → void

Remove track from queue by index

removeTrackFromQueue(Track track) → void

Remove specific track from queue

removeTrackFromQueue(Track track) → void

Available on LavalinkPlayerController, provided by the QueueExtension extension

Remove specific track from queue

restart() → Future<void>

Available on LavalinkPlayerController, provided by the SeekExtension extension

Restart current track

resume() → Future<void>

Resume playback from paused state

reverseQueue() → void

Reverse the queue

reverseQueue() → void

Available on LavalinkPlayerController, provided by the QueueExtension extension

Reverse the queue

seek(Duration position) → Future<void>

Seek to position in current track

seekBackward(Duration duration) → Future<void>

Available on LavalinkPlayerController, provided by the SeekExtension extension

Seek backward by specified duration

seekForward(Duration duration) → Future<void>

Available on LavalinkPlayerController, provided by the SeekExtension extension

Seek forward by specified duration

setAutoPlay(bool enabled) → void

Set auto-play (automatically play next track)

setFilters(Map<String, dynamic> filters) → Future<void>

Apply audio filters (equalizer, karaoke, timescale, etc.)

setPitch(double pitch) → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Set pitch (0.5 to 2.0)

setRepeatMode(RepeatMode mode) → void

Set repeat mode

setSpeed(double speed) → Future<void>

Available on LavalinkPlayerController, provided by the AudioFiltersExtension extension

Set playback speed (0.5 to 2.0)

setVolume(int volume) → Future<void>

Set volume (0-200, default 100)

shuffleQueue() → void

Shuffle the queue

skip() → Future<void>

Skip to next track in queue

skipTo(int index) → Future<void>

Skip to specific track in queue by index

skipToTrack(String encoded) → Future<void>

Skip to track by encoded value

stop({bool shouldClearQueue = false}) → Future<void>

Stop playback completely (clears current track)

syncWithServer() → Future<void>

Force sync player state with server

togglePause() → Future<void>

Toggle pause/resume

toString() → String

A string representation of this object.

inherited

unmute() → Future<void>

Available on LavalinkPlayerController, provided by the VolumeExtension extension

Unmute audio (restore to 100 if currently 0)

volumeDown([int amount = 10]) → Future<void>

Available on LavalinkPlayerController, provided by the VolumeExtension extension

Decrease volume by amount

volumeUp([int amount = 10]) → Future<void>

Available on LavalinkPlayerController, provided by the VolumeExtension extension

Increase volume by amount

Operators

operator ==(Object other) → bool

The equality operator.

inherited