mediasoup-client 3.6.59 → 3.6.60

package/src/RtpParameters.ts

@@ -1,326 +0,0 @@
-/**
- * The RTP capabilities define what mediasoup or an endpoint can receive at
- * media level.
- */
-
-export type RtpCapabilities =
-{
-	/**
-	 * Supported media and RTX codecs.
-	 */
-	codecs?: RtpCodecCapability[];
-	/**
-	 * Supported RTP header extensions.
-	 */
-	headerExtensions?: RtpHeaderExtension[];
-}
-
-/**
- * Media kind ('audio' or 'video').
- */
-export type MediaKind = 'audio' | 'video';
-
-/**
- * Provides information on the capabilities of a codec within the RTP
- * capabilities. The list of media codecs supported by mediasoup and their
- * settings is defined in the supportedRtpCapabilities.ts file.
- *
- * Exactly one RtpCodecCapability will be present for each supported combination
- * of parameters that requires a distinct value of preferredPayloadType. For
- * example:
- *
- * - Multiple H264 codecs, each with their own distinct 'packetization-mode' and
- *   'profile-level-id' values.
- * - Multiple VP9 codecs, each with their own distinct 'profile-id' value.
- *
- * RtpCodecCapability entries in the mediaCodecs array of RouterOptions do not
- * require preferredPayloadType field (if unset, mediasoup will choose a random
- * one). If given, make sure it's in the 96-127 range.
- */
-export type RtpCodecCapability =
-{
-	/**
-	 * Media kind.
-	 */
-	kind: MediaKind;
-	/**
-	 * The codec MIME media type/subtype (e.g. 'audio/opus', 'video/VP8').
-	 */
-	mimeType: string;
-	/**
-	 * The preferred RTP payload type.
-	 */
-	preferredPayloadType?: number;
-	/**
-	 * Codec clock rate expressed in Hertz.
-	 */
-	clockRate: number;
-	/**
-	 * The number of channels supported (e.g. two for stereo). Just for audio.
-	 * Default 1.
-	 */
-	channels?: number;
-	/**
-	 * Codec specific parameters. Some parameters (such as 'packetization-mode'
-	 * and 'profile-level-id' in H264 or 'profile-id' in VP9) are critical for
-	 * codec matching.
-	 */
-	parameters?: any;
-	/**
-	 * Transport layer and codec-specific feedback messages for this codec.
-	 */
-	rtcpFeedback?: RtcpFeedback[];
-}
-
-/**
- * Direction of RTP header extension.
- */
-export type RtpHeaderExtensionDirection = 'sendrecv' | 'sendonly' | 'recvonly' | 'inactive';
-
-/**
- * Provides information relating to supported header extensions. The list of
- * RTP header extensions supported by mediasoup is defined in the
- * supportedRtpCapabilities.ts file.
- *
- * mediasoup does not currently support encrypted RTP header extensions. The
- * direction field is just present in mediasoup RTP capabilities (retrieved via
- * router.rtpCapabilities or mediasoup.getSupportedRtpCapabilities()). It's
- * ignored if present in endpoints' RTP capabilities.
- */
-export type RtpHeaderExtension =
-{
-	/**
-	 * Media kind.
-	 */
-	kind: MediaKind;
-	/*
-	 * The URI of the RTP header extension, as defined in RFC 5285.
-	 */
-	uri: string;
-	/**
-	 * The preferred numeric identifier that goes in the RTP packet. Must be
-	 * unique.
-	 */
-	preferredId: number;
-	/**
-	 * If true, it is preferred that the value in the header be encrypted as per
-	 * RFC 6904. Default false.
-	 */
-	preferredEncrypt?: boolean;
-	/**
-	 * If 'sendrecv', mediasoup supports sending and receiving this RTP extension.
-	 * 'sendonly' means that mediasoup can send (but not receive) it. 'recvonly'
-	 * means that mediasoup can receive (but not send) it.
-	 */
-	direction?: RtpHeaderExtensionDirection;
-}
-
-/**
- * The RTP send parameters describe a media stream received by mediasoup from
- * an endpoint through its corresponding mediasoup Producer. These parameters
- * may include a mid value that the mediasoup transport will use to match
- * received RTP packets based on their MID RTP extension value.
- *
- * mediasoup allows RTP send parameters with a single encoding and with multiple
- * encodings (simulcast). In the latter case, each entry in the encodings array
- * must include a ssrc field or a rid field (the RID RTP extension value). Check
- * the Simulcast and SVC sections for more information.
- *
- * The RTP receive parameters describe a media stream as sent by mediasoup to
- * an endpoint through its corresponding mediasoup Consumer. The mid value is
- * unset (mediasoup does not include the MID RTP extension into RTP packets
- * being sent to endpoints).
- *
- * There is a single entry in the encodings array (even if the corresponding
- * producer uses simulcast). The consumer sends a single and continuous RTP
- * stream to the endpoint and spatial/temporal layer selection is possible via
- * consumer.setPreferredLayers().
- *
- * As an exception, previous bullet is not true when consuming a stream over a
- * PipeTransport, in which all RTP streams from the associated producer are
- * forwarded verbatim through the consumer.
- *
- * The RTP receive parameters will always have their ssrc values randomly
- * generated for all of its  encodings (and optional rtx: { ssrc: XXXX } if the
- * endpoint supports RTX), regardless of the original RTP send parameters in
- * the associated producer. This applies even if the producer's encodings have
- * rid set.
- */
-export type RtpParameters =
-{
-	/**
-	 * The MID RTP extension value as defined in the BUNDLE specification.
-	 */
-	mid?: string;
-	/**
-	 * Media and RTX codecs in use.
-	 */
-	codecs: RtpCodecParameters[];
-	/**
-	 * RTP header extensions in use.
-	 */
-	headerExtensions?: RtpHeaderExtensionParameters[];
-	/**
-	 * Transmitted RTP streams and their settings.
-	 */
-	encodings?: RtpEncodingParameters[];
-	/**
-	 * Parameters used for RTCP.
-	 */
-	rtcp?: RtcpParameters;
-}
-
-/**
- * Provides information on codec settings within the RTP parameters. The list
- * of media codecs supported by mediasoup and their settings is defined in the
- * supportedRtpCapabilities.ts file.
- */
-export type RtpCodecParameters =
-{
-	/**
-	 * The codec MIME media type/subtype (e.g. 'audio/opus', 'video/VP8').
-	 */
-	mimeType: string;
-	/**
-	 * The value that goes in the RTP Payload Type Field. Must be unique.
-	 */
-	payloadType: number;
-	/**
-	 * Codec clock rate expressed in Hertz.
-	 */
-	clockRate: number;
-	/**
-	 * The number of channels supported (e.g. two for stereo). Just for audio.
-	 * Default 1.
-	 */
-	channels?: number;
-	/**
-	 * Codec-specific parameters available for signaling. Some parameters (such
-	 * as 'packetization-mode' and 'profile-level-id' in H264 or 'profile-id' in
-	 * VP9) are critical for codec matching.
-	 */
-	parameters?: any;
-	/**
-	 * Transport layer and codec-specific feedback messages for this codec.
-	 */
-	rtcpFeedback?: RtcpFeedback[];
-}
-
-/**
- * Provides information on RTCP feedback messages for a specific codec. Those
- * messages can be transport layer feedback messages or codec-specific feedback
- * messages. The list of RTCP feedbacks supported by mediasoup is defined in the
- * supportedRtpCapabilities.ts file.
- */
-export type RtcpFeedback =
-{
-	/**
-	 * RTCP feedback type.
-	 */
-	type: string;
-	/**
-	 * RTCP feedback parameter.
-	 */
-	parameter?: string;
-}
-
-/**
- * Provides information relating to an encoding, which represents a media RTP
- * stream and its associated RTX stream (if any).
- */
-export type RtpEncodingParameters =
-{
-	/**
-	 * The media SSRC.
-	 */
-	ssrc?: number;
-	/**
-	 * The RID RTP extension value. Must be unique.
-	 */
-	rid?: string;
-	/**
-	 * Codec payload type this encoding affects. If unset, first media codec is
-	 * chosen.
-	 */
-	codecPayloadType?: number;
-	/**
-	 * RTX stream information. It must contain a numeric ssrc field indicating
-	 * the RTX SSRC.
-	 */
-	rtx?: { ssrc: number };
-	/**
-	 * It indicates whether discontinuous RTP transmission will be used. Useful
-	 * for audio (if the codec supports it) and for video screen sharing (when
-	 * static content is being transmitted, this option disables the RTP
-	 * inactivity checks in mediasoup). Default false.
-	 */
-	dtx?: boolean;
-	/**
-	 * Number of spatial and temporal layers in the RTP stream (e.g. 'L1T3').
-	 * See webrtc-svc.
-	 */
-	scalabilityMode?: string;
-	/**
-	 * Others.
-	 */
-	scaleResolutionDownBy?: number;
-	maxBitrate?: number;
-	maxFramerate?: number;
-	adaptivePtime?: boolean;
-	priority?: 'very-low' | 'low' | 'medium' | 'high';
-	networkPriority?: 'very-low' | 'low' | 'medium' | 'high';
-}
-
-/**
- * Defines a RTP header extension within the RTP parameters. The list of RTP
- * header extensions supported by mediasoup is defined in the
- * supportedRtpCapabilities.ts file.
- *
- * mediasoup does not currently support encrypted RTP header extensions and no
- * parameters are currently considered.
- */
-export type RtpHeaderExtensionParameters =
-{
-	/**
-	 * The URI of the RTP header extension, as defined in RFC 5285.
-	 */
-	uri: string;
-	/**
-	 * The numeric identifier that goes in the RTP packet. Must be unique.
-	 */
-	id: number;
-	/**
-	 * If true, the value in the header is encrypted as per RFC 6904. Default false.
-	 */
-	encrypt?: boolean;
-	/**
-	 * Configuration parameters for the header extension.
-	 */
-	parameters?: any;
-}
-
-/**
- * Provides information on RTCP settings within the RTP parameters.
- *
- * If no cname is given in a producer's RTP parameters, the mediasoup transport
- * will choose a random one that will be used into RTCP SDES messages sent to
- * all its associated consumers.
- *
- * mediasoup assumes reducedSize to always be true.
- */
-export type RtcpParameters =
-{
-	/**
-	 * The Canonical Name (CNAME) used by RTCP (e.g. in SDES messages).
-	 */
-	cname?: string;
-	/**
-	 * Whether reduced size RTCP RFC 5506 is configured (if true) or compound RTCP
-	 * as specified in RFC 3550 (if false). Default true.
-	 */
-	reducedSize?: boolean;
-	/**
-	 * Whether RTCP-mux is used. Default true.
-	 */
-	mux?: boolean;
-}

package/src/SctpParameters.ts

@@ -1,74 +0,0 @@
-export type SctpCapabilities =
-{
-  numStreams: NumSctpStreams;
-}
-
-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;
-	/**
-	 * A label which can be used to distinguish this DataChannel from others.
-	 */
-	label?: string;
-	/**
-	 * Name of the sub-protocol used by this DataChannel.
-	 */
-	protocol?: string;
-}