Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CoffeePlayer

Hierarchy

  • CoffeePlayer

Index

Constructors

constructor

Properties

filters

filters: Filters = {}

The player filters

lastUpdated

lastUpdated: number = ...

Timestamp of the time the player was last updated

Readonly lava

The player manager

loop

loop: LoopMode = LoopMode.None

The player loop mode

needResume

needResume: boolean = false

Whether the player need to be resumed after connected

Readonly options

options: PlayerOptions

The player options

Optional playOptions

playOptions?: PlayOptions

The player play options if its currently playing

position

position: number = 0

The player position in milliseconds

Readonly queue

The queue for the player

replaying

replaying: boolean = false

Whether the player is currently replaying

state

state: PlayerStates = PlayerStates.Paused

The player state

voice

voice: VoiceUpdatePayload = ...

The player voice payload

voiceConnected

voiceConnected: boolean = false

Whether the player is connected to voice on node-side

voiceState

voiceState: PlayerVoiceStates = PlayerVoiceStates.Disconnected

The player voice state

Accessors

absolutePosition

  • get absolutePosition(): number

guildID

  • get guildID(): string

node

voiceID

  • get voiceID(): string
  • set voiceID(voiceID: string): void

volume

  • get volume(): number

Methods

connect

  • connect(): void

destroy

  • destroy(): void

disconnect

  • disconnect(): void

get

  • get<T>(key: string): undefined | T

patchFilters

  • patchFilters(): void

pause

  • pause(pause: boolean): void

play

seek

  • seek(position: number): void

set

  • set(key: string, value: unknown): void

setFilters

setLoop

setNode

  • setNode(node: string): void

setVolume

  • setVolume(volume?: number): void

stop

  • stop(amount?: number): void
  • Stops the current track, optionally give an amount to skip to, e.g 5 would play the 5th song

    Parameters

    • Optional amount: number

    Returns void

Generated using TypeDoc