discord-player
Discord Player is a framework for creating Discord bots that interact with the Discord Voice API.
Classes
AFilterGraph
Docs for class AFilterGraph
AsyncQueue
Docs for class AsyncQueue
AsyncQueueEntry
Docs for class AsyncQueueEntry
AudioFilters
Docs for class AudioFilters
AudioPlayer
Used to play audio resources (i.e. tracks, streams) to voice connections.
BaseExtractor
Docs for class BaseExtractor
Context
Docs for class Context
DiscordPlayerQueryResultCache
Docs for class DiscordPlayerQueryResultCache
ExtractorExecutionContext
Docs for class ExtractorExecutionContext
FFmpeg
Docs for class FFmpeg
FFmpegFilterer
Docs for class FFmpegFilterer
FiltersChain
Docs for class FiltersChain
GuildNodeManager
Docs for class GuildNodeManager
GuildQueue
Docs for class GuildQueue
GuildQueueAudioFilters
Docs for class GuildQueueAudioFilters
GuildQueueHistory
Docs for class GuildQueueHistory
GuildQueuePlayerNode
Docs for class GuildQueuePlayerNode
GuildQueueStatistics
Docs for class GuildQueueStatistics
LrcLib
Docs for class LrcLib
Player
Docs for class Player
PlayerEventsEmitter
Docs for class PlayerEventsEmitter
Playlist
Docs for class Playlist
QueryCache
Docs for class QueryCache
QueryResolver
Docs for class QueryResolver
SearchResult
Docs for class SearchResult
SequentialBucket
Docs for class SequentialBucket
StreamDispatcher
Docs for class StreamDispatcher
Track
Docs for class Track
TypeUtil
Docs for class TypeUtil
Util
Docs for class Util
VoiceUtils
Docs for class VoiceUtils
VolumeTransformer
Docs for class VolumeTransformer
Types
AsyncQueueAcquisitionOptions
Docs for type AsyncQueueAcquisitionOptions
CreateAudioPlayerOptions
Options that can be passed when creating an audio player, used to specify its behavior.
CreateStreamOps
Docs for type CreateStreamOps
DependenciesReport
Docs for type DependenciesReport
ExtractorExecutionEvents
Docs for type ExtractorExecutionEvents
ExtractorExecutionResult
Docs for type ExtractorExecutionResult
ExtractorInfo
Docs for type ExtractorInfo
ExtractorSearchContext
Docs for type ExtractorSearchContext
ExtractorSession
Docs for type ExtractorSession
FFmpegOptions
Docs for type FFmpegOptions
FFmpegSource
Docs for type FFmpegSource
FFmpegStreamOptions
Docs for type FFmpegStreamOptions
FilterGraph
Docs for type FilterGraph
GuildNodeCreateOptions
Docs for type GuildNodeCreateOptions
GuildNodeInit
Docs for type GuildNodeInit
GuildQueueAFiltersCache
Docs for type GuildQueueAFiltersCache
GuildQueueEvents
Docs for type GuildQueueEvents
GuildQueueStatisticsMetadata
Docs for type GuildQueueStatisticsMetadata
GuildQueueTimeline
Docs for type GuildQueueTimeline
JoinConfig
Docs for type JoinConfig
JoinVoiceChannelOptions
The options that can be given when joining a voice channel.
LrcGetParams
Docs for type LrcGetParams
LrcSearchParams
Docs for type LrcSearchParams
LrcSearchResult
Docs for type LrcSearchResult
PackageJSON
Docs for type PackageJSON
PlayOptions
Docs for type PlayOptions
PlayerEvents
Docs for type PlayerEvents
PlayerInitOptions
Docs for type PlayerInitOptions
PlayerNodeInitializationResult
Docs for type PlayerNodeInitializationResult
PlayerNodeInitializerOptions
Docs for type PlayerNodeInitializerOptions
PlayerProgressbarOptions
Docs for type PlayerProgressbarOptions
PlayerSearchResult
Docs for type PlayerSearchResult
PlayerTimestamp
Docs for type PlayerTimestamp
PlaylistInitData
Docs for type PlaylistInitData
PlaylistJSON
Docs for type PlaylistJSON
PostProcessedResult
Docs for type PostProcessedResult
QueryCacheOptions
Docs for type QueryCacheOptions
QueryCacheProvider
Docs for type QueryCacheProvider
QueryCacheResolverContext
Docs for type QueryCacheResolverContext
QueueFilters
Represents FFmpeg filters
RawTrackData
Docs for type RawTrackData
ResolvedFFmpegSource
Docs for type ResolvedFFmpegSource
ResolvedQuery
Docs for type ResolvedQuery
ResourcePlayOptions
Docs for type ResourcePlayOptions
Runtime
Docs for type Runtime
SearchOptions
Docs for type SearchOptions
SearchResultData
Docs for type SearchResultData
SkipOptions
Docs for type SkipOptions
StreamConfig
Docs for type StreamConfig
TimeData
Docs for type TimeData
TimelineDispatcherOptions
Docs for type TimelineDispatcherOptions
TrackJSON
Docs for type TrackJSON
VoiceConnectConfig
Docs for type VoiceConnectConfig
VoiceEvents
Docs for type VoiceEvents
ArgPrimitive
Docs for type ArgPrimitive
AsyncQueueExceptionHandler
Docs for type AsyncQueueExceptionHandler
BiquadFilters
Docs for type BiquadFilters
ContextReceiver
The receiver function that will be called when the context is provided
Encodable
Docs for type Encodable
ExtractorExecutionFN
Docs for type ExtractorExecutionFN
ExtractorResolvable
Docs for type ExtractorResolvable
ExtractorStreamable
Docs for type ExtractorStreamable
FFmpegCallback
Docs for type FFmpegCallback
FFmpegLib
Docs for type FFmpegLib
FFmpegReport
Docs for type FFmpegReport
FiltersName
Docs for type FiltersName
GuildQueueEvent
Docs for type GuildQueueEvent
LrcGetResult
Docs for type LrcGetResult
MaybeNull
Docs for type MaybeNull
MetadataDispatch
Docs for type MetadataDispatch
NextFunction
Docs for type NextFunction
NodeResolvable
Docs for type NodeResolvable
OnAfterCreateStreamHandler
Docs for type OnAfterCreateStreamHandler
OnBeforeCreateStreamHandler
Docs for type OnBeforeCreateStreamHandler
PCMFilters
Docs for type PCMFilters
PlayerEvent
Docs for type PlayerEvent
PlayerTriggeredReason
Docs for type PlayerTriggeredReason
QueryExtractorSearch
Docs for type QueryExtractorSearch
RequestEntity
Docs for type RequestEntity
RuntimeType
Docs for type RuntimeType
SearchQueryType
Docs for type SearchQueryType
SerializedPlaylist
Docs for type SerializedPlaylist
SerializedTrack
Docs for type SerializedTrack
SetterFN
Docs for type SetterFN
TrackLike
Docs for type TrackLike
TrackResolvable
Docs for type TrackResolvable
TrackSource
The track source: - soundcloud - youtube - spotify - apple_music - arbitrary
VoiceStateHandler
Docs for type VoiceStateHandler
WithMetadata
Docs for type WithMetadata
Functions
FFMPEG_ARGS_PIPED
Docs for function FFMPEG_ARGS_PIPED
FFMPEG_ARGS_STRING
Docs for function FFMPEG_ARGS_STRING
VALIDATE_QUEUE_CAP
Docs for function VALIDATE_QUEUE_CAP
createAudioPlayer
Creates a new AudioPlayer to be used.
createContext
Create a new context. The default value is optional.
createErisCompat
Allows Eris clients to be used with discord-player. When this method is called, discord-player creates a proxy object that intercepts certain methods and properties to make it compatible with discord-player.
createFFmpegArgs
Create FFmpeg arguments from an object.
createFFmpegStream
Creates FFmpeg stream
decode
Docs for function decode
deserialize
Docs for function deserialize
encode
Docs for function encode
getVoiceConnection
Finds a voice connection with the given guild id and group. Defaults to the 'default' group.
getVoiceConnections
Retrieves all the voice connections under the 'default' group.
isErisProxy
Docs for function isErisProxy
joinVoiceChannel
Creates a VoiceConnection to a Discord voice channel.
onAfterCreateStream
Global onAfterCreateStream handler
onBeforeCreateStream
Global onBeforeCreateStream handler
serialize
Docs for function serialize
tryIntoThumbnailString
Docs for function tryIntoThumbnailString
useContext
Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
useHistory
Fetch guild queue history
useMainPlayer
Fetch main player instance
useMetadata
Fetch or manipulate guild queue metadata
usePlayer
Fetch guild queue player node
useQueue
Fetch guild queue.
useTimeline
Fetch or manipulate current track
useVolume
Fetch or manipulate player volume
Variables
AF_NIGHTCORE_RATE
Docs for variable AF_NIGHTCORE_RATE
AF_VAPORWAVE_RATE
Docs for variable AF_VAPORWAVE_RATE
BASS_EQ_BANDS
Docs for variable BASS_EQ_BANDS
BiquadFilterType
Docs for variable BiquadFilterType
DependencyReportGenerator
A utility to generate a report of the dependencies used by the discord-player module.
EqualizerConfigurationPreset
Docs for variable EqualizerConfigurationPreset
FFMPEG_SRATE_REGEX
Docs for variable FFMPEG_SRATE_REGEX
GuildQueueEvent
Docs for variable GuildQueueEvent
PCMAudioFilters
Docs for variable PCMAudioFilters
PlayerEvent
Docs for variable PlayerEvent
Q_BUTTERWORTH
Docs for variable Q_BUTTERWORTH
QueryType
The search query type This can be one of: - AUTO - YOUTUBE - YOUTUBE_PLAYLIST - SOUNDCLOUD_TRACK - SOUNDCLOUD_PLAYLIST - SOUNDCLOUD - SPOTIFY_SONG - SPOTIFY_ALBUM - SPOTIFY_PLAYLIST - SPOTIFY_SEARCH - FACEBOOK - VIMEO - ARBITRARY - REVERBNATION - YOUTUBE_SEARCH - YOUTUBE_VIDEO - SOUNDCLOUD_SEARCH - APPLE_MUSIC_SONG - APPLE_MUSIC_ALBUM - APPLE_MUSIC_PLAYLIST - APPLE_MUSIC_SEARCH - FILE - AUTO_SEARCH
version
Docs for variable version