peerix - v0.1.0
    Preparing search index...

    Interface PeerOptions

    Configuration options for creating a Peer instance.

    interface PeerOptions {
        connectionTimeout?: number;
        driver?: Driver;
        iceServers?: IceServer[];
        iceTransportPolicy?: IceTransportPolicy;
        id?: string;
        signalingCompression?: boolean;
        signalingEncryptionKey?: string;
        signalingHashing?: boolean;
    }
    Index

    Properties

    connectionTimeout? driver? iceServers? iceTransportPolicy? id? signalingCompression? signalingEncryptionKey? signalingHashing?

    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.

    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.

    id?: string

    Unique peer identifier. A random UUID is generated when omitted.

    signalingCompression?: boolean

    Compress signaling messages to reduce bandwidth usage by about 30%. Enabled by default.

    signalingEncryptionKey?: string

    Encrypt signaling messages with AES-GCM using the provided encryption key. Disabled by default.

    signalingHashing?: boolean

    Hash namespaces in signaling messages for privacy. Disabled by default.

    Settings

    Member Visibility

    On This Page

    Properties