mediasoup/node/lib/SctpParameters.d.ts

Cutting Edge WebRTC Video Conferencing

import * as flatbuffers from 'flatbuffers';
import * as FbsSctpParameters from './fbs/sctp-parameters';
export type SctpCapabilities = {
    numStreams: NumSctpStreams;
};
/**
 * Both OS and MIS are part of the SCTP INIT+ACK handshake. OS refers to the
 * initial number of outgoing SCTP streams that the server side transport creates
 * (to be used by DataConsumers), while MIS refers to the maximum number of
 * incoming SCTP streams that the server side transport can receive (to be used
 * by DataProducers). So, if the server side transport will just be used to
 * create data producers (but no data consumers), OS can be low (~1). However,
 * if data consumers are desired on the server side transport, OS must have a
 * proper value and such a proper value depends on whether the remote endpoint
 * supports  SCTP_ADD_STREAMS extension or not.
 *
 * libwebrtc (Chrome, Safari, etc) does not enable SCTP_ADD_STREAMS so, if data
 * consumers are required,  OS should be 1024 (the maximum number of DataChannels
 * that libwebrtc enables).
 *
 * Firefox does enable SCTP_ADD_STREAMS so, if data consumers are required, OS
 * can be lower (16 for instance). The mediasoup transport will allocate and
 * announce more outgoing SCTM streams when needed.
 *
 * mediasoup-client provides specific per browser/version OS and MIS values via
 * the device.sctpCapabilities getter.
 */
export type NumSctpStreams = {
    /**
     * Initially requested number of outgoing SCTP streams.
     */
    OS: number;
    /**
     * Maximum number of incoming SCTP streams.
     */
    MIS: number;
};
export type SctpParameters = {
    /**
     * Must always equal 5000.
     */
    port: number;
    /**
     * Initially requested number of outgoing SCTP streams.
     */
    OS: number;
    /**
     * Maximum number of incoming SCTP streams.
     */
    MIS: number;
    /**
     * Maximum allowed size for SCTP messages.
     */
    maxMessageSize: number;
};
/**
 * SCTP stream parameters describe the reliability of a certain SCTP stream.
 * If ordered is true then maxPacketLifeTime and maxRetransmits must be
 * false.
 * If ordered if false, only one of maxPacketLifeTime or maxRetransmits
 * can be true.
 */
export type SctpStreamParameters = {
    /**
     * SCTP stream id.
     */
    streamId: number;
    /**
     * Whether data messages must be received in order. If true the messages will
     * be sent reliably. Default true.
     */
    ordered?: boolean;
    /**
     * When ordered is false indicates the time (in milliseconds) after which a
     * SCTP packet will stop being retransmitted.
     */
    maxPacketLifeTime?: number;
    /**
     * When ordered is false indicates the maximum number of times a packet will
     * be retransmitted.
     */
    maxRetransmits?: number;
};
export type SctpParametersDump = {
    port: number;
    OS: number;
    MIS: number;
    maxMessageSize: number;
    sendBufferSize: number;
    sctpBufferedAmount: number;
    isDataChannel: boolean;
};
export declare function parseSctpParametersDump(binary: FbsSctpParameters.SctpParameters): SctpParametersDump;
export declare function serializeSctpStreamParameters(builder: flatbuffers.Builder, parameters: SctpStreamParameters): number;
export declare function parseSctpStreamParameters(parameters: FbsSctpParameters.SctpStreamParameters): SctpStreamParameters;
//# sourceMappingURL=SctpParameters.d.ts.map