peerix - v0.8.0
    Preparing search index...

    Interface StreamEvent<M>

    Emitted when a peer shares or unshares a media stream.

    interface StreamEvent<M extends object = Metadata> {
        label: string;
        name: "stream:add" | "stream:remove";
        peer?: Peer<M>;
        stream: MediaStream;
    }

    Type Parameters

    Index
    label: string

    Label of the media stream.

    name: "stream:add" | "stream:remove"

    Name of the event.

    peer?: Peer<M>

    Peer object containing connection details. For local streams, peer is undefined.

    stream: MediaStream

    Media stream associated with the event.