Skip to content

AudioResource

Defined in: packages/voice/src/resource.ts:138

An audio source for an AudioPlayer: a queue of 20 ms Opus frames filled ahead of playback. One resource plays once; create another to play the same input again.

T = unknown

readonly optional effects?: AudioEffect[]

Defined in: packages/voice/src/resource.ts:144

The effects in use, when created with effects. Changes apply from the next frame.


readonly live: boolean

Defined in: packages/voice/src/resource.ts:146

Whether it is a live source (live: true).


readonly metadata: T

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

What was passed as metadata.


playbackDuration: number = 0

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

Milliseconds of this resource the player has sent.


started: boolean = false

Defined in: packages/voice/src/resource.ts:150

Whether the player took its first frame.


readonly optional volume?: VolumeControl

Defined in: packages/voice/src/resource.ts:142

Inline volume, when created with inlineVolume: true.

get ended(): boolean

Defined in: packages/voice/src/resource.ts:184

Whether every frame has been read (or it failed, or was destroyed).

boolean


get error(): Error | undefined

Defined in: packages/voice/src/resource.ts:189

Why it ended early, if it failed.

Error | undefined


get readable(): boolean

Defined in: packages/voice/src/resource.ts:194

Whether a frame is ready now.

boolean

destroy(): void

Defined in: packages/voice/src/resource.ts:258

Stops reading: ends FFmpeg and the input, frees the codec. Safe to call twice.

void


read(): Uint8Array<ArrayBufferLike> | null | undefined

Defined in: packages/voice/src/resource.ts:245

Takes the next Opus frame.

Uint8Array<ArrayBufferLike> | null | undefined

A frame, undefined when none is ready yet (buffering), or null when the resource has ended.