API Reference
    Preparing search index...

    Interface PeerEvents

    Events emitted by Peer instances.

    interface PeerEvents {
        close: [{ channel: RTCDataChannel; remote: RemotePeer }];
        error: [{ channel?: RTCDataChannel; error: any; remote?: RemotePeer }];
        join: [{ remote: RemotePeer }];
        leave: [{ remote: RemotePeer }];
        message: [{ channel: RTCDataChannel; data: any; remote: RemotePeer }];
        open: [{ channel: RTCDataChannel; remote: RemotePeer }];
        publish: [
            { remote: RemotePeer; stream: MediaStream; track: MediaStreamTrack },
        ];
        state: [{ remote: RemotePeer; state: PeerConnectionState }];
        unpublish: [
            { remote: RemotePeer; stream: MediaStream; track?: MediaStreamTrack },
        ];
    }
    Index

    Properties

    close error join leave message open publish state unpublish

    Properties

    close: [{ channel: RTCDataChannel; remote: RemotePeer }]

    Emitted when a data channel is closed.

    error: [{ channel?: RTCDataChannel; error: any; remote?: RemotePeer }]

    Emitted when an error occurs with a remote peer connection or channel.

    join: [{ remote: RemotePeer }]

    Emitted when a remote peer creates a new connection.

    leave: [{ remote: RemotePeer }]

    Emitted when a remote peer leaves the room and disconnects.

    message: [{ channel: RTCDataChannel; data: any; remote: RemotePeer }]

    Emitted when a message is received on a data channel.

    open: [{ channel: RTCDataChannel; remote: RemotePeer }]

    Emitted when a data channel is opened.

    publish: [{ remote: RemotePeer; stream: MediaStream; track: MediaStreamTrack }]

    Emitted when a remote peer publishes a media stream.

    state: [{ remote: RemotePeer; state: PeerConnectionState }]

    Emitted when a remote peer connection state changes.

    unpublish: [
        { remote: RemotePeer; stream: MediaStream; track?: MediaStreamTrack },
    ]

    Emitted when a remote peer unpublishes a media stream.

    Settings

    Member Visibility

    On This Page

    Properties