Skip to main content

Interface: RoomConfig

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:958

Room configuration

Export

RoomConfig

Properties

maxPeers?

optional maxPeers: null | number

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:964

Maximum amount of peers allowed into the room

Memberof

RoomConfig


peerDisconnectedTimeout?

optional peerDisconnectedTimeout: null | number

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:970

Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.

Memberof

RoomConfig


peerlessPurgeTimeout?

optional peerlessPurgeTimeout: null | number

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:976

Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.

Memberof

RoomConfig


roomType?

optional roomType: RoomConfigRoomTypeEnum

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:982

The use-case of the room. If not provided, this defaults to full_feature.

Memberof

RoomConfig


videoCodec?

optional videoCodec: null | RoomConfigVideoCodecEnum

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:988

Enforces video codec for each peer in the room

Memberof

RoomConfig


webhookUrl?

optional webhookUrl: null | string

Defined in: packages/js-server-sdk/packages/fishjam-openapi/dist/index.d.ts:994

URL where Fishjam notifications will be sent

Memberof

RoomConfig