Interface: RestPlayOptions
This interface defines the payload for starting or controlling playback through Lavalink's REST endpoint.
It supports specifying the track (either encoded or by identifier), playback settings, filters, and voice connection parameters.
RestPlayOptions
Main structure containing playback options for a specific guild.
Property Type Description Optional guildIdstring The ID of the guild where playback is controlled. dataRestPlayDataPlayback details and parameters.
RestPlayData
Playback details for a specific track and player state.
Property Type Description Optional encodedTrackstring The base64 encoded track to play. identifierstring The track identifier (alternative to encodedTrack).startTimenumber The position (in milliseconds) to start playback. endTimenumber The position (in milliseconds) to end playback. volumenumber The volume level for playback (0–1000). positionnumber The current playback position in milliseconds. pausedboolean Whether the player is paused. filtersobject Audio effects or filters to apply. voiceVoicePayloadVoice connection details for playback. noReplaceboolean If true, prevents replacing the currently playing track when a new play payload is sent.
VoicePayload
Information required to connect the player to Discord voice.
Property Type Description Optional tokenstring Discord voice token. sessionIdstring Voice session ID. endpointstring Discord voice server endpoint.