Interface: RoomOptions\<TPresence\>

@roomful/core

---

@roomful/core / RoomOptions

Interface: RoomOptions<TPresence>

Defined in: packages/core/src/types.ts:420

Configures room creation.

Type Parameters

TPresence

TPresence extends PresenceData = PresenceData

The local and remote presence shape carried by the room.

Properties

debug?

optional debug: boolean | DebugOptions

Defined in: packages/core/src/types.ts:474

Enables broad debug logging or fine-grained debug flags.

---

encryption?

optional encryption: EncryptionOptions

Defined in: packages/core/src/types.ts:469

Enables payload encryption.

---

maxPeers?

optional maxPeers: number

Defined in: packages/core/src/types.ts:434

Caps the number of peers allowed in the room.

---

presence?

optional presence: Partial<TPresence>

Defined in: packages/core/src/types.ts:429

Seeds the initial local presence payload.

---

reconnect?

optional reconnect: boolean | ReconnectOptions

Defined in: packages/core/src/types.ts:454

Enables reconnect behavior or custom reconnect timing.

---

relayAuth?

optional relayAuth: RelayAuthToken

Defined in: packages/core/src/types.ts:449

Supplies relay authentication as a token or async token factory.

---

relayUrl?

optional relayUrl: string

Defined in: packages/core/src/types.ts:444

Overrides the relay URL used for signaling and fallback transports.

---

stunUrls?

optional stunUrls: string[]

Defined in: packages/core/src/types.ts:439

Supplies custom STUN server URLs for WebRTC sessions.

---

transport?

optional transport: TransportMode

Defined in: packages/core/src/types.ts:424

Selects the preferred transport strategy.

---

webrtc?

optional webrtc: WebRTCOptions

Defined in: packages/core/src/types.ts:459

Configures WebRTC-specific behavior.

---

websocket?

optional websocket: WebSocketOptions

Defined in: packages/core/src/types.ts:464

Configures WebSocket-specific behavior.