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.
Type Parameters
Section titled “Type Parameters”T = unknown
Properties
Section titled “Properties”effects?
Section titled “effects?”
readonlyoptionaleffects?:AudioEffect[]
Defined in: packages/voice/src/resource.ts:144
The effects in use, when created with effects. Changes apply from the next frame.
readonlylive:boolean
Defined in: packages/voice/src/resource.ts:146
Whether it is a live source (live: true).
metadata
Section titled “metadata”
readonlymetadata:T
Defined in: packages/voice/src/resource.ts:140
What was passed as metadata.
playbackDuration
Section titled “playbackDuration”playbackDuration:
number=0
Defined in: packages/voice/src/resource.ts:148
Milliseconds of this resource the player has sent.
started
Section titled “started”started:
boolean=false
Defined in: packages/voice/src/resource.ts:150
Whether the player took its first frame.
volume?
Section titled “volume?”
readonlyoptionalvolume?:VolumeControl
Defined in: packages/voice/src/resource.ts:142
Inline volume, when created with inlineVolume: true.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get ended():
boolean
Defined in: packages/voice/src/resource.ts:184
Whether every frame has been read (or it failed, or was destroyed).
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get error():
Error|undefined
Defined in: packages/voice/src/resource.ts:189
Why it ended early, if it failed.
Returns
Section titled “Returns”Error | undefined
readable
Section titled “readable”Get Signature
Section titled “Get Signature”get readable():
boolean
Defined in: packages/voice/src/resource.ts:194
Whether a frame is ready now.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/voice/src/resource.ts:258
Stops reading: ends FFmpeg and the input, frees the codec. Safe to call twice.
Returns
Section titled “Returns”void
read()
Section titled “read()”read():
Uint8Array<ArrayBufferLike> |null|undefined
Defined in: packages/voice/src/resource.ts:245
Takes the next Opus frame.
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike> | null | undefined
A frame, undefined when none is
ready yet (buffering), or null when the resource has ended.