Player
Hierarchy
- unknown
- Player
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
poru: Poru
node: Node
options: ConnectionOptions
Returns Player
Properties
publicconnection
The connection associated with the player.
publiccurrentTrack
The currently playing track
publicreadonlydata
publicdeaf
Indicated whether the player is set to be deafened
publicfilters
Filters applied to the player's audio.
publicguildId
The guild ID associated with the player.
publicisAutoPlay
Indicated whether autoplay mode is enabled.
publicisConnected
Indicates whether the player is connected to a voice channel.
publicisPaused
Indicates whether the player is connected to a voice channel.
publicisPlaying
Indicates whether the player is currently playing a track.
publicisQuietMode
Indicated whether quiet mode is enabled for the player.
publicloop
The loop settings for the player.
publicmute
Indicates whether the player is set to be muted.
publicnode
The node associated with the player.
publicping
The current delay estimate of the player (in milliseconds)
publicporu
The Poru instance associated with the player.
publicposition
The current position of the player in the track (in milliseconds)
publicpreviousTrack
The previously played track
publicqueue
The queue of tracks for the player.
publictextChannel
The text channel ID associated with the player.
publictimestamp
The timestamp of the player's state
publicvoiceChannel
The guild ID associated with the player.
publicvolume
The volume of the player (0-1000)
Methods
publicautoMoveNode
Automatically moves the player to a less used node.
Returns Promise<void | Player>
- A Promise that resolves to the Player instance or void.
publicautoplay
Enables autoplay functionality for the player.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicconnect
Connects the player to a voice channel.
Parameters
optionaloptions: ConnectionOptions = ...
The options for the connection.
Returns void
publicdestroy
Destroys the player and cleans up associated resources.
Returns Promise<boolean>
- A Promise that resolves to a boolean which is true if an element in the Map existed and has been removed, or false if the element does not exist.
publiceventHandler
publicget
Retrieves a custom data value associated with the player.
Type parameters
- K
Parameters
key: string
The key for the data value.
Returns K
- The retrieved value.
publicgetLyrics
This function is used to get lyrics of the current track.
Parameters
optionalencodedTrack: null | string
The encoded track to get the lyrics from
Returns Promise<null | NodeLinkGetLyrics>
publicmoveNode
Moves the player to a different node.
Parameters
name: string
The name of the target node.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicpause
Pauses or resumes playback.
Parameters
optionaltoggle: boolean = true
Specifies whether to pause or resume playback.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicplay
Initiates playback of the next track in the queue.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicremoveVoiceReceiverConnection
Returns Promise<boolean>
publicresolve
Resolves a query to obtain audio tracks.
Parameters
options: ResolveOptions
The options for resolving the query.
Returns Promise<Response>
- A Promise that resolves to a Response object containing the resolved tracks.
publicrestart
Restarts playback from the current track.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicseekTo
Seeks to a specific position in the current track.
Parameters
position: number
The position to seek to (in milliseconds).
Returns Promise<void>
publicsend
Sends data to the Poru system.
Parameters
data: any
The data to send.
Returns void
publicset
Sets a custom data value associated with the player.
Type parameters
- K
Parameters
key: string
The key for the data value.
value: K
The value to set.
Returns K
- The set value.
publicsetLoop
Sets the loop mode of the player.
Parameters
mode: Loop
The loop mode to set.
Returns this
- The Player instance.
publicsetTextChannel
Sets the text channel associated with the player.
Parameters
channel: string
The ID of the text channel.
Returns this
- The Player instance.
publicsetVoiceChannel
Sets the voice channel associated with the player.
Parameters
channel: string
The ID of the voice channel.
optionaloptions: Required<Omit<ConnectionOptions, guildId | region | textChannel | voiceChannel>>
The options for the connection.
Returns this
- The Player instance.
publicsetVolume
Sets the volume level of the player.
Parameters
volume: number
The volume level (0 to 1000).
Returns Promise<Player>
- A Promise that resolves to the Player instance.
publicsetupVoiceReceiverConnection
Returns Promise<boolean>
publicskip
Skips the current track.
Returns Promise<Player>
- A Promise that resolves to the Player instance.
Represents a player capable of playing audio tracks.