Skip to content

Player & Queue State

The Player Transformer ({player})

Exposes the live state of the guild’s Lavalink audio player instance.

Base Object: RythraPlayer
Aliases: {player}
Null Behavior: Defaults to volume 0, loop none, playing false when idle.

Attributes Table

PropertyTypeDescriptionRaw Example
{player.playing}booleantrue if player is currently emitting audiotrue
{player.paused}booleantrue if player is pausedfalse
{player.hasTrack}booleantrue if a track is loaded in current slottrue
{player.volume}numberActive audio volume level (0 to 200)75
{player.loop}stringLoop mode (none, track, queue)track
{player.position}numberCurrent player position in ms124000
{player.positionFormatted}stringFormatted player position02:04
{player.state}stringWebSocket connection state (CONNECTED, IDLE)CONNECTED
{player.quality}stringDynamic audio quality profileauto
{player.alwaysOn}boolean24/7 channel presence statusfalse
{player.queueSize}numberNumber of tracks waiting in queue4
{player.totalSize}numberTotal tracks (current + queue)5
{player.queueDuration}stringFormatted total queue length16:30
{player.channelId}stringVoice Channel ID connected to947967652675072055
{player.textId}stringText Channel ID bound for player responses947967652675072052

The Queue Transformer ({queue})

Inspects upcoming tracks, queue size, and total queue length.

Attributes Table

PropertyTypeDescriptionRaw Example
{queue.size}numberNumber of queued tracks (excluding current)8
{queue.totalSize}numberTotal queue count including active song9
{queue.duration}numberTotal queue duration in milliseconds1840000
{queue.durationFormatted}stringFormatted total queue duration30:40
{queue.isEmpty}booleantrue if queue has 0 waiting tracksfalse
{queue.first}stringTitle of the next track upLevitating
{queue.last}stringTitle of the last track in queueBlinding Lights
{queue.list}stringFormatted list of first 10 upcoming tracks1. Levitating\n2. Circles

Example Usage

Queue Overview Tag

{embed(title):📑 Server Music Queue}
{embed(description):{if({queue.isEmpty}==true):Queue is currently empty!|**Upcoming Tracks:**\n{queue.list}}}
{embed(field):Queue Size~{queue.size} songs~true}
{embed(field):Total Duration~{queue.durationFormatted}~true}
{embed(color):0x5865F2}