Class Player

constructor

• new Player(connection: WeakRef<Connection>): Player

  Parameters

  • connection: WeakRef<Connection>

  Returns Player

connection

ReadonlyguildId

node

• get node(): Node

  Returns Node

clearFilters

• clearFilters(): Promise<void>

  Clear all filters applied to the currently playing track

  Returns Promise<void>

destroy

• destroy(): Promise<void>

  Destroys the player in remote Lavalink side

  Returns Promise<void>

getData

• getData(): Promise<LavalinkPlayer>

  Gets the current player info from lavalink

  Returns Promise<LavalinkPlayer>

playTrack

• playTrack(playerOptions: PlayOptions, noReplace?: boolean): Promise<void>

  Play a new track

  Parameters

  • playerOptions: PlayOptions
  • noReplace: boolean = false

  Returns Promise<void>

seekTo

• seekTo(position: number): Promise<void>

  Seek to a specific time in the currently playing track

  Parameters

  • position: number

    Position to seek to in milliseconds

  Returns Promise<void>

sendServerUpdate

• sendServerUpdate(connection: Connection): Promise<void>
  Internal

  Sends server update to lavalink

  Parameters

  • connection: Connection

  Returns Promise<void>

setChannelMix

• setChannelMix(channelMix?: ChannelMixSettings): Promise<void>

  Change the channel mix settings applied to the currently playing track

  Parameters

  • OptionalchannelMix: ChannelMixSettings

    An object that conforms to ChannelMixSettings that defines how much the left and right channels affect each other (setting all factors to 0.5 causes both channels to get the same audio)

  Returns Promise<void>

setDistortion

• setDistortion(distortion?: DistortionSettings): Promise<void>

  Change the distortion settings applied to the currently playing track

  Parameters

  • Optionaldistortion: DistortionSettings

    An object that conforms to DistortionSettings that defines distortions in the audio

  Returns Promise<void>

  The current player instance

setEqualizer

• setEqualizer(equalizer: Band[]): Promise<void>

  Change the equalizer settings applied to the currently playing track

  Parameters

  • equalizer: Band[]

    An array of objects that conforms to the Bands type that define volumes at different frequencies

  Returns Promise<void>

setFilters

• setFilters(filters: FilterOptions): Promise<void>

  Change the all filter settings applied to the currently playing track

  Parameters

  • filters: FilterOptions

    An object that conforms to FilterOptions that defines all filters to apply/modify

  Returns Promise<void>

setFilterVolume

• setFilterVolume(volume: number): Promise<void>

  Sets the filter volume of the player

  Parameters

  • volume: number

    Target volume 0.0-5.0

  Returns Promise<void>

setGlobalVolume

• setGlobalVolume(volume: number): Promise<void>

  Sets the global volume of the player

  Parameters

  • volume: number

    Target volume 0-1000

  Returns Promise<void>

setKaraoke

• setKaraoke(karaoke?: KaraokeSettings): Promise<void>

  Change the karaoke settings applied to the currently playing track

  Parameters

  • Optionalkaraoke: KaraokeSettings

    An object that conforms to the KaraokeSettings type that defines a range of frequencies to mute

  Returns Promise<void>

setLowPass

• setLowPass(lowPass?: LowPassSettings): Promise<void>

  Change the low pass settings applied to the currently playing track

  Parameters

  • OptionallowPass: LowPassSettings

    An object that conforms to LowPassSettings that defines the amount of suppression on higher frequencies

  Returns Promise<void>

setPaused

• setPaused(paused?: boolean): Promise<void>

  Pause or unpause the currently playing track

  Parameters

  • paused: boolean = true

    Boolean value to specify whether to pause or unpause the current bot user

  Returns Promise<void>

setRotation

• setRotation(rotation?: RotationSettings): Promise<void>

  Change the rotation settings applied to the currently playing track

  Parameters

  • Optionalrotation: RotationSettings

    An object that conforms to the RotationSettings type that defines the frequency of audio rotating round the listener

  Returns Promise<void>

setTimescale

• setTimescale(timescale?: TimescaleSettings): Promise<void>

  Change the timescale settings applied to the currently playing track

  Parameters

  • Optionaltimescale: TimescaleSettings

    An object that conforms to the TimescaleSettings type that defines the time signature to play the audio at

  Returns Promise<void>

setTremolo

• setTremolo(tremolo?: FreqSettings): Promise<void>

  Change the tremolo settings applied to the currently playing track

  Parameters

  • Optionaltremolo: FreqSettings

    An object that conforms to the FreqSettings type that defines an oscillation in volume

  Returns Promise<void>

setVibrato

• setVibrato(vibrato?: FreqSettings): Promise<void>

  Change the vibrato settings applied to the currently playing track

  Parameters

  • Optionalvibrato: FreqSettings

    An object that conforms to the FreqSettings type that defines an oscillation in pitch

  Returns Promise<void>

stopTrack

• stopTrack(): Promise<void>

  Stop the currently playing track

  Returns Promise<void>

update

• update(
      playerOptions: UpdatePlayerOptions,
      noReplace?: boolean,
  ): Promise<LavalinkPlayer>

  If you want to update the whole player yourself, sends raw update player info to lavalink

  Parameters

  • playerOptions: UpdatePlayerOptions

    Options to update the player data
  • noReplace: boolean = false

    Set it to true if you don't want to replace the currently playing track

  Returns Promise<LavalinkPlayer>