Skip to content

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.

new AudioPlayer(options?): AudioPlayer

Defined in: packages/voice/src/player.ts:66

AudioPlayerOptions = {}

AudioPlayer

Emitter<AudioPlayerEvents>.constructor

get resource(): AudioResource<unknown> | undefined

Defined in: packages/voice/src/player.ts:80

The resource playing (or paused), if any.

AudioResource<unknown> | undefined


get state(): AudioPlayerStatus

Defined in: packages/voice/src/player.ts:75

Current status.

AudioPlayerStatus


get subscribers(): ReadonlySet<AudioSink>

Defined in: packages/voice/src/player.ts:85

Subscribed connections.

ReadonlySet<AudioSink>


get ticking(): boolean

Defined in: packages/voice/src/player.ts:90

Whether the clock is running (for tests and diagnostics).

boolean

off<K>(event, listener): this

Defined in: packages/voice/src/emitter.ts:21

Removes a listener.

K extends keyof AudioPlayerEvents

K

(…args) => unknown

this

Emitter.off


on<K>(event, listener): this

Defined in: packages/voice/src/emitter.ts:8

Adds a listener.

K extends keyof AudioPlayerEvents

K

(…args) => unknown

this

If it is not a function.

Emitter.on


pause(silence?): boolean

Defined in: packages/voice/src/player.ts:120

Pauses.

boolean = true

Send five silence frames first (default true).

boolean

Whether it paused.


play(resource): void

Defined in: packages/voice/src/player.ts:105

Plays resource, replacing (and destroying) the current one.

AudioResource<unknown>

void

If the resource already ended or was played before.


resume(): boolean

Defined in: packages/voice/src/player.ts:140

Alias of unpause.

boolean


stop(force?): boolean

Defined in: packages/voice/src/player.ts:148

Stops and destroys the resource.

boolean = false

Skip the five silence frames.

boolean

Whether anything was playing.


unpause(): boolean

Defined in: packages/voice/src/player.ts:131

Resumes after pause().

boolean

Whether it resumed.