Interface: RestPlayOptions

Defines the payload for starting or controlling playback through Lavalink's REST endpoint.
Supports specifying the track (by encoded string or identifier), playback settings, filters, and voice connection parameters.

---

RestPlayOptions

Main structure containing playback options for a specific guild.

Property	Type	Description	Optional
guildId	string	The ID of the guild where playback is controlled.
data	RestPlayData	Playback details and parameters.

---

RestPlayData

Playback details for a specific track and player state.

Property	Type	Description	Optional
encodedTrack	string	Base64-encoded track string. Alternative to identifier.
identifier	string	Track identifier (e.g. YouTube video ID). Alternative to encodedTrack.
startTime	number	Playback start position in milliseconds.
endTime	number	Playback end position in milliseconds.
volume	number	Playback volume level (0–1000).
position	number	Current playback position in milliseconds.
paused	boolean	Whether the player should be paused.
filters	object	Audio filters to apply.
voice	LavalinkVoiceStateUpdate	Voice connection payload sent to the Lavalink node.
noReplace	boolean	If true, prevents replacing the currently playing track when a new play payload is sent.