Skip to content
Discord Luau

Connection

Coordinates a full Discord voice connection. Owns four sub-components:

  • webSocket - WebSocket lifecycle and heartbeating
  • udp - UDP socket, keepalive, and RTP audio send/receive
  • rtp - RTP encryption and sequence/timestamp/nonce counters
  • dave - DAVE E2EE MLS session and per-user key rotation

Connection handles voice signalling (Identify, Resume, SelectProtocol, Speaking), opcode dispatch, jitter buffering per SSRC, and gateway shard integration.

Consumer-facing events: onReady, onSpeaking, onClientConnect, onClientDisconnect, onDaveEpochTransition, onRawAudioFrame, onAudioFrame.

Summary

Properties

Connection.webSocket :: voiceWebsocket.WebSocketTransportConnection.udp :: voiceUdp.UdpTransportConnection.rtp :: voiceRtpCrypto.RtpCryptoConnection.dave :: voiceDaveManager.DaveManagerConnection.jitters :: { [number]: voiceJitter.Jitter }Connection.shard :: websocket.ShardConnection.guildId :: stringConnection.channelId :: stringConnection.userId :: stringConnection.sessionId :: stringConnection.token :: secret.Secret<string>Connection.endpoint :: stringConnection.onConnected :: emitter.Emitter<()>Connection.onDisconnected :: emitter.Emitter<number?, boolean?>Connection.onReady :: emitter.Emitter<()>Connection.onHeartbeat :: emitter.Emitter<number?>Connection.onRawMessage :: emitter.Emitter<apiTypes.Payload<unknown>>Connection.onSpeaking :: emitter.Emitter<{ userId: string, ssrc: number, speaking: number }>Connection.onClientConnect :: emitter.Emitter<{ userId: string }>Connection.onClientDisconnect :: emitter.Emitter<{ userId: string }>Connection.onDaveEpochTransition :: emitter.Emitter<number>Connection.onRawAudioFrame :: emitter.Emitter<{ userId: string?, ssrc: number, frame: buffer }>Connection.onAudioFrame :: emitter.Emitter<{ userId: string?, ssrc: number, frame: buffer }>Connection.logger :: logger.Logger

Methods

Connection:sendAsync(data: string | buffer)Connection:connectAsync()Connection:forceClose(code: number?)Connection:forceClose(code: number?)Connection:reconnectAsync()Connection:requestVoiceAsync()Connection:setSpeakingAsync(speakingFlags: number)Connection:sendOpusAsync(audioFrame: buffer)

Properties

Section titled “Properties”

webSocket

Section titled “webSocket”
Connection.webSocket  :: WebSocketTransport

udp

Section titled “udp”
Connection.udp  :: UdpTransport

rtp

Section titled “rtp”
Connection.rtp  :: RtpCrypto

dave

Section titled “dave”
Connection.dave  :: DaveManager

jitters

Section titled “jitters”
Connection.jitters  :: {
{ [number]: voiceJitter.Jitter } }

shard

Section titled “shard”
Connection.shard  :: Shard

guildId

Section titled “guildId”
Connection.guildId  :: string

channelId

Section titled “channelId”
Connection.channelId  :: string

userId

Section titled “userId”
Connection.userId  :: string

sessionId

Section titled “sessionId”
Connection.sessionId  :: string

token

Section titled “token”
Connection.token  :: Secret<string>

endpoint

Section titled “endpoint”
Connection.endpoint  :: string

onConnected

Section titled “onConnected”
Connection.onConnected  :: Emitter<()>

onDisconnected

Section titled “onDisconnected”
Connection.onDisconnected  :: Emitter<number?, boolean?>

onReady

Section titled “onReady”
Connection.onReady  :: Emitter<()>

onHeartbeat

Section titled “onHeartbeat”
Connection.onHeartbeat  :: Emitter<number?>

onRawMessage

Section titled “onRawMessage”
Connection.onRawMessage  :: Payload<unknown>

onSpeaking

Section titled “onSpeaking”
Connection.onSpeaking  :: Emitter<{ userId: string, ssrc: number, speaking: number }>

onClientConnect

Section titled “onClientConnect”
Connection.onClientConnect  :: Emitter<{ userId: string }>

onClientDisconnect

Section titled “onClientDisconnect”
Connection.onClientDisconnect  :: Emitter<{ userId: string }>

onDaveEpochTransition

Section titled “onDaveEpochTransition”
Connection.onDaveEpochTransition  :: Emitter<number>

onRawAudioFrame

Section titled “onRawAudioFrame”
Connection.onRawAudioFrame  :: Emitter<{ userId: string?, ssrc: number, frame: buffer }>

Fires for each decoded audio frame before Opus decoding. frame is the fully decrypted RTP packet (12-byte RTP header + Opus payload) with all encryption layers (DAVE E2EE and RTP encryption) already removed. Wire-level ciphertext is never exposed.

onAudioFrame

Section titled “onAudioFrame”
Connection.onAudioFrame  :: Emitter<{ userId: string?, ssrc: number, frame: buffer }>

logger

Section titled “logger”
Connection.logger  :: Logger

Methods

Section titled “Methods”

sendAsync

Section titled “sendAsync”
Connection : sendAsync ( data )  -> ()

Sends a raw message to the voice gateway WebSocket.

Parameters

data: string | buffer

connectAsync

Section titled “connectAsync”
Connection : connectAsync ( )  -> ()

Opens the voice WebSocket connection. Session state is preserved when resuming.

forceClose

Section titled “forceClose”
Connection : forceClose ( code )  -> ()

Closes the voice WebSocket connection with an optional close code.

Parameters

code: number?

forceClose

Section titled “forceClose”
Connection : forceClose ( code )  -> ()

Synchronously closes the voice connection and cleans up all session state. Safe to call from a signal handler or any context where yielding is not permitted.

Parameters

code: number?

reconnectAsync

Section titled “reconnectAsync”
Connection : reconnectAsync ( )  -> ()

Disconnects and reconnects the voice WebSocket. Concurrent reconnect attempts are rejected.

requestVoiceAsync

Section titled “requestVoiceAsync”
Connection : requestVoiceAsync ( )  -> ()

Sends a VOICE_STATE_UPDATE to the gateway shard to request a voice server for this channel.

setSpeakingAsync

Section titled “setSpeakingAsync”
Connection : setSpeakingAsync ( speakingFlags )  -> ()

Sets the bot’s speaking state. Pass a bitmask of speaking flags (Microphone = 1, Soundshare = 2, Priority = 4).

Parameters

speakingFlags: number

sendOpusAsync

Section titled “sendOpusAsync”
Connection : sendOpusAsync ( audioFrame )  -> ()

Encrypts and sends a raw Opus audio frame over UDP.

Parameters

audioFrame: buffer