A11 TypeScript API - v0.7.0
    Preparing search index...

    Interface SignallingMessageOptions

    Fields used to construct a SignallingMessage.

    interface SignallingMessageOptions {
        candidate?: string;
        capabilities?: readonly string[];
        description?: string;
        descriptionType?: "" | RTCSdpType;
        error?: Status;
        mid?: string;
        recipient?: string;
        sender?: string;
        type?: SignallingMessageType;
    }
    Index
    candidate? capabilities? description? descriptionType? error? mid? recipient? sender? type?
    candidate?: string

    ICE candidate line for a candidate message.

    capabilities?: readonly string[]

    Optional capability tokens the sender supports, echoed by a peer that supports them too.

    Additive and ignored by any peer that does not know a token, which is what makes a capability safe to introduce: an older peer never echoes, so the feature simply stays off rather than breaking the connection. Currently only a11-pmtud/1 (path MTU probing).

    description?: string

    SDP text for a description message.

    descriptionType?: "" | RTCSdpType

    SDP description subtype, such as offer or answer.

    error?: Status

    Non-OK A11 status for an error message.

    mid?: string

    Media/data-channel id associated with an ICE candidate.

    recipient?: string

    Identity of the peer that should consume the message.

    sender?: string

    Identity of the peer that emitted the message.

    type?: SignallingMessageType

    Control-message kind.

    Settings
    Member Visibility

    On This Page
    Properties