Skip to content

VoiceReceiver

Defined in: packages/voice/src/receiver.ts:48

Receives other users’ audio (low level): decrypted Opus packets per user. SSRCs are mapped to users from op 5; decoding is up to you (createOpusCodec).

new VoiceReceiver(): VoiceReceiver

VoiceReceiver

get speaking(): ReadonlySet<string>

Defined in: packages/voice/src/receiver.ts:63

Users who sent audio in the last 100 ms.

ReadonlySet<string>

off(event, listener): this

Defined in: packages/voice/src/receiver.ts:78

"end" | "start"

(userId) => void

this


on(event, listener): this

Defined in: packages/voice/src/receiver.ts:68

Listens for a user starting or stopping to send audio.

"end" | "start"

(userId) => void

this


record(userId, options?): ReadableStream<Uint8Array<ArrayBufferLike>>

Defined in: packages/voice/src/receiver.ts:134

Records userId as an Ogg/Opus stream (48 kHz stereo) that players and FFmpeg read: write it to a file with Bun.write(path, new Response(stream)). The audio is not re-encoded. Time the user is silent is kept as silence, counted from the start of the recording, so recordings of several users started together line up.

string

RecordOptions = {}

ReadableStream<Uint8Array<ArrayBufferLike>>


ssrcOf(userId): number | undefined

Defined in: packages/voice/src/receiver.ts:58

The SSRC Discord assigned to a user, once they spoke.

string

number | undefined


subscribe(userId, options?): ReadableStream<Uint8Array<ArrayBufferLike>>

Defined in: packages/voice/src/receiver.ts:99

A stream of userId’s Opus packets. It ends after a second without audio unless end.behavior is "manual"; cancelling it unsubscribes.

string

ReceiveOptions = {}

ReadableStream<Uint8Array<ArrayBufferLike>>


unsubscribe(userId): boolean

Defined in: packages/voice/src/receiver.ts:199

Ends every stream of userId.

string

boolean

Whether there was one.