Interface RoomConfig

Room configuration

Export

RoomConfig

interface RoomConfig {
    maxPeers?: null | number;
    peerDisconnectedTimeout?: null | number;
    peerlessPurgeTimeout?: null | number;
    roomType?: RoomConfigRoomTypeEnum;
    videoCodec?: null | RoomConfigVideoCodecEnum;
    webhookUrl?: null | string;
}

Properties

maxPeers? peerDisconnectedTimeout? peerlessPurgeTimeout? roomType? videoCodec? webhookUrl?

Properties

OptionalmaxPeers

maxPeers?: null | number

Maximum amount of peers allowed into the room

Memberof

RoomConfig

OptionalpeerDisconnectedTimeout

peerDisconnectedTimeout?: null | number

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

Memberof

RoomConfig

OptionalpeerlessPurgeTimeout

peerlessPurgeTimeout?: null | number

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

Memberof

RoomConfig

OptionalroomType

roomType?: RoomConfigRoomTypeEnum

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

Memberof

RoomConfig

OptionalvideoCodec

videoCodec?: null | RoomConfigVideoCodecEnum

Enforces video codec for each peer in the room

Memberof

RoomConfig

OptionalwebhookUrl

webhookUrl?: null | string

URL where Fishjam notifications will be sent

Memberof

RoomConfig

Settings

Member Visibility

On This Page

Properties