Type Alias JoinRoomConfig<PeerMetadata>

type JoinRoomConfig<PeerMetadata extends GenericMetadata = GenericMetadata> = {
    config?: ConnectionConfig;
    fishjamId: string;
    peerMetadata?: PeerMetadata;
    peerToken: string;
}

Type Parameters

PeerMetadata extends GenericMetadata = GenericMetadata

Index

Properties

config? fishjamId peerMetadata? peerToken

Properties

`Optional`config

config?: ConnectionConfig

Additional connection configuration

fishjamId

fishjamId: string

Fishjam ID, which is used to connect to the room. You can get it at https://fishjam.io/app

`Optional`peerMetadata

peerMetadata?: PeerMetadata

String indexed record with metadata, that will be available to all other peers

peerToken

peerToken: string

Token received from server (or Room Manager)