DaveSession
Defined in: packages/voice/src/dave.ts:85
One end-to-end encrypted (DAVE) media session: the MLS group of a voice channel, its protocol transitions, and Opus frame encryption. Follows the DAVE protocol’s client flow (key package → proposals → commit/welcome → transition ready → execute).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DaveSession(
module,protocolVersion,userId,channelId,hooks):DaveSession
Defined in: packages/voice/src/dave.ts:100
Parameters
Section titled “Parameters”module
Section titled “module”DaveyModule
protocolVersion
Section titled “protocolVersion”number
userId
Section titled “userId”string
channelId
Section titled “channelId”string
Returns
Section titled “Returns”DaveSession
Properties
Section titled “Properties”protocolVersion
Section titled “protocolVersion”protocolVersion:
number
Defined in: packages/voice/src/dave.ts:86
Accessors
Section titled “Accessors”active
Section titled “active”Get Signature
Section titled “Get Signature”get active():
boolean
Defined in: packages/voice/src/dave.ts:115
Whether frames are currently end-to-end encrypted.
Returns
Section titled “Returns”boolean
voicePrivacyCode
Section titled “voicePrivacyCode”Get Signature
Section titled “Get Signature”get voicePrivacyCode():
string|null
Defined in: packages/voice/src/dave.ts:120
The voice privacy code users can compare, or null without DAVE.
Returns
Section titled “Returns”string | null
Methods
Section titled “Methods”decrypt()
Section titled “decrypt()”decrypt(
frame,userId):Uint8Array<ArrayBufferLike> |null
Defined in: packages/voice/src/dave.ts:263
Decrypts a frame from userId.
Parameters
Section titled “Parameters”Uint8Array
userId
Section titled “userId”string
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike> | null
The Opus frame, or null to drop it.
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/voice/src/dave.ts:293
Drops the MLS state.
Returns
Section titled “Returns”void
encrypt()
Section titled “encrypt()”encrypt(
frame):Uint8Array<ArrayBufferLike> |null
Defined in: packages/voice/src/dave.ts:255
End-to-end encrypts an outgoing Opus frame. Silence frames, frames without DAVE (protocol version 0) and frames during an upgrade from transport-only stay as they are.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike> | null
The frame to send, or null
to drop it: DAVE is required but the MLS group is not ready (joining, or
recovering from an invalid commit), so it must not leave unencrypted.
executeTransition()
Section titled “executeTransition()”executeTransition(
transitionId):boolean
Defined in: packages/voice/src/dave.ts:172
Op 22.
Parameters
Section titled “Parameters”transitionId
Section titled “transitionId”number
Returns
Section titled “Returns”boolean
Whether a pending transition was executed.
prepareEpoch()
Section titled “prepareEpoch()”prepareEpoch(
epoch,protocolVersion):void
Defined in: packages/voice/src/dave.ts:193
Op 24.
Parameters
Section titled “Parameters”number
protocolVersion
Section titled “protocolVersion”number
Returns
Section titled “Returns”void
prepareTransition()
Section titled “prepareTransition()”prepareTransition(
transitionId,protocolVersion):boolean
Defined in: packages/voice/src/dave.ts:154
Op 21.
Parameters
Section titled “Parameters”transitionId
Section titled “transitionId”number
protocolVersion
Section titled “protocolVersion”number
Returns
Section titled “Returns”boolean
Whether to answer with op 23 (transition ready).
process()
Section titled “process()”process(
kind,payload):object
Defined in: packages/voice/src/dave.ts:218
Op 29 (commit) or op 30 (welcome).
Parameters
Section titled “Parameters”"commit" | "welcome"
payload
Section titled “payload”Uint8Array
Returns
Section titled “Returns”object
The transition and whether it applied; a failure re-initializes.
ok:
boolean
transitionId
Section titled “transitionId”transitionId:
number
processProposals()
Section titled “processProposals()”processProposals(
payload,connectedUserIds):Uint8Array<ArrayBufferLike> |undefined
Defined in: packages/voice/src/dave.ts:203
Op 27.
Parameters
Section titled “Parameters”payload
Section titled “payload”Uint8Array
connectedUserIds
Section titled “connectedUserIds”Iterable<string>
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike> | undefined
The op 28 payload (commit, then welcome) to send, if any.
reinit()
Section titled “reinit()”reinit():
void
Defined in: packages/voice/src/dave.ts:127
(Re)creates the MLS state and announces a fresh key package.
Returns
Section titled “Returns”void
setExternalSender()
Section titled “setExternalSender()”setExternalSender(
payload):void
Defined in: packages/voice/src/dave.ts:149
Op 25.
Parameters
Section titled “Parameters”payload
Section titled “payload”Uint8Array
Returns
Section titled “Returns”void