API reference
API reference
Public types, methods, options, and events of discord-player v8.
You are reading the v8 docsDev
This reference covers the public API of the discord-player package on the v8 branch. For explanations and tasks, use the guides.
Player
Options, initialization, search, play, and lifecycle.
GuildQueue and node
Queue options, methods, state, and playback controls.
Events
Every event and its arguments.
Plugins
Definitions, registry, and operations.
Models
Track, Playlist, SearchResult, and storage.
Remedia configuration
Node options for embedded and remote playback.
The source of truth is the public entry point. Every exported type carries TypeScript documentation, so your editor shows it on hover.
Continue reading
Player