AudioPlayer
Defined in: packages/voice/src/player.ts:56
Plays AudioResources to subscribed connections: one 20 ms Opus frame per tick, on a self-correcting clock. The clock runs only while there is something to send; an idle or paused player has no timer.
Extends
Section titled “Extends”Emitter<AudioPlayerEvents>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioPlayer(
options?):AudioPlayer
Defined in: packages/voice/src/player.ts:66
Parameters
Section titled “Parameters”options?
Section titled “options?”AudioPlayerOptions = {}
Returns
Section titled “Returns”AudioPlayer
Overrides
Section titled “Overrides”Emitter<AudioPlayerEvents>.constructor
Accessors
Section titled “Accessors”resource
Section titled “resource”Get Signature
Section titled “Get Signature”get resource():
AudioResource<unknown> |undefined
Defined in: packages/voice/src/player.ts:80
The resource playing (or paused), if any.
Returns
Section titled “Returns”AudioResource<unknown> | undefined
Get Signature
Section titled “Get Signature”get state():
AudioPlayerStatus
Defined in: packages/voice/src/player.ts:75
Current status.
Returns
Section titled “Returns”subscribers
Section titled “subscribers”Get Signature
Section titled “Get Signature”get subscribers():
ReadonlySet<AudioSink>
Defined in: packages/voice/src/player.ts:85
Subscribed connections.
Returns
Section titled “Returns”ReadonlySet<AudioSink>
ticking
Section titled “ticking”Get Signature
Section titled “Get Signature”get ticking():
boolean
Defined in: packages/voice/src/player.ts:90
Whether the clock is running (for tests and diagnostics).
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”off<
K>(event,listener):this
Defined in: packages/voice/src/emitter.ts:21
Removes a listener.
Type Parameters
Section titled “Type Parameters”K extends keyof AudioPlayerEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(…args) => unknown
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Emitter.off
on<
K>(event,listener):this
Defined in: packages/voice/src/emitter.ts:8
Adds a listener.
Type Parameters
Section titled “Type Parameters”K extends keyof AudioPlayerEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(…args) => unknown
Returns
Section titled “Returns”this
Throws
Section titled “Throws”If it is not a function.
Inherited from
Section titled “Inherited from”Emitter.on
pause()
Section titled “pause()”pause(
silence?):boolean
Defined in: packages/voice/src/player.ts:120
Pauses.
Parameters
Section titled “Parameters”silence?
Section titled “silence?”boolean = true
Send five silence frames first (default true).
Returns
Section titled “Returns”boolean
Whether it paused.
play()
Section titled “play()”play(
resource):void
Defined in: packages/voice/src/player.ts:105
Plays resource, replacing (and destroying) the current one.
Parameters
Section titled “Parameters”resource
Section titled “resource”AudioResource<unknown>
Returns
Section titled “Returns”void
Throws
Section titled “Throws”If the resource already ended or was played before.
resume()
Section titled “resume()”resume():
boolean
Defined in: packages/voice/src/player.ts:140
Alias of unpause.
Returns
Section titled “Returns”boolean
stop()
Section titled “stop()”stop(
force?):boolean
Defined in: packages/voice/src/player.ts:148
Stops and destroys the resource.
Parameters
Section titled “Parameters”force?
Section titled “force?”boolean = false
Skip the five silence frames.
Returns
Section titled “Returns”boolean
Whether anything was playing.
unpause()
Section titled “unpause()”unpause():
boolean
Defined in: packages/voice/src/player.ts:131
Resumes after pause().
Returns
Section titled “Returns”boolean
Whether it resumed.