Interface: RestPlayOptions

Defines the payload for starting or controlling playback through Lavalink's REST endpoint.
Supports specifying the track, 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.
noReplace	boolean	If true, prevents replacing the currently playing track when a new play payload is sent.
data	RestPlayData	Playback details and parameters.

---

RestPlayData

Playback details for a specific track and player state.

Property	Type	Description	Optional
track	RestPlayTrack	The track to play.
position	number	Current playback position in milliseconds.
endTime	number	Playback end position in milliseconds.
volume	number	Playback volume level (0–1000).
paused	boolean	Whether the player should be paused.
filters	object	Audio filters to apply.
voice	LavalinkVoiceStateUpdate	Voice connection payload sent to the Lavalink node.

---

RestPlayTrack

Track specifier nested inside RestPlayData. Provide either encoded or identifier, not both.

Property	Type	Description	Optional
encoded	string | null	Base64-encoded Lavalink track string. Pass null to stop playback.
identifier	string | null	Track identifier (e.g. YouTube video ID). Alternative to encoded.
userData	object	Arbitrary user data attached to the track (e.g. requester information).