mediasoup-client 3.6.49 → 3.6.52

package/src/Transport.ts

@@ -48,7 +48,7 @@ export type TransportOptions =
 	iceTransportPolicy?: RTCIceTransportPolicy;
 	additionalSettings?: any;
 	proprietaryConstraints?: any;
-	appData?: any;
+	appData?: Record<string, unknown>;
 }
 
 export type CanProduceByKind =
@@ -170,7 +170,7 @@ export class Transport extends EnhancedEventEmitter
 	// Transport connection state.
 	private _connectionState: ConnectionState = 'new';
 	// App custom data.
-	private readonly _appData: any;
+	private readonly _appData: Record<string, unknown>;
 	// Map of Producers indexed by id.
 	private readonly _producers: Map<string, Producer> = new Map();
 	// Map of Consumers indexed by id.
@@ -187,6 +187,14 @@ export class Transport extends EnhancedEventEmitter
 	private _pendingConsumerTasks: ConsumerCreationTask[] = [];
 	// Consumer creation in progress flag.
 	private _consumerCreationInProgress = false;
+	// Consumers pending to be paused.
+	private _pendingPauseConsumers: Map<string, Consumer> = new Map();
+	// Consumer pause in progress flag.
+	private _consumerPauseInProgress = false;
+	// Consumers pending to be resumed.
+	private _pendingResumeConsumers: Map<string, Consumer> = new Map();
+	// Consumer resume in progress flag.
+	private _consumerResumeInProgress = false;
 	// Observer instance.
 	protected readonly _observer = new EnhancedEventEmitter();
 
@@ -251,7 +259,7 @@ export class Transport extends EnhancedEventEmitter
 				extendedRtpCapabilities
 			});
 
-		this._appData = appData;
+		this._appData = appData || {};
 
 		this._handleHandler();
 	}
@@ -299,7 +307,7 @@ export class Transport extends EnhancedEventEmitter
 	/**
 	 * App custom data.
 	 */
-	get appData(): any
+	get appData(): Record<string, unknown>
 	{
 		return this._appData;
 	}
@@ -307,7 +315,8 @@ export class Transport extends EnhancedEventEmitter
 	/**
 	 * Invalid setter.
 	 */
-	set appData(appData: any) // eslint-disable-line no-unused-vars
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	set appData(appData: Record<string, unknown>)
 	{
 		throw new Error('cannot override appData object');
 	}
@@ -892,6 +901,82 @@ export class Transport extends EnhancedEventEmitter
 			.catch(() => {});
 	}
 
+	_pausePendingConsumers()
+	{
+		this._awaitQueue.push(
+			async () =>
+			{
+				this._consumerPauseInProgress = true;
+
+				const pendingPauseConsumers = Array.from(this._pendingPauseConsumers.values());
+
+				// Clear pending pause Consumer map.
+				this._pendingPauseConsumers.clear();
+
+				try
+				{
+					await this._handler.pauseReceiving(
+						pendingPauseConsumers.map((consumer) => consumer.localId)
+					);
+				}
+				catch (error)
+				{
+					logger.error('_pausePendingConsumers() | failed to pause Consumers:', error);
+				}
+
+				this._consumerPauseInProgress = false;
+			},
+			'consumer @pause event')
+			.then(() =>
+			{
+				// There are pending Consumers to be paused, do it.
+				if (this._pendingPauseConsumers.size > 0)
+				{
+					this._pausePendingConsumers();
+				}
+			})
+			// NOTE: We only get here when the await queue is closed.
+			.catch(() => { });
+	}
+
+	_resumePendingConsumers()
+	{
+		this._awaitQueue.push(
+			async () =>
+			{
+				this._consumerResumeInProgress = true;
+
+				const pendingResumeConsumers = Array.from(this._pendingResumeConsumers.values());
+
+				// Clear pending resume Consumer map.
+				this._pendingResumeConsumers.clear();
+
+				try
+				{
+					await this._handler.resumeReceiving(
+						pendingResumeConsumers.map((consumer) => consumer.localId)
+					);
+				}
+				catch (error)
+				{
+					logger.error('_resumePendingConsumers() | failed to resume Consumers:', error);
+				}
+			},
+			'consumer @resume event')
+			.then(() =>
+			{
+				this._consumerResumeInProgress = false;
+
+				// There are pending Consumer to be resumed, do it.
+				if (this._pendingResumeConsumers.size > 0)
+				{
+					this._resumePendingConsumers();
+				}
+			})
+			// NOTE: We only get here when the await queue is closed.
+			.catch(() => { });
+	}
+
 	_handleHandler(): void
 	{
 		const handler = this._handler;
@@ -986,6 +1071,8 @@ export class Transport extends EnhancedEventEmitter
 		consumer.on('@close', () =>
 		{
 			this._consumers.delete(consumer.id);
+			this._pendingPauseConsumers.delete(consumer.id);
+			this._pendingResumeConsumers.delete(consumer.id);
 
 			if (this._closed)
 				return;
@@ -998,18 +1085,38 @@ export class Transport extends EnhancedEventEmitter
 
 		consumer.on('@pause', () =>
 		{
-			this._awaitQueue.push(
-				async () => this._handler.pauseReceiving(consumer.localId),
-				'consumer @pause event')
-				.catch(() => {});
+			// If Consumer is pending to be resumed, remove from pending resume list.
+			if (this._pendingResumeConsumers.has(consumer.id))
+			{
+				this._pendingResumeConsumers.delete(consumer.id);
+			}
+
+			// Store the Consumer into the pending list.
+			this._pendingPauseConsumers.set(consumer.id, consumer);
+
+			// There is no Consumer pause in progress, do it now.
+			if (this._consumerPauseInProgress === false)
+			{
+				this._pausePendingConsumers();
+			}
 		});
 
 		consumer.on('@resume', () =>
 		{
-			this._awaitQueue.push(
-				async () => this._handler.resumeReceiving(consumer.localId),
-				'consumer @resume event')
-				.catch(() => {});
+			// If Consumer is pending to be paused, remove from pending pause list.
+			if (this._pendingPauseConsumers.has(consumer.id))
+			{
+				this._pendingPauseConsumers.delete(consumer.id);
+			}
+
+			// Store the Consumer into the pending list.
+			this._pendingResumeConsumers.set(consumer.id, consumer);
+
+			// There is no Consumer resume in progress, do it now.
+			if (this._consumerResumeInProgress === false)
+			{
+				this._resumePendingConsumers();
+			}
 		});
 
 		consumer.on('@getstats', (callback, errback) =>

package/src/handlers/Chrome55.ts

@@ -702,17 +702,17 @@ export class Chrome55 extends HandlerInterface
 
 		await this._pc.setLocalDescription(answer);
 	}
-	
+
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Chrome67.ts

@@ -784,14 +784,14 @@ export class Chrome67 extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Chrome70.ts

@@ -669,6 +669,7 @@ export class Chrome70 extends HandlerInterface
 		this._assertRecvDirection();
 
 		const results: HandlerReceiveResult[] = [];
+		const mapLocalId: Map<string, string> = new Map();
 
 		for (const options of optionsList)
 		{
@@ -678,6 +679,8 @@ export class Chrome70 extends HandlerInterface
 
 			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
 
+			mapLocalId.set(trackId, localId);
+
 			this._remoteSdp!.receive(
 				{
 					mid                : localId,
@@ -701,8 +704,8 @@ export class Chrome70 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId, rtpParameters } = options;
+			const localId = mapLocalId.get(trackId);
 			const answerMediaObject = localSdpObject.media
 				.find((m: any) => String(m.mid) === localId);
 
@@ -734,8 +737,8 @@ export class Chrome70 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId } = options;
+			const localId = mapLocalId.get(trackId)!;
 			const transceiver = this._pc.getTransceivers()
 				.find((t: RTCRtpTransceiver) => t.mid === localId);
 
@@ -789,14 +792,14 @@ export class Chrome70 extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Chrome74.ts

@@ -655,6 +655,7 @@ export class Chrome74 extends HandlerInterface
 		this._assertRecvDirection();
 
 		const results: HandlerReceiveResult[] = [];
+		const mapLocalId: Map<string, string> = new Map();
 
 		for (const options of optionsList)
 		{
@@ -664,6 +665,8 @@ export class Chrome74 extends HandlerInterface
 
 			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
 
+			mapLocalId.set(trackId, localId);
+
 			this._remoteSdp!.receive(
 				{
 					mid                : localId,
@@ -687,8 +690,8 @@ export class Chrome74 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId, rtpParameters } = options;
+			const localId = mapLocalId.get(trackId);
 			const answerMediaObject = localSdpObject.media
 				.find((m: any) => String(m.mid) === localId);
 
@@ -720,8 +723,8 @@ export class Chrome74 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId } = options;
+			const localId = mapLocalId.get(trackId)!;
 			const transceiver = this._pc.getTransceivers()
 				.find((t: RTCRtpTransceiver) => t.mid === localId);
 
@@ -777,19 +780,22 @@ export class Chrome74 extends HandlerInterface
 		this._mapMidTransceiver.delete(localId);
 	}
 
-	async pauseReceiving(localId: string): Promise<void>
+	async pauseReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('pauseReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('pauseReceiving() [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');
+
+			transceiver.direction = 'inactive';
+		}
 
-		transceiver.direction = 'inactive';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(
@@ -807,19 +813,22 @@ export class Chrome74 extends HandlerInterface
 		await this._pc.setLocalDescription(answer);
 	}
 
-	async resumeReceiving(localId: string): Promise<void>
+	async resumeReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('resumeReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('resumeReceiving() [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');
+
+			transceiver.direction = 'recvonly';
+		}
 
-		transceiver.direction = 'recvonly';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(

package/src/handlers/Edge11.ts

@@ -440,14 +440,14 @@ export class Edge11 extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/FakeHandler.ts

@@ -358,14 +358,14 @@ export class FakeHandler extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Firefox60.ts

@@ -650,6 +650,7 @@ export class Firefox60 extends HandlerInterface
 		this._assertRecvDirection();
 
 		const results: HandlerReceiveResult[] = [];
+		const mapLocalId: Map<string, string> = new Map();
 
 		for (const options of optionsList)
 		{
@@ -659,6 +660,8 @@ export class Firefox60 extends HandlerInterface
 
 			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
 
+			mapLocalId.set(trackId, localId);
+
 			this._remoteSdp!.receive(
 				{
 					mid                : localId,
@@ -682,8 +685,8 @@ export class Firefox60 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId, rtpParameters } = options;
+			const localId = mapLocalId.get(trackId);
 			const answerMediaObject = localSdpObject.media
 				.find((m: any) => String(m.mid) === localId);
 
@@ -709,8 +712,8 @@ export class Firefox60 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId } = options;
+			const localId = mapLocalId.get(trackId)!;
 			const transceiver = this._pc.getTransceivers()
 				.find((t: RTCRtpTransceiver) => t.mid === localId);
 
@@ -762,19 +765,22 @@ export class Firefox60 extends HandlerInterface
 		this._mapMidTransceiver.delete(localId);
 	}
 
-	async pauseReceiving(localId: string): Promise<void>
+	async pauseReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('pauseReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('pauseReceiving() [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');
+
+			transceiver.direction = 'inactive';
+		}
 
-		transceiver.direction = 'inactive';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(
@@ -792,19 +798,22 @@ export class Firefox60 extends HandlerInterface
 		await this._pc.setLocalDescription(answer);
 	}
 
-	async resumeReceiving(localId: string): Promise<void>
+	async resumeReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('resumeReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('resumeReceiving() [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');
+
+			transceiver.direction = 'recvonly';
+		}
 
-		transceiver.direction = 'recvonly';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(

package/src/handlers/HandlerInterface.ts

@@ -141,9 +141,9 @@ export abstract class HandlerInterface extends EnhancedEventEmitter
 
 	abstract stopReceiving(localId: string): Promise<void>;
 
-	abstract pauseReceiving(localId: string): Promise<void>;
+	abstract pauseReceiving(localIds: string[]): Promise<void>;
 
-	abstract resumeReceiving(localId: string): Promise<void>;
+	abstract resumeReceiving(localIds: string[]): Promise<void>;
 
 	abstract getReceiverStats(localId: string): Promise<RTCStatsReport>;
 

package/src/handlers/ReactNative.ts

@@ -725,14 +725,14 @@ export class ReactNative extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Safari11.ts

@@ -790,14 +790,14 @@ export class Safari11 extends HandlerInterface
 
 	async pauseReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}
 
 	async resumeReceiving(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		localId: string): Promise<void>
+		localIds: string[]): Promise<void>
 	{
 		// Unimplemented.
 	}

package/src/handlers/Safari12.ts

@@ -609,6 +609,7 @@ export class Safari12 extends HandlerInterface
 		this._assertRecvDirection();
 
 		const results: HandlerReceiveResult[] = [];
+		const mapLocalId: Map<string, string> = new Map();
 
 		for (const options of optionsList)
 		{
@@ -618,6 +619,8 @@ export class Safari12 extends HandlerInterface
 
 			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
 
+			mapLocalId.set(trackId, localId);
+
 			this._remoteSdp!.receive(
 				{
 					mid                : localId,
@@ -641,8 +644,8 @@ export class Safari12 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId, rtpParameters } = options;
+			const localId = mapLocalId.get(trackId);
 			const answerMediaObject = localSdpObject.media
 				.find((m: any) => String(m.mid) === localId);
 
@@ -674,8 +677,8 @@ export class Safari12 extends HandlerInterface
 
 		for (const options of optionsList)
 		{
-			const { rtpParameters } = options;
-			const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+			const { trackId } = options;
+			const localId = mapLocalId.get(trackId)!;
 			const transceiver = this._pc.getTransceivers()
 				.find((t: RTCRtpTransceiver) => t.mid === localId);
 
@@ -727,19 +730,22 @@ export class Safari12 extends HandlerInterface
 		this._mapMidTransceiver.delete(localId);
 	}
 
-	async pauseReceiving(localId: string): Promise<void>
+	async pauseReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('pauseReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('pauseReceiving() [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');
+
+			transceiver.direction = 'inactive';
+		}
 
-		transceiver.direction = 'inactive';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(
@@ -757,19 +763,22 @@ export class Safari12 extends HandlerInterface
 		await this._pc.setLocalDescription(answer);
 	}
 
-	async resumeReceiving(localId: string): Promise<void>
+	async resumeReceiving(localIds: string[]): Promise<void>
 	{
 		this._assertRecvDirection();
 
-		logger.debug('resumeReceiving() [localId:%s]', localId);
+		for (const localId of localIds)
+		{
+			logger.debug('resumeReceiving() [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');
+
+			transceiver.direction = 'recvonly';
+		}
 
-		transceiver.direction = 'recvonly';
-		
 		const offer = { type: 'offer', sdp: this._remoteSdp!.getSdp() };
 
 		logger.debug(