ManagerOptions
An object defining configuration options for the Manager instance.
NodeOptions
Options for adjusting the node of audio.
PlayerOptions
Options for the player.
AlbumSearchResult
Result returned when an album is found by a search.
AnyGuild
Options for the AnyGuild.
AnyMessage
Options for the AnyMessage.
AnyUser
Options for the AnyUser.
ArtistSearchResult
Result returned when an artist is found by a search.
AutoplayChangeEvent
The event emitted when a player's autoplay state changes.
ChannelChangeEvent
The event emitted when a player's channel changes.
ConnectionChangeEvent
The event emitted when a player's connection state changes.
DiscordPacket
An object representing a raw Discord WebSocket packet used with the .send() function.
EndSpeakingEventVoiceReceiverData
Payload emitted when a user stops speaking in a voice channel.
ErrorOrEmptySearchResult
Returned when a search yields no results or an error occurs.
Exception
Exception details from Lavalink.
Extendable
Internal structure allowing extension and injection of core components like Player, Queue, and Node.
FilterChangeEvent
The event emitted when a player's filters change.
Filters
7 items
IQueue
Defines the contract for all queue implementations, providing track management operations.
JsonConfig
Configuration options for JSON file-based state storage.
LavaPlayer
Represents the complete state of an active music player.
LavalinkInfo
Represents detailed information about the Lavalink server instance.
LavalinkResponse
The base response returned by Lavalink for search and load requests.
LavalinkVoiceStateResponse
Voice connection state returned by the Lavalink node.
LavalinkVoiceStateUpdate
Voice connection payload sent to the Lavalink node to establish or update a voice connection.
LoadType
A type alias referring to the key of the LoadTypes enum.
Lyrics
Represents a full lyrics result including metadata, raw text, and parsed lines.
LyricsEvent
A type alias referring to the LyricsEvent type.
LyricsEventType
Union of all events from Lyrics related events.
LyricsLine
Represents a single line of synchronised lyrics with timing and metadata.
ManagerEvents
7 items
ManagerInitOptions
Configuration options for the manager.
NodeLinkGetLyrics
A type alias referring to the NodeLinkGetLyrics events.
NodeLinkGetLyricsData
Represents synced or unsynced lyrics data returned by Lavalink plugins.
NodeLinkGetLyricsEmpty
Represents an empty response when no lyrics could be retrieved.
NodeLinkGetLyricsError
Represents an error response when lyrics could not be retrieved.
NodeLinkGetLyricsMultiple
Represents a response containing multiple synced or unsynced lyric variants.
NodeLinkGetLyricsSingle
Represents a response containing a single synced or unsynced lyric variant.
NodeMessage
Extends NodeStats with metadata for Lavalink payload handling.
NodeStats
Represents the stats payload from a Lavalink node.
PauseChangeEvent
The event emitted when a player's pause state changes.
PlayOptions
Options for customizing Lavalink's playback behavior.
PlayerEvents
5 items
PlayerEvents
Union of all events from PlayerEvents.
PlayerStateUpdateEvent
The event emitted when a player's state is updated.
PlayerUpdateVoiceState
An object representing the voice state update event from Discord.
PlaylistData
Metadata and details of a playlist.
PlaylistInfoData
Detailed metadata about a playlist.
PlaylistRawData
Represents the raw data structure of a playlist returned by Lavalink.
PlaylistSearchResult
Result returned when a playlist is found by a search.
PodcastSearchResult
Result returned when a podcast is found by a search.
PortableMessage
Options for the PortableMessage.
PortableUser
Options for the PortableUser.
QueueChangeEvent
The event emitted when the queue state of a player changes.
RedisConfig
Configuration options for Redis-based state storage.
RepeatChangeEvent
The event emitted when a player's repeat mode changes.
RestPlayOptions
Represents the options for initiating or modifying playback via the REST API.
SearchQuery
An object representing a music search query with optional platform source.
SearchResult
Union of all possible search results.
SearchSearchResult
Returned when a search yields multiple matching results.
SerializedPlayerState
Represents the serialized state of a player, used for persistence and restoration.
Severity
A type alias referring to the key of the SeverityTypes enum.
ShortSearchResult
Result returned when a short is found by a search.
ShowSearchResult
Result returned when a show is found by a search.
Sizes
Union of all possible sizes of the display thumbnail of a Track.
SponsorBlockSegmentEvents
A type alias referring to the SponsorBlockSegmentEvents type.
SponsorBlockSegmentEventsType
Union of all events from SponsorBlock related events.
StandaloneManagerOptions
Manager options for direct new Manager(...) usage without a built-in wrapper.
StartSpeakingEventVoiceReceiverData
Represents the data payload emitted when a user starts speaking in a voice channel.
StateStorageOptions
An object describing persistent state storage configuration for the manager.
StationSearchResult
Result returned when a station is found by a search.
Track
Represents a playable audio track within the player.
TrackChangeEvent
The event emitted when a player's track changes.
TrackData
A container object for a single encoded Lavalink track and its metadata.
TrackDataInfo
Detailed metadata for a track returned by Lavalink.
TrackEndReason
A type alias referring to the key of the TrackSourceTypes enum.
TrackPluginInfo
Additional plugin-specific metadata attached to a track.
TrackSearchResult
Returned when a search yields a single track result.
TrackSourceName
A type alias referring to the key of the TrackSourceTypes enum.
UseNopeOption
A type alias referring to the key of the UseNodeOptions enum.
VoicePacket
Represents a raw voice-related packet received by the manager.
VoiceReceiverEvent
A type alias referring to the VoiceReceiverEvent type.
VoiceReceiverEvents
3 items
VoiceServer
Represents the voice server update data from Discord.
VoiceServerUpdate
Configuration options for JSON file-based state storage.
VoiceState
Voice state types used across MagmaStream.
VolumeChangeEvent
The event emitted when a player's volume changes.