Player
The playback backend for one voice session, created lazily for a guild’s first queue item and released when the voice leaves.
An operation the backend cannot perform rejects with DisTubeError(UNSUPPORTED); core reports any
other rejection as VOICE_FAILED.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
position |
number |
Source time, in seconds, of the audio the platform last played, or 0 without a track. A tempo preset changes how fast it advances, not what it measures. |
Methods
Section titled “Methods”pause()
Section titled “pause()”pause():
Promise<void>
Returns
Section titled “Returns”Promise<void>
play()
Section titled “play()”play(
resource,options):Promise<Readonly<{reason:"finished"|"stopped"|"replaced"; }>>
Plays resource unpaused, whatever the previous track’s pause, replacing the current track, which settles
replaced first. Settles when the track ends.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
resource |
PlaybackResource |
options |
TrackOptions |
Returns
Section titled “Returns”Promise<Readonly<{ reason: "finished" | "stopped" | "replaced"; }>>
release()
Section titled “release()”release():
Promise<void>
Ends any active track as stopped and releases backend state once. Every call, concurrent, repeated or after
the Player closed on its own, settles from that one teardown; later play and controls reject.
Returns
Section titled “Returns”Promise<void>
resume()
Section titled “resume()”resume():
Promise<void>
Returns
Section titled “Returns”Promise<void>
seek()
Section titled “seek()”seek(
seconds):Promise<void>
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
seconds |
number |
Returns
Section titled “Returns”Promise<void>
setFilters()
Section titled “setFilters()”setFilters(
entries):Promise<void>
Renders the ordered filter set; an empty list clears it.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entries |
readonly FilterEntry[] |
Returns
Section titled “Returns”Promise<void>
setVolume()
Section titled “setVolume()”setVolume(
percent):Promise<void>
Percentage from 0 to 1000, kept for later tracks.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
percent |
number |
Returns
Section titled “Returns”Promise<void>
stopTrack()
Section titled “stopTrack()”stopTrack():
Promise<void>
Ends the active track as stopped, leaving the Player usable.
Returns
Section titled “Returns”Promise<void>
updateVoiceGateway()?
Section titled “updateVoiceGateway()?”
optionalupdateVoiceGateway(gateway):Promise<void>
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
gateway |
VoiceGatewayData |
Returns
Section titled “Returns”Promise<void>