Skip to main content

Interface: JoinParams

Represents the parameters required to join a room.

Properties​

cipher?​

readonly optional cipher: SetupCipherSettings

Cipher configuration used to encrypt data sent via ODIN. When defined, end-to-end encryption (E2E) is enabled for the data transmission. This ensures that the data remains confidential and secure between the sender and receiver.

Optional. If not specified, encryption is not applied.

Defined in​

ari/lib/api/room/types.d.ts:40

gateway​

readonly gateway: string

The address of the gateway.

Defined in​

ari/lib/api/room/types.d.ts:20

position?​

readonly optional position: [number, number, number]

The position of the own peer.

Defined in​

ari/lib/api/room/types.d.ts:28

roomId?​

readonly optional roomId: string

The id of the room.

Defined in​

ari/lib/api/room/types.d.ts:32

transport?​

readonly optional transport: Transport

Specifies the protocol to be used for establishing the connection. Supported protocols are:

  • H3: HTTP/3, suitable for environments where low-latency and reliable transport is required.
  • WebRTC: Web Real-Time Communication that is supported in all major browsers.

Ensure to select the appropriate protocol based on your application's requirements.

Defined in​

ari/lib/api/room/types.d.ts:49

userData?​

readonly optional userData: Uint8Array

The UserData of the own peer.

Defined in​

ari/lib/api/room/types.d.ts:24