Skip to main content

Player & Queue

The Player and Queue classes provide playback and track management for Yukino. Below are their APIs and usage examples.

Player API​

Constructor​

// Usually created via YukinoClient.createPlayer(options)

Methods​

Playback Control​

MethodDescriptionExample
play()Start playbackplayer.play()
pause()Pause playbackplayer.pause()
resume()Resume playbackplayer.resume()
stop()Stop playbackplayer.stop()
destroy()Clean up playerplayer.destroy()

Track Management​

MethodDescriptionExample
skip()Skip to next trackplayer.skip()
seek(position)Jump to position (ms)player.seek(60000)
setVolume(volume)Set volume (0-1000)player.setVolume(100)
fade({from, to, duration})Fade volume over timeplayer.fade({from: 100, to: 50, duration: 5000})

Loop Control​

Method/PropertyDescriptionExample
setLoop(mode)Set loop modeplayer.setLoop('track')
loopGet current loop modeconsole.log(player.loop)

Filters & Effects​

MethodDescriptionExample
setFilter(name, options)Apply single filterplayer.setFilter('equalizer', [...])
setFilters(filtersObj)Apply multiple filtersplayer.setFilters({...})
resetFilter(name)Remove specific filterplayer.resetFilter('equalizer')
resetFilters()Remove all filtersplayer.resetFilters()

Voice Connection​

MethodDescriptionExample
updateVoice(options)Change voice settingsplayer.updateVoice({...})
reconnect()Reconnect to voiceplayer.reconnect()

Status & Events​

Method/PropertyDescriptionExample
statsGet playback statisticsconst stats = player.stats
on(event, callback)Register event handlerplayer.on('trackStart', (track) => {...})
cleanup(options)Resource managementplayer.cleanup({...})

Queue API​

Methods​

Adding/Removing Tracks​

MethodDescriptionExample
add(track)Add single trackplayer.queue.add(track)
addMany(tracks)Add multiple tracksplayer.queue.addMany([track1, track2])
remove(index)Remove track by indexplayer.queue.remove(0)
clear()Clear entire queueplayer.queue.clear()

Queue Manipulation​

MethodDescriptionExample
shuffle()Randomize queue orderplayer.queue.shuffle()
move(from, to)Move track positionplayer.queue.move(0, 2)
filter(predicate)Filter tracksplayer.queue.filter(track => track.info.length < 300000)

Queue Information​

Property/MethodDescriptionExample
lengthNumber of tracksconsole.log(player.queue.length)
currentCurrently playing trackconst track = player.queue.current
next()Get & remove next trackconst nextTrack = player.queue.next()
nextTrackGet next track (no removal)const upcoming = player.queue.nextTrack

Note: queue.next() removes and returns the next track. queue.nextTrack returns the next track without removing it.


Example Usage​

const player = yukino.createPlayer({
guildId: 'guild-id',
voiceChannelId: 'channel-id',
textChannelId: 'text-channel-id'
});

player.play();
player.queue.add(track);
player.setVolume(100);