Functions
Functions provided by discord-player
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