mediasoup-client 3.6.53 → 3.6.56

package/lib/handlers/Safari12.js

@@ -66,6 +66,7 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
             }
             catch (error) { }
         }
+        this.emit('@close');
     }
     async getNativeRtpCapabilities() {
         logger.debug('getNativeRtpCapabilities()');
@@ -284,6 +285,36 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
         await this._pc.setRemoteDescription(answer);
         this._mapMidTransceiver.delete(localId);
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async pauseSending(localId) {
+        this._assertSendDirection();
+        logger.debug('pauseSending() [localId:%s]', localId);
+        const transceiver = this._mapMidTransceiver.get(localId);
+        if (!transceiver)
+            throw new Error('associated RTCRtpTransceiver not found');
+        transceiver.direction = 'inactive';
+        const offer = await this._pc.createOffer();
+        logger.debug('pauseSending() | calling pc.setLocalDescription() [offer:%o]', offer);
+        await this._pc.setLocalDescription(offer);
+        const answer = { type: 'answer', sdp: this._remoteSdp.getSdp() };
+        logger.debug('pauseSending() | calling pc.setRemoteDescription() [answer:%o]', answer);
+        await this._pc.setRemoteDescription(answer);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async resumeSending(localId) {
+        this._assertSendDirection();
+        logger.debug('resumeSending() [localId:%s]', localId);
+        const transceiver = this._mapMidTransceiver.get(localId);
+        if (!transceiver)
+            throw new Error('associated RTCRtpTransceiver not found');
+        transceiver.direction = 'sendonly';
+        const offer = await this._pc.createOffer();
+        logger.debug('resumeSending() | calling pc.setLocalDescription() [offer:%o]', offer);
+        await this._pc.setLocalDescription(offer);
+        const answer = { type: 'answer', sdp: this._remoteSdp.getSdp() };
+        logger.debug('resumeSending() | calling pc.setRemoteDescription() [answer:%o]', answer);
+        await this._pc.setRemoteDescription(answer);
+    }
     async replaceTrack(localId, track) {
         this._assertSendDirection();
         if (track) {
@@ -437,20 +468,24 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
         }
         return results;
     }
-    async stopReceiving(localId) {
+    async stopReceiving(localIds) {
         this._assertRecvDirection();
-        logger.debug('stopReceiving() [localId:%s]', localId);
-        const transceiver = this._mapMidTransceiver.get(localId);
-        if (!transceiver)
-            throw new Error('associated RTCRtpTransceiver not found');
-        this._remoteSdp.closeMediaSection(transceiver.mid);
+        for (const localId of localIds) {
+            logger.debug('stopReceiving() [localId:%s]', localId);
+            const transceiver = this._mapMidTransceiver.get(localId);
+            if (!transceiver)
+                throw new Error('associated RTCRtpTransceiver not found');
+            this._remoteSdp.closeMediaSection(transceiver.mid);
+        }
         const offer = { type: 'offer', sdp: this._remoteSdp.getSdp() };
         logger.debug('stopReceiving() | calling pc.setRemoteDescription() [offer:%o]', offer);
         await this._pc.setRemoteDescription(offer);
         const answer = await this._pc.createAnswer();
         logger.debug('stopReceiving() | calling pc.setLocalDescription() [answer:%o]', answer);
         await this._pc.setLocalDescription(answer);
-        this._mapMidTransceiver.delete(localId);
+        for (const localId of localIds) {
+            this._mapMidTransceiver.delete(localId);
+        }
     }
     async pauseReceiving(localIds) {
         this._assertRecvDirection();

package/lib/index.d.ts

@@ -8,7 +8,7 @@ export { types };
 /**
  * Expose mediasoup-client version.
  */
-export declare const version = "3.6.53";
+export declare const version = "3.6.56";
 /**
  * Expose Device class and detectDevice() helper.
  */

package/lib/index.js

@@ -37,7 +37,7 @@ exports.types = types;
 /**
  * Expose mediasoup-client version.
  */
-exports.version = '3.6.53';
+exports.version = '3.6.56';
 /**
  * Expose parseScalabilityMode() function.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasoup-client",
-  "version": "3.6.53",
+  "version": "3.6.56",
   "description": "mediasoup client side JavaScript library",
   "contributors": [
     "Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -49,11 +49,11 @@
   "devDependencies": {
     "@types/sdp-transform": "^2.4.5",
     "@types/uuid": "^3.4.9",
-    "@typescript-eslint/eslint-plugin": "^5.30.0",
-    "@typescript-eslint/parser": "^5.30.0",
-    "eslint": "^8.18.0",
-    "eslint-plugin-jest": "^26.5.3",
-    "jest": "^28.1.2",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "eslint": "^8.22.0",
+    "eslint-plugin-jest": "^26.8.3",
+    "jest": "^28.1.3",
     "jest-tobetype": "^1.2.3",
     "open-cli": "^7.0.1",
     "tsc-watch": "^5.0.3",

package/src/Consumer.ts

@@ -260,6 +260,13 @@ export class Consumer extends EnhancedEventEmitter<ConsumerEvents>
 			return;
 		}
 
+		if (this._paused)
+		{
+			logger.debug('pause() | Consumer is already paused');
+
+			return;
+		}
+
 		this._paused = true;
 		this._track.enabled = false;
 
@@ -283,6 +290,13 @@ export class Consumer extends EnhancedEventEmitter<ConsumerEvents>
 			return;
 		}
 
+		if (!this._paused)
+		{
+			logger.debug('resume() | Consumer is already resumed');
+
+			return;
+		}
+
 		this._paused = false;
 		this._track.enabled = true;
 

package/src/EnhancedEventEmitter.ts

@@ -109,7 +109,7 @@ export class EnhancedEventEmitter<E extends Events = Events> extends EventEmitte
 		return this;
 	}
 
-	removeAllListeners<K extends keyof E & string>(eventName: K): this
+	removeAllListeners<K extends keyof E & string>(eventName?: K): this
 	{
 		super.removeAllListeners(eventName);
 

package/src/Producer.ts

@@ -41,6 +41,14 @@ export type ProducerEvents =
 	transportclose: [];
 	trackended: [];
 	// Private events.
+	'@pause': [
+		() => void,
+		(error: Error) => void
+	];
+	'@resume': [
+		() => void,
+		(error: Error) => void
+	];
 	'@replacetrack':
 	[
 		MediaStreamTrack | null,
@@ -331,8 +339,7 @@ export class Producer extends EnhancedEventEmitter<ProducerEvents>
 			new Promise<void>((resolve, reject) =>
 			{
 				this.safeEmit(
-					'@replacetrack',
-					null,
+					'@pause',
 					resolve,
 					reject
 				);
@@ -369,8 +376,7 @@ export class Producer extends EnhancedEventEmitter<ProducerEvents>
 			new Promise<void>((resolve, reject) =>
 			{
 				this.safeEmit(
-					'@replacetrack',
-					this._track,
+					'@resume',
 					resolve,
 					reject
 				);

package/src/Transport.ts

@@ -232,6 +232,10 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 	private _pendingResumeConsumers: Map<string, Consumer> = new Map();
 	// Consumer resume in progress flag.
 	private _consumerResumeInProgress = false;
+	// Consumers pending to be closed.
+	private _pendingCloseConsumers: Map<string, Consumer> = new Map();
+	// Consumer close in progress flag.
+	private _consumerCloseInProgress = false;
 	// Observer instance.
 	protected readonly _observer = new EnhancedEventEmitter<TransportObserverEvents>();
 
@@ -821,10 +825,17 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 	// This method is guaranteed to never throw.
 	async _createPendingConsumers(): Promise<void>
 	{
+		this._consumerCreationInProgress = true;
+
 		this._awaitQueue.push(
 			async () =>
 			{
-				this._consumerCreationInProgress = true;
+				if (this._pendingConsumerTasks.length === 0)
+				{
+					logger.debug('_createPendingConsumers() | there is no Consumer to be created');
+
+					return;
+				}
 
 				const pendingConsumerTasks = [ ...this._pendingConsumerTasks ];
 
@@ -919,12 +930,12 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 							error);
 					}
 				}
-
-				this._consumerCreationInProgress = false;
 			},
 			'transport._createPendingConsumers()')
 			.then(() =>
 			{
+				this._consumerCreationInProgress = false;
+
 				// There are pending Consumer tasks, enqueue their creation.
 				if (this._pendingConsumerTasks.length > 0)
 				{
@@ -937,10 +948,17 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 
 	_pausePendingConsumers()
 	{
+		this._consumerPauseInProgress = true;
+
 		this._awaitQueue.push(
 			async () =>
 			{
-				this._consumerPauseInProgress = true;
+				if (this._pendingPauseConsumers.size === 0)
+				{
+					logger.debug('_pausePendingConsumers() | there is no Consumer to be paused');
+
+					return;
+				}
 
 				const pendingPauseConsumers = Array.from(this._pendingPauseConsumers.values());
 
@@ -949,20 +967,21 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 
 				try
 				{
-					await this._handler.pauseReceiving(
-						pendingPauseConsumers.map((consumer) => consumer.localId)
-					);
+					const localIds = pendingPauseConsumers
+						.map((consumer) => consumer.localId);
+
+					await this._handler.pauseReceiving(localIds);
 				}
 				catch (error)
 				{
 					logger.error('_pausePendingConsumers() | failed to pause Consumers:', error);
 				}
-
-				this._consumerPauseInProgress = false;
 			},
-			'consumer @pause event')
+			'transport._pausePendingConsumers')
 			.then(() =>
 			{
+				this._consumerPauseInProgress = false;
+
 				// There are pending Consumers to be paused, do it.
 				if (this._pendingPauseConsumers.size > 0)
 				{
@@ -975,10 +994,17 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 
 	_resumePendingConsumers()
 	{
+		this._consumerResumeInProgress = true;
+
 		this._awaitQueue.push(
 			async () =>
 			{
-				this._consumerResumeInProgress = true;
+				if (this._pendingResumeConsumers.size === 0)
+				{
+					logger.debug('_resumePendingConsumers() | there is no Consumer to be resumed');
+					
+					return;
+				}
 
 				const pendingResumeConsumers = Array.from(this._pendingResumeConsumers.values());
 
@@ -987,16 +1013,17 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 
 				try
 				{
-					await this._handler.resumeReceiving(
-						pendingResumeConsumers.map((consumer) => consumer.localId)
-					);
+					const localIds = pendingResumeConsumers
+						.map((consumer) => consumer.localId);
+
+					await this._handler.resumeReceiving(localIds);
 				}
 				catch (error)
 				{
 					logger.error('_resumePendingConsumers() | failed to resume Consumers:', error);
 				}
 			},
-			'consumer @resume event')
+			'transport._resumePendingConsumers')
 			.then(() =>
 			{
 				this._consumerResumeInProgress = false;
@@ -1011,6 +1038,50 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 			.catch(() => { });
 	}
 
+	_closePendingConsumers()
+	{
+		this._consumerCloseInProgress = true;
+
+		this._awaitQueue.push(
+			async () =>
+			{
+				if (this._pendingCloseConsumers.size === 0)
+				{
+					logger.debug('_closePendingConsumers() | there is no Consumer to be closed');
+					
+					return;
+				}
+
+				const pendingCloseConsumers = Array.from(this._pendingCloseConsumers.values());
+
+				// Clear pending close Consumer map.
+				this._pendingCloseConsumers.clear();
+
+				try
+				{
+					await this._handler.stopReceiving(
+						pendingCloseConsumers.map((consumer) => consumer.localId)
+					);
+				}
+				catch (error)
+				{
+					logger.error('_closePendingConsumers() | failed to close Consumers:', error);
+				}
+			},
+			'transport._closePendingConsumers')
+			.then(() =>
+			{
+				this._consumerCloseInProgress = false;
+
+				// There are pending Consumer to be resumed, do it.
+				if (this._pendingCloseConsumers.size > 0)
+				{
+					this._closePendingConsumers();
+				}
+			})
+			// NOTE: We only get here when the await queue is closed.
+			.catch(() => { });
+	}
 	_handleHandler(): void
 	{
 		const handler = this._handler;
@@ -1060,6 +1131,24 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 				.catch((error: Error) => logger.warn('producer.close() failed:%o', error));
 		});
 
+		producer.on('@pause', (callback, errback) =>
+		{
+			this._awaitQueue.push(
+				async () => this._handler.pauseSending(producer.localId),
+				'producer @pause event')
+				.then(callback)
+				.catch(errback);
+		});
+
+		producer.on('@resume', (callback, errback) =>
+		{
+			this._awaitQueue.push(
+				async () => this._handler.resumeSending(producer.localId),
+				'producer @resume event')
+				.then(callback)
+				.catch(errback);
+		});
+
 		producer.on('@replacetrack', (track, callback, errback) =>
 		{
 			this._awaitQueue.push(
@@ -1111,10 +1200,14 @@ export class Transport extends EnhancedEventEmitter<TransportEvents>
 			if (this._closed)
 				return;
 
-			this._awaitQueue.push(
-				async () => this._handler.stopReceiving(consumer.localId),
-				'consumer @close event')
-				.catch(() => {});
+			// Store the Consumer into the close list.
+			this._pendingCloseConsumers.set(consumer.id, consumer);
+
+			// There is no Consumer close in progress, do it now.
+			if (this._consumerCloseInProgress === false)
+			{
+				this._closePendingConsumers();
+			}
 		});
 
 		consumer.on('@pause', () =>

package/src/handlers/Chrome55.ts

@@ -94,6 +94,8 @@ export class Chrome55 extends HandlerInterface
 			try { this._pc.close(); }
 			catch (error) {}
 		}
+
+		this.emit('@close');
 	}
 
 	async getNativeRtpCapabilities(): Promise<RtpCapabilities>
@@ -474,6 +476,18 @@ export class Chrome55 extends HandlerInterface
 		await this._pc.setRemoteDescription(answer);
 	}
 
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async pauseSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async resumeSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
 	async replaceTrack(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
 		localId: string, track: MediaStreamTrack | null
@@ -672,19 +686,22 @@ export class Chrome55 extends HandlerInterface
 		return results;
 	}
 
-	async stopReceiving(localId: string): Promise<void>
+	async stopReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('stopReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('stopReceiving() [localId:%s]', localId);
 
-		const { mid, rtpParameters } = this._mapRecvLocalIdInfo.get(localId) || {};
+			const { mid, rtpParameters } = this._mapRecvLocalIdInfo.get(localId) || {};
 
-		// Remove from the map.
-		this._mapRecvLocalIdInfo.delete(localId);
+			// Remove from the map.
+			this._mapRecvLocalIdInfo.delete(localId);
 
-		this._remoteSdp!.planBStopReceiving(
-			{ mid: mid!, offerRtpParameters: rtpParameters! });
+			this._remoteSdp!.planBStopReceiving(
+				{ mid: mid!, offerRtpParameters: rtpParameters! });
+		}
 
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 

package/src/handlers/Chrome67.ts

@@ -95,6 +95,8 @@ export class Chrome67 extends HandlerInterface
 			try { this._pc.close(); }
 			catch (error) {}
 		}
+
+		this.emit('@close');
 	}
 
 	async getNativeRtpCapabilities(): Promise<RtpCapabilities>
@@ -482,6 +484,18 @@ export class Chrome67 extends HandlerInterface
 		await this._pc.setRemoteDescription(answer);
 	}
 
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async pauseSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async resumeSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
 	async replaceTrack(
 		localId: string, track: MediaStreamTrack | null
 	): Promise<void>
@@ -751,19 +765,22 @@ export class Chrome67 extends HandlerInterface
 		return results;
 	}
 
-	async stopReceiving(localId: string): Promise<void>
+	async stopReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('stopReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('stopReceiving() [localId:%s]', localId);
 
-		const { mid, rtpParameters } = this._mapRecvLocalIdInfo.get(localId) || {};
+			const { mid, rtpParameters } = this._mapRecvLocalIdInfo.get(localId) || {};
 
-		// Remove from the map.
-		this._mapRecvLocalIdInfo.delete(localId);
+			// Remove from the map.
+			this._mapRecvLocalIdInfo.delete(localId);
 
-		this._remoteSdp!.planBStopReceiving(
-			{ mid: mid!, offerRtpParameters: rtpParameters! });
+			this._remoteSdp!.planBStopReceiving(
+				{ mid: mid!, offerRtpParameters: rtpParameters! });
+		}
 
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 

package/src/handlers/Chrome70.ts

@@ -83,6 +83,8 @@ export class Chrome70 extends HandlerInterface
 			try { this._pc.close(); }
 			catch (error) {}
 		}
+
+		this.emit('@close');
 	}
 
 	async getNativeRtpCapabilities(): Promise<RtpCapabilities>
@@ -498,6 +500,18 @@ export class Chrome70 extends HandlerInterface
 		this._mapMidTransceiver.delete(localId);
 	}
 
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async pauseSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async resumeSending(localId: string): Promise<void>
+	{
+		// Unimplemented.
+	}
+
 	async replaceTrack(
 		localId: string, track: MediaStreamTrack | null
 	): Promise<void>
@@ -758,18 +772,21 @@ export class Chrome70 extends HandlerInterface
 		return results;
 	}
 
-	async stopReceiving(localId: string): Promise<void>
+	async stopReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('stopReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('stopReceiving() [localId:%s]', localId);
 
-		const transceiver = this._mapMidTransceiver.get(localId);
+			const transceiver = this._mapMidTransceiver.get(localId);
 
-		if (!transceiver)
-			throw new Error('associated RTCRtpTransceiver not found');
+			if (!transceiver)
+				throw new Error('associated RTCRtpTransceiver not found');
 
-		this._remoteSdp!.closeMediaSection(transceiver.mid!);
+			this._remoteSdp!.closeMediaSection(transceiver.mid!);
+		}
 
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
@@ -787,7 +804,10 @@ export class Chrome70 extends HandlerInterface
 
 		await this._pc.setLocalDescription(answer);
 
-		this._mapMidTransceiver.delete(localId);
+		for (const localId of localIds)
+		{
+			this._mapMidTransceiver.delete(localId);
+		}
 	}
 
 	async pauseReceiving(