peerix - v0.5.0
    Preparing search index...

    Interface PeerOptions

    Configuration options for creating a Peer instance.

    interface PeerOptions {
        connectionTimeout?: number;
        driver?: Driver;
        iceCandidateDebounce?: number;
        iceServers?: IceServer[];
        iceTransportPolicy?: IceTransportPolicy;
        namespaceHashing?: boolean;
        signalingCompression?: boolean;
        signalingEncryption?: boolean;
    }
    Index

    Properties

    connectionTimeout? driver? iceCandidateDebounce? iceServers? iceTransportPolicy? namespaceHashing? signalingCompression? signalingEncryption?

    Properties

    connectionTimeout?: number

    Connection timeout in seconds. By default, it is set to 15 seconds. Use 0 to disable the timeout.

    driver?: Driver

    Signaling driver instance for message exchange between peers. If omitted, a default in-memory driver is used, which is suitable for testing purposes only.

    iceCandidateDebounce?: number

    Debounce time in milliseconds for batching ICE candidates before sending them through signaling to minimize the number of messages. By default, it is set to 50 ms.

    iceServers?: IceServer[]

    An array of objects, each describing one server which may be used by the ICE agent; these are typically STUN and/or TURN servers. If this isn't specified, the connection attempt will be made with no STUN or TURN server available, which limits the connection to local peers.

    iceServers: [{
      urls: "stun:stun.l.google.com:19302"
    }]
    iceTransportPolicy?: IceTransportPolicy

    ICE policy used by created RTCPeerConnection instances. If set to "relay", only relay candidates will be used, otherwise all candidates will be considered.

    namespaceHashing?: boolean

    Enable hashing of namespaces in signaling messages for privacy. Enabled by default.

    signalingCompression?: boolean

    Enable compression for signaling messages to reduce bandwidth usage by about 30%. Enabled by default.

    signalingEncryption?: boolean

    Encrypt signaling messages with AES-GCM for end-to-end security. Enabled by default.

    Settings

    Member Visibility

    On This Page

    Properties