📢 Join our official Discord support server →
Documentation
Classes
discord-player
Player

Player extends PlayerEventsEmitter<PlayerEvents>

new Player(client, options)
ParameterTypeOptionalDescription
clientClient<boolean>❌The Discord Client
optionsPlayerInitOptions✅The player init options

Properties

private #lagMonitorInterval: Timer

private #lagMonitorTimeout: Timeout

private #lastLatency: number

private #voiceStateUpdateListener: (oldState: VoiceState, newState: VoiceState) => void

public client: Client<boolean>

public events: PlayerEventsEmitter<GuildQueueEvents<unknown>>

public extractors: ExtractorExecutionContext

public id: string

public nodes: GuildNodeManager<unknown>

public options: PlayerInitOptions

public requiredEvents: Array<keyof PlayerEvents>

public voiceUtils: VoiceUtils

public static _singletonKey: symbol

public static defaultMaxListeners: number

  • Source: packages/utils/dist/index.d.ts#L42

public eventLoopLag: number

Event loop lag

public queryCache: null | QueryCache

The current query cache provider

public queues: GuildNodeManager<unknown>

Alias to

Methods

public [iterator](): Generator<GuildQueue<unknown>, void, undefined>

private _handleVoiceState(oldState, newState): undefined

ParameterTypeOptionalDescription
oldStateVoiceState❌-
newStateVoiceState❌-

public addListener(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L44

public createPlaylist(data): Playlist

Creates

ParameterTypeOptionalDescription
dataPlaylistInitData❌The data to initialize a playlist

public debug(m): boolean

ParameterTypeOptionalDescription
mstring❌-

public destroy(): Promise<void>

Destroy player

public emit(name, args): boolean

ParameterTypeOptionalDescription
nameK❌-
argsParameters<PlayerEvents[K]>❌-

public eventNames(): Array<U>

  • Source: packages/utils/dist/index.d.ts#L53

public generateStatistics(): { instances: number,queryCacheEnabled: boolean,queues: Array<GuildQueueStatisticsMetadata>,queuesCount: number }

Generates statistics

public getMaxListeners(): number

  • Source: packages/utils/dist/index.d.ts#L57

public handleVoiceState(oldState, newState): void

Handles voice state update

ParameterTypeOptionalDescription
oldStateVoiceState❌The old voice state
newStateVoiceState❌The new voice state

public isVoiceStateHandlerLocked(): boolean

Checks if voice state handler is locked

public listenerCount(type): number

ParameterTypeOptionalDescription
typekeyof PlayerEvents❌-
  • Source: packages/utils/dist/index.d.ts#L54

public listeners(type): Array<PlayerEvents[U]>

ParameterTypeOptionalDescription
typeU❌-
  • Source: packages/utils/dist/index.d.ts#L55

public lockVoiceStateHandler(): void

Lock voice state handler

public off(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L51

public on(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L50

public once(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L49

public play(channel, query, options): Promise<{ extractor: null | BaseExtractor,queue: GuildQueue<T>,searchResult: SearchResult,track: Track }>

Initiate audio player

ParameterTypeOptionalDescription
channelGuildVoiceChannelResolvable❌The voice channel on which the music should be played
querystring | Track | SearchResult❌The track or source to play
optionsSearchOptions & { afterSearch: (result: SearchResult) => Promise<SearchResult>,connectionOptions: VoiceConnectConfig,nodeOptions: GuildNodeCreateOptions<T> }❌Options for player

public prependListener(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L45

public prependOnceListener(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L46

public rawListeners(type): Array<PlayerEvents[U]>

ParameterTypeOptionalDescription
typeU❌-
  • Source: packages/utils/dist/index.d.ts#L56

public removeAllListeners(event?): Player

ParameterTypeOptionalDescription
eventkeyof PlayerEvents✅-
  • Source: packages/utils/dist/index.d.ts#L48

public removeListener(event, listener): Player

ParameterTypeOptionalDescription
eventU❌-
listenerPlayerEvents[U]❌-
  • Source: packages/utils/dist/index.d.ts#L47

public scanDeps(): string

Generates a report of the dependencies used by the

public search(query, options): Promise<SearchResult>

Search tracks

ParameterTypeOptionalDescription
querystring | Track❌The search query
optionsSearchOptions❌The search options

public setMaxListeners(n): Player

ParameterTypeOptionalDescription
nnumber❌-
  • Source: packages/utils/dist/index.d.ts#L58

public unlockVoiceStateHandler(): void

Unlock voice state handler

public static clearAllPlayers(): void

Clear all player instances

public static getAllPlayers(): Array<Player>

Get all active player instances

public static singleton(client, options): Player

Creates discord-player singleton instance.

ParameterTypeOptionalDescription
clientClient<boolean>❌The client that instantiated player
optionsPlayerInitOptions❌Player initializer options
GuildQueuePlayerNodePlayerError