VoiceUdp
Defined in: packages/voice/src/udp.ts:63
The voice UDP socket: sends audio to the voice server, receives other
users’ audio, runs IP discovery and a keepalive every 5 s. close() ends
the socket and its timer; nothing is left open.
Accessors
Section titled “Accessors”closed
Section titled “closed”Get Signature
Section titled “Get Signature”get closed():
boolean
Defined in: packages/voice/src/udp.ts:100
Whether close() was called.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: packages/voice/src/udp.ts:169
Closes the socket and stops the keepalive. Safe to call twice.
Returns
Section titled “Returns”void
discover()
Section titled “discover()”discover(
ssrc,timeoutMs?):Promise<{ip:string;port:number; }>
Defined in: packages/voice/src/udp.ts:121
Asks the voice server for our external address.
Parameters
Section titled “Parameters”number
timeoutMs?
Section titled “timeoutMs?”number = DISCOVERY_TIMEOUT_MS
Returns
Section titled “Returns”Promise<{ ip: string; port: number; }>
Throws
Section titled “Throws”On timeout or when closed.
onPacket()
Section titled “onPacket()”onPacket(
listener): () =>void
Defined in: packages/voice/src/udp.ts:105
Listens for datagrams.
Parameters
Section titled “Parameters”listener
Section titled “listener”(packet) => void
Returns
Section titled “Returns”A function that removes the listener.
() => void
send()
Section titled “send()”send(
packet):boolean
Defined in: packages/voice/src/udp.ts:111
Sends one datagram to the voice server.
Parameters
Section titled “Parameters”packet
Section titled “packet”Uint8Array
Returns
Section titled “Returns”boolean
Whether it was handed to the socket.
open()
Section titled “open()”
staticopen(ip,port,factory?):Promise<VoiceUdp>
Defined in: packages/voice/src/udp.ts:86
Opens a socket towards the voice server at ip:port.
Parameters
Section titled “Parameters”string
number
factory?
Section titled “factory?”UdpSocketFactory = bunUdpSocket
Returns
Section titled “Returns”Promise<VoiceUdp>