Skip to main content
Version: v2.10.3

RestPlayOptions

NodeLink extras and native filter keys are guarded on ordinary Lavalink nodes. Low-level updates do not automatically maintain the local queue; prefer Player helpers for playback.

Definition​

export interface RestPlayOptions {
	/** The guild ID the Player belongs to. */
	guildId: string;
	/** Whether to not replace the track if a play payload is sent. */
	noReplace?: boolean;
	data: {
		/** The base64 encoded track. */
		track?: {
			/** The base64 encoded track. */
			encoded?: string | null;
			/** The track ID. */
			identifier?: string | null;
			/** The user data of the track. */
			userData?: object;
			/** NodeLink optional audio track id for alternate audio tracks. */
			audioTrackId?: string | null;
			/** Legacy NodeLink alias for audioTrackId. */
			language?: string | null;
		};
		/** NodeLink next track preload payload. */
		nextTrack?: {
			encoded?: string | null;
			identifier?: string | null;
			userData?: object;
			audioTrackId?: string | null;
			language?: string | null;
		} | null;
		/** NodeLink loudness normalizer toggle. */
		loudnessNormalizer?: boolean;
		/** NodeLink playback fading configuration. */
		fading?: NodeLinkFadingConfig;
		/** The player position in a track. */
		position?: number;
		/** The track time to end at. */
		endTime?: number;
		/** The player volume level. */
		volume?: number;
		/** Whether the player is paused. */
		paused?: boolean;
		/** The audio effects. */
		filters?: LavalinkFilters;
		/** voice payload. */
		voice?: LavalinkVoiceStateUpdate;
	};
}

RestPlayData​

RestPlayOptions["data"] is the nested update body in the definition above, not a separate exported RestPlayData interface. It contains shared updates and the guarded native extras.

RestPlayTrack​

RestPlayOptions["data"]["track"] is the optional track update object. An encoded null clears playback; audioTrackId and language are native options. There is no separate exported RestPlayTrack interface.