Lavalink-Client
  • 😁Lavalink Client
  • Basics
    • How it works
    • Get Started
    • Example Discord Bot
  • Documentation
    • LavalinkManager
      • Manager Options
        • ManagerQueueOptions
          • QueueStoreManager
          • QueueChangesWatcher
        • ManagerPlayerOptions
          • RequestTransformer
          • AutoplayFunction
        • BotClientOptions
      • ManagerUtils
    • NodeManager
      • Types
        • LavalinkNode
        • LavalinkNodeOptions
    • Player
      • PlayerOptions
      • PlayerDestroyReasons
      • PlayerTypes
        • RepeatMode
        • PlayerJson
    • Other Types
      • EQBand
      • FilterData
        • KaraokeFilter
      • Track
        • TrackInfo
        • PluginInfo
      • UnresolvedTrack
      • UnresolvedQuery
      • LavalinkTrack
        • Base64
        • LavalinkTrackInfo
      • Payloads
        • GuildShardPayload
        • PlayerEvent
        • TrackStartEvent
        • TrackEndEvent
        • TrackStuckEvent
        • TrackExceptionEvent
        • WebSocketClosedEvent
      • SearchPlatform
        • LavalinkSearchPlatform
        • ClientSearchPlatform
      • SourceNames
        • LavalinkSourceNames
        • LavaSrc SourceNames (lavalink-plugin)
    • Other Utils and Classes
      • DefaultQueueStore
      • MiniMap
  • Requirements
  • Host a Lavalink-Server
    • application.yml Configuration
      • With Spotify, Deezer, Apple Music, etc.
    • Host via pm2
    • Host via systemd
    • Host via screen
  • ⚪Github
  • 📖Lavalink-Support Server
Powered by GitBook
On this page
  1. Documentation
  2. Player
  3. PlayerTypes

PlayerJson

PreviousRepeatModeNextOther Types

Last updated 1 year ago

Type:

Parameter
Type
Description

guildId

The GuildId of the Player

options

The Player's Creation Option

voiceChannelId

The VoiceChannel Id of the Player

textChannelId

The TextChannel Id of the Player

position

The current Position (included the calculated one)

lastPosition

The last Position, lavalink stated

volume

The Client sided Volume (included the VolumeDecrementer)

lavalinkVolume

The real Volume, lavalink is outputting

repeatMode

The Repeat mode of the Player

paused

If the Player is paused / not

playing

If the Player is actually supposed to be outputting audio

createdTimeStamp

When the Player was created (on Lavalink)

filters

The Filter Data(s) of the Player (not the filter states, the actual values)

Equalizer

The Equalizer(s) of the Player

nodeId

The Node of the Player

ping

{

}

The Ping of the Player

export interface PlayerJson {
    guildId: string;
    options: PlayerOptions;
    voiceChannelId: string;
    textChannelId?: string;
    position: number;
    lastPosition: number;
    volume: number;
    lavalinkVolume: number;
    repeatMode: RepeatMode;
    paused: boolean;
    playing: boolean;
    createdTimeStamp?: number;
    filters: FilterData;
    ping: {
        ws: number;
        lavalink: number;
    }
    equalizer: EQBand[];
    nodeId?: string;
}

|

|

[]

?

ws: ,

lavalink:

Object
string
PlayerOptions
string
null
string
null
number
number
number
number
RepeatMode
boolean
boolean
number
FilterData
EQBand
string
number
number