Class Player

Hierarchy

EventEmitter
- Player

Index

Constructors

constructor

Properties

Constructors

constructor

new Player(node: LavalinkNode, options: PlayerOptions): Player

Overrides EventEmitter.__constructor
- Defined in src/lib/Player.ts:18
Parameters
- node: LavalinkNode
- options: PlayerOptions
Returns Player

Properties

channel

channel: string

client

client: Client

id

id: string

manager

manager: PlayerManager

node

node: LavalinkNode

paused

paused: boolean

playing

playing: boolean

state

state: PlayerState

timestamp

timestamp: number | null

track

track: string | null

voiceUpdateState

voiceUpdateState: PlayerUpdateVoiceState | null

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.addListener
- Defined in node_modules/@types/node/globals.d.ts:547
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

connect

connect(data: PlayerUpdateVoiceState): Promise<boolean>

- Defined in src/lib/Player.ts:109
Parameters
- data: PlayerUpdateVoiceState
Returns Promise<boolean>

destroy

destroy(): Promise<boolean>

- Defined in src/lib/Player.ts:105
Returns Promise<boolean>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from Player.emit
- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

equalizer

equalizer(bands: PlayerEqualizerBand[]): Promise<boolean>

- Defined in src/lib/Player.ts:99
Parameters
- bands: PlayerEqualizerBand[]
Returns Promise<boolean>

eventNames

eventNames(): Array<string | symbol>

Inherited from Player.eventNames
- Defined in node_modules/@types/node/globals.d.ts:562
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from Player.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from Player.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Player.listeners
- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.off
- Defined in node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.on
- Defined in node_modules/@types/node/globals.d.ts:548
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.once
- Defined in node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(pause: boolean): Promise<boolean>

- Defined in src/lib/Player.ts:79
Parameters
- pause: boolean
Returns Promise<boolean>

play

play(track: string, options?: PlayerPlayOptions): Promise<boolean>

- Defined in src/lib/Player.ts:64
Parameters
- track: string
- Default value options: PlayerPlayOptions = {}
Returns Promise<boolean>

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.prependListener
- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Player.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Player.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Player.removeListener
- Defined in node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): Promise<boolean>

- Defined in src/lib/Player.ts:85
Returns Promise<boolean>

seek

seek(position: number): Promise<boolean>

- Defined in src/lib/Player.ts:95
Parameters
- position: number
Returns Promise<boolean>

setMaxListeners

setMaxListeners(n: number): this

Inherited from Player.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns this

stop

stop(): Promise<boolean>

- Defined in src/lib/Player.ts:72
Returns Promise<boolean>

volume

volume(volume: number): Promise<boolean>

- Defined in src/lib/Player.ts:89
Parameters
- volume: number
Returns Promise<boolean>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Player.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc