Class Player<T>

Type parameters

T: BaseNode = BaseNode

Hierarchy

EventEmitter
- Player

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Player<T>(node: T, guildID: string): Player<T>

Overrides EventEmitter.constructor
- Defined in core/Player.ts:38
Type parameters
- T: BaseNode<T> = BaseNode
Parameters
- node: T
- guildID: string
Returns Player<T>

Properties

guildID

guildID: string

Private lastPosition

lastPosition: null | IncomingPlayerUpdatePayloadState = null

Readonly node

node: T

status

status: Status = Status.Instantiated

Accessors

paused

get paused(): boolean

- Defined in core/Player.ts:75
Returns boolean

playing

get playing(): boolean

- Defined in core/Player.ts:71
Returns boolean

position

get position(): number

- Defined in core/Player.ts:94
Returns number

voiceServer

get voiceServer(): null | GatewayVoiceServerUpdateDispatchData

- Defined in core/Player.ts:90
Returns null | GatewayVoiceServerUpdateDispatchData

voiceState

get voiceState(): null | GatewayVoiceState

- Defined in core/Player.ts:79
Returns null | GatewayVoiceState

Methods

destroy

destroy(): Promise<void>

- Defined in core/Player.ts:212
Returns Promise<void>

join

join(channel: null | string, __namedParameters?: JoinOptions): unknown

- Defined in core/Player.ts:117
Parameters
- channel: null | string
- __namedParameters: JoinOptions = {}
Returns unknown

leave

leave(): unknown

- Defined in core/Player.ts:113
Returns unknown

moveTo

moveTo(node: BaseNode): Promise<void>

- Defined in core/Player.ts:103
Parameters
- node: BaseNode
Returns Promise<void>

pause

pause(pause?: boolean): Promise<void>

- Defined in core/Player.ts:192
Parameters
- pause: boolean = true
Returns Promise<void>

play

play(track: string | Track, __namedParameters?: PlayerOptions): Promise<void>

- Defined in core/Player.ts:134
Parameters
- track: string | Track
- __namedParameters: PlayerOptions = {}
Returns Promise<void>

seek

seek(position: number): Promise<void>

- Defined in core/Player.ts:184
Parameters
- position: number
Returns Promise<void>

send

send(data: OutgoingPayload): Promise<void>

- Defined in core/Player.ts:232
Parameters
- data: OutgoingPayload
Returns Promise<void>

setEqualizer

setEqualizer(equalizer: readonly EqualizerBand[]): Promise<void>

- Defined in core/Player.ts:176
Parameters
- equalizer: readonly EqualizerBand[]
  
  The equalizer bads to be set.
Returns Promise<void>

setFilters

setFilters(options: FilterOptions): Promise<void>

- Defined in core/Player.ts:154
Sets the filters for the player.

note
This is not available in Lavalink v3.3.

Parameters
- options: FilterOptions
  
  The filters to be sent.
Returns Promise<void>

setVolume

setVolume(volume: number): Promise<void>

- Defined in core/Player.ts:165
Parameters
- volume: number
  
  The new volume to be set.
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in core/Player.ts:203
Returns Promise<void>

voiceUpdate

voiceUpdate(sessionId: string, event: GatewayVoiceServerUpdateDispatchData): Promise<void>

- Defined in core/Player.ts:223
Parameters
- sessionId: string
- event: GatewayVoiceServerUpdateDispatchData
Returns Promise<void>

Generated using TypeDoc