Interface: RoomfulPluginOptions\<TPresence\>
@roomful/vue / RoomfulPluginOptions
Interface: RoomfulPluginOptions<TPresence>
Section titled “Interface: RoomfulPluginOptions<TPresence>”Defined in: vue/src/index.ts:25
Configures the Vue plugin.
Extends
Section titled “Extends”RoomOptions<TPresence>
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape inferred from presence.
Properties
Section titled “Properties”debug?
Section titled “debug?”
optionaldebug:boolean|DebugOptions
Defined in: core/dist/types.d.ts:392
Enables broad debug logging or fine-grained debug flags.
Inherited from
Section titled “Inherited from”RoomOptions.debug
encryption?
Section titled “encryption?”
optionalencryption:EncryptionOptions
Defined in: core/dist/types.d.ts:388
Enables payload encryption.
Inherited from
Section titled “Inherited from”RoomOptions.encryption
maxPeers?
Section titled “maxPeers?”
optionalmaxPeers:number
Defined in: core/dist/types.d.ts:360
Caps the number of peers allowed in the room.
Inherited from
Section titled “Inherited from”RoomOptions.maxPeers
presence?
Section titled “presence?”
optionalpresence:Partial<TPresence>
Defined in: core/dist/types.d.ts:356
Seeds the initial local presence payload.
Inherited from
Section titled “Inherited from”RoomOptions.presence
reconnect?
Section titled “reconnect?”
optionalreconnect:boolean|ReconnectOptions
Defined in: core/dist/types.d.ts:376
Enables reconnect behavior or custom reconnect timing.
Inherited from
Section titled “Inherited from”RoomOptions.reconnect
relayAuth?
Section titled “relayAuth?”
optionalrelayAuth:RelayAuthToken
Defined in: core/dist/types.d.ts:372
Supplies relay authentication as a token or async token factory.
Inherited from
Section titled “Inherited from”RoomOptions.relayAuth
relayUrl?
Section titled “relayUrl?”
optionalrelayUrl:string
Defined in: core/dist/types.d.ts:368
Overrides the relay URL used for signaling and fallback transports.
Inherited from
Section titled “Inherited from”RoomOptions.relayUrl
roomId
Section titled “roomId”roomId:
string
Defined in: vue/src/index.ts:31
Identifies the room to create or join.
stunUrls?
Section titled “stunUrls?”
optionalstunUrls:string[]
Defined in: core/dist/types.d.ts:364
Supplies custom STUN server URLs for WebRTC sessions.
Inherited from
Section titled “Inherited from”RoomOptions.stunUrls
transport?
Section titled “transport?”
optionaltransport:TransportMode
Defined in: core/dist/types.d.ts:352
Selects the preferred transport strategy.
Inherited from
Section titled “Inherited from”RoomOptions.transport
webrtc?
Section titled “webrtc?”
optionalwebrtc:WebRTCOptions
Defined in: core/dist/types.d.ts:380
Configures WebRTC-specific behavior.
Inherited from
Section titled “Inherited from”RoomOptions.webrtc
websocket?
Section titled “websocket?”
optionalwebsocket:WebSocketOptions
Defined in: core/dist/types.d.ts:384
Configures WebSocket-specific behavior.
Inherited from
Section titled “Inherited from”RoomOptions.websocket