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

    Interface WebRtcConfiguration

    ICE, data-channel, and resource options for one WebRTC connection.

    interface WebRtcConfiguration {
        channelSplitSize?: number;
        dataChannelOptions?: RTCDataChannelInit;
        desiredChannels?: number;
        maxBufferedAmount?: number;
        maxMessageSize?: number | null;
        peerConnectionFactory?: PeerConnectionFactory;
        rtcConfiguration?: RTCConfiguration;
        stunServers?: readonly string[];
        turnServers?: readonly TurnServer[];
    }
    Index
    channelSplitSize? dataChannelOptions? desiredChannels? maxBufferedAmount? maxMessageSize? peerConnectionFactory? rtcConfiguration? stunServers? turnServers?
    channelSplitSize?: number

    A11 packet size; keep this below practical SCTP message limits.

    dataChannelOptions?: RTCDataChannelInit

    Client data-channel options; ordered defaults to true but may be overridden.

    desiredChannels?: number

    Data channels the client opens per connection and keeps replenished. Striping A11 packets across several channels lets slow per-channel acknowledgement round-trips overlap; the stream still behaves as one ordered, reliable channel. Defaults to 8.

    maxBufferedAmount?: number

    Abort when the data channel buffers more than this many bytes.

    maxMessageSize?: number | null

    Maximum complete data-channel message, or null to use A11's ceiling.

    peerConnectionFactory?: PeerConnectionFactory

    Custom peer-connection constructor when no browser global is available.

    rtcConfiguration?: RTCConfiguration

    Additional native RTCPeerConnection configuration.

    stunServers?: readonly string[]

    STUN URLs used for public candidate discovery.

    turnServers?: readonly TurnServer[]

    TURN relays used when a direct path cannot be established.

    Settings
    Member Visibility

    On This Page
    Properties