Skip to content

PlayOptions

Defined in: src/structures/Types/Player.ts:116

Property (defined in)TypeDescription
clientTrack?
(Adds track on queue and skips to it)
\UnresolvedTrack \
endTime?
(src/structures/Types/Player.ts:91)
numberThe position to end the track.
filters?
(LavalinkPlayOptions.filters)
Partial<LavalinkFilterData>The Lavalink Filters to use
noReplace?
(src/structures/Types/Player.ts:118)
booleanWhether to not replace the track if a play payload is sent.
paused?
(src/structures/Types/Player.ts:93)
booleanIf to start “paused”
position?
(src/structures/Types/Player.ts:89)
numberThe position to start the track.
track?
(LavalinkPlayOptions.track)
objectWhich Track to play
track.audioTrackId?
(src/structures/Types/Player.ts:113)
stringNodeLink Specific audioTrackId option
track.encoded?
(src/structures/Types/Player.ts:105)
stringThe track encoded base64 string to use instead of the one from the queue system
track.identifier?
(src/structures/Types/Player.ts:107)
stringThe identifier of the track to use
track.requester?
(src/structures/Types/Player.ts:111)
unknownThe Track requester for when u provide encodedTrack / identifer
track.userData?
(src/structures/Types/Player.ts:109)
anyObjectCustom User Data for the track to provide, will then be on the userData object from the track
voice?
(src/structures/Types/Player.ts:99)
LavalinkPlayerVoiceOptionsVoice Update for Lavalink
volume?
(src/structures/Types/Player.ts:95)
numberThe Volume to start with