mediasoup-client 3.6.50 → 3.6.53

package/src/DataProducer.ts

@@ -3,6 +3,8 @@ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 import { InvalidStateError } from './errors';
 import { SctpStreamParameters } from './SctpParameters';
 
+const logger = new Logger('DataProducer');
+
 export type DataProducerOptions =
 {
 	ordered?: boolean;
@@ -10,12 +12,26 @@ export type DataProducerOptions =
 	maxRetransmits?: number;
 	label?: string;
 	protocol?: string;
-	appData?: any;
+	appData?: Record<string, unknown>;
 }
 
-const logger = new Logger('DataProducer');
+export type DataProducerEvents =
+{
+	transportclose: [];
+	open: [];
+	error: [Error];
+	close: [];
+	bufferedamountlow: [];
+	// Private events.
+	'@close': [];
+}
 
-export class DataProducer extends EnhancedEventEmitter
+export type DataProducerObserverEvents =
+{
+	close: [];
+}
+
+export class DataProducer extends EnhancedEventEmitter<DataProducerEvents>
 {
 	// Id.
 	private readonly _id: string;
@@ -26,18 +42,10 @@ export class DataProducer extends EnhancedEventEmitter
 	// SCTP stream parameters.
 	private readonly _sctpStreamParameters: SctpStreamParameters;
 	// App custom data.
-	private readonly _appData: any;
+	private readonly _appData: Record<string, unknown>;
 	// Observer instance.
-	protected readonly _observer = new EnhancedEventEmitter();
+	protected readonly _observer = new EnhancedEventEmitter<DataProducerObserverEvents>();
 
-	/**
-	 * @emits transportclose
-	 * @emits open
-	 * @emits error - (error: Error)
-	 * @emits close
-	 * @emits bufferedamountlow
-	 * @emits @close
-	 */
 	constructor(
 		{
 			id,
@@ -49,7 +57,7 @@ export class DataProducer extends EnhancedEventEmitter
 			id: string;
 			dataChannel: RTCDataChannel;
 			sctpStreamParameters: SctpStreamParameters;
-			appData: any;
+			appData?: Record<string, unknown>;
 		}
 	)
 	{
@@ -60,7 +68,7 @@ export class DataProducer extends EnhancedEventEmitter
 		this._id = id;
 		this._dataChannel = dataChannel;
 		this._sctpStreamParameters = sctpStreamParameters;
-		this._appData = appData;
+		this._appData = appData || {};
 
 		this._handleDataChannel();
 	}
@@ -140,7 +148,7 @@ export class DataProducer extends EnhancedEventEmitter
 	/**
 	 * App custom data.
 	 */
-	get appData(): any
+	get appData(): Record<string, unknown>
 	{
 		return this._appData;
 	}
@@ -148,16 +156,12 @@ export class DataProducer 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');
 	}
 
-	/**
-	 * Observer.
-	 *
-	 * @emits close
-	 */
 	get observer(): EnhancedEventEmitter
 	{
 		return this._observer;

package/src/Device.ts

@@ -179,6 +179,11 @@ export function detectDevice(): BuiltinHandlerName | undefined
 	}
 }
 
+export type DeviceObserverEvents =
+{
+	newtransport: [Transport];
+}
+
 export class Device
 {
 	// RTC handler factory.
@@ -197,7 +202,7 @@ export class Device
 	// Local SCTP capabilities.
 	private _sctpCapabilities?: SctpCapabilities;
 	// Observer instance.
-	protected readonly _observer = new EnhancedEventEmitter();
+	protected readonly _observer = new EnhancedEventEmitter<DeviceObserverEvents>();
 
 	/**
 	 * Create a new Device to connect to mediasoup server.
@@ -340,11 +345,6 @@ export class Device
 		return this._sctpCapabilities!;
 	}
 
-	/**
-	 * Observer.
-	 *
-	 * @emits newtransport - (transport: Transport)
-	 */
 	get observer(): EnhancedEventEmitter
 	{
 		return this._observer;
@@ -465,7 +465,7 @@ export class Device
 			iceTransportPolicy,
 			additionalSettings,
 			proprietaryConstraints,
-			appData = {}
+			appData
 		}: TransportOptions
 	): Transport
 	{
@@ -504,7 +504,7 @@ export class Device
 			iceTransportPolicy,
 			additionalSettings,
 			proprietaryConstraints,
-			appData = {}
+			appData
 		}: TransportOptions
 	): Transport
 	{
@@ -538,7 +538,7 @@ export class Device
 			iceTransportPolicy,
 			additionalSettings,
 			proprietaryConstraints,
-			appData = {}
+			appData
 		}: InternalTransportOptions
 	): Transport
 	{

package/src/EnhancedEventEmitter.ts

@@ -3,7 +3,9 @@ import { Logger } from './Logger';
 
 const logger = new Logger('EnhancedEventEmitter');
 
-export class EnhancedEventEmitter extends EventEmitter
+type Events = Record<string, any[]>
+
+export class EnhancedEventEmitter<E extends Events = Events> extends EventEmitter
 {
 	constructor()
 	{
@@ -11,40 +13,121 @@ export class EnhancedEventEmitter extends EventEmitter
 		this.setMaxListeners(Infinity);
 	}
 
-	safeEmit(event: string, ...args: any[]): boolean
+	emit<K extends keyof E & string>(eventName: K, ...args: E[K]): boolean
+	{
+		return super.emit(eventName, ...args);
+	}
+
+	/**
+	 * Special addition to the EventEmitter API.
+	 */
+	safeEmit<K extends keyof E & string>(eventName: K, ...args: E[K]): boolean
 	{
-		const numListeners = this.listenerCount(event);
+		const numListeners = super.listenerCount(eventName);
 
 		try
 		{
-			return this.emit(event, ...args);
+			return super.emit(eventName, ...args);
 		}
 		catch (error)
 		{
 			logger.error(
-				'safeEmit() | event listener threw an error [event:%s]:%o',
-				event, error);
+				'safeEmit() | event listener threw an error [eventName:%s]:%o',
+				eventName, error);
 
 			return Boolean(numListeners);
 		}
 	}
 
-	async safeEmitAsPromise(event: string, ...args: any[]): Promise<any>
+	on<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
 	{
-		return new Promise((resolve, reject) =>
-		{
-			try
-			{
-				this.emit(event, ...args, resolve, reject);
-			}
-			catch (error)
-			{
-				logger.error(
-					'safeEmitAsPromise() | event listener threw an error [event:%s]:%o',
-					event, error);
-
-				reject(error);
-			}
-		});
+		super.on(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	off<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.off(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	addListener<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.on(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	prependListener<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.prependListener(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	once<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.once(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	prependOnceListener<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.prependOnceListener(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	removeListener<K extends keyof E & string>(
+		eventName: K,
+		listener: (...args: E[K]) => void
+	): this
+	{
+		super.off(eventName, listener as (...args: any[]) => void);
+
+		return this;
+	}
+
+	removeAllListeners<K extends keyof E & string>(eventName: K): this
+	{
+		super.removeAllListeners(eventName);
+
+		return this;
+	}
+
+	listenerCount<K extends keyof E & string>(eventName: K): number
+	{
+		return super.listenerCount(eventName);
+	}
+
+	listeners<K extends keyof E & string>(eventName: K): Function[]
+	{
+		return super.listeners(eventName);
+	}
+
+	rawListeners<K extends keyof E & string>(eventName: K): Function[]
+	{
+		return super.rawListeners(eventName);
 	}
 }

package/src/Producer.ts

@@ -8,6 +8,8 @@ import {
 	RtpEncodingParameters
 } from './RtpParameters';
 
+const logger = new Logger('Producer');
+
 export type ProducerOptions =
 {
 	track?: MediaStreamTrack;
@@ -17,7 +19,7 @@ export type ProducerOptions =
 	stopTracks?: boolean;
 	disableTrackOnPause?: boolean;
 	zeroRtpOnPause?: boolean;
-	appData?: any;
+	appData?: Record<string, unknown>;
 }
 
 // https://mediasoup.org/documentation/v3/mediasoup-client/api/#ProducerCodecOptions
@@ -34,9 +36,42 @@ export type ProducerCodecOptions =
 	videoGoogleMinBitrate?: number;
 }
 
-const logger = new Logger('Producer');
+export type ProducerEvents =
+{
+	transportclose: [];
+	trackended: [];
+	// Private events.
+	'@replacetrack':
+	[
+		MediaStreamTrack | null,
+		() => void,
+		(error: Error) => void
+	];
+	'@setmaxspatiallayer':
+	[
+		number,
+		() => void,
+		(error: Error) => void
+	];
+	'@setrtpencodingparameters':
+	[
+		RTCRtpEncodingParameters,
+		() => void,
+		(error: Error) => void
+	];
+	'@getstats': [(stats: RTCStatsReport) => void, (error: Error) => void];
+	'@close': [];
+}
 
-export class Producer extends EnhancedEventEmitter
+export type ProducerObserverEvents =
+{
+	close: [];
+	pause: [];
+	resume: [];
+	trackended: [];
+}
+
+export class Producer extends EnhancedEventEmitter<ProducerEvents>
 {
 	// Id.
 	private readonly _id: string;
@@ -63,19 +98,10 @@ export class Producer extends EnhancedEventEmitter
 	// Whether we should replace the RTCRtpSender.track with null when paused.
 	private _zeroRtpOnPause: boolean;
 	// App custom data.
-	private readonly _appData: any;
+	private readonly _appData: Record<string, unknown>;
 	// Observer instance.
-	protected readonly _observer = new EnhancedEventEmitter();
+	protected readonly _observer = new EnhancedEventEmitter<ProducerObserverEvents>();
 
-	/**
-	 * @emits transportclose
-	 * @emits trackended
-	 * @emits @replacetrack - (track: MediaStreamTrack | null)
-	 * @emits @setmaxspatiallayer - (spatialLayer: string)
-	 * @emits @setrtpencodingparameters - (params: any)
-	 * @emits @getstats
-	 * @emits @close
-	 */
 	constructor(
 		{
 			id,
@@ -97,7 +123,7 @@ export class Producer extends EnhancedEventEmitter
 			stopTracks: boolean;
 			disableTrackOnPause: boolean;
 			zeroRtpOnPause: boolean;
-			appData: any;
+			appData?: Record<string, unknown>;
 		}
 	)
 	{
@@ -116,7 +142,7 @@ export class Producer extends EnhancedEventEmitter
 		this._stopTracks = stopTracks;
 		this._disableTrackOnPause = disableTrackOnPause;
 		this._zeroRtpOnPause = zeroRtpOnPause;
-		this._appData = appData;
+		this._appData = appData || {};
 		this._onTrackEnded = this._onTrackEnded.bind(this);
 
 		// NOTE: Minor issue. If zeroRtpOnPause is true, we cannot emit the
@@ -152,7 +178,7 @@ export class Producer extends EnhancedEventEmitter
 	/**
 	 * Media kind.
 	 */
-	get kind(): string
+	get kind(): MediaKind
 	{
 		return this._kind;
 	}
@@ -202,7 +228,7 @@ export class Producer extends EnhancedEventEmitter
 	/**
 	 * App custom data.
 	 */
-	get appData(): any
+	get appData(): Record<string, unknown>
 	{
 		return this._appData;
 	}
@@ -210,19 +236,12 @@ export class Producer extends EnhancedEventEmitter
 	/**
 	 * Invalid setter.
 	 */
-	set appData(appData) // eslint-disable-line @typescript-eslint/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');
 	}
 
-	/**
-	 * Observer.
-	 *
-	 * @emits close
-	 * @emits pause
-	 * @emits resume
-	 * @emits trackended
-	 */
 	get observer(): EnhancedEventEmitter
 	{
 		return this._observer;
@@ -276,7 +295,14 @@ export class Producer extends EnhancedEventEmitter
 		if (this._closed)
 			throw new InvalidStateError('closed');
 
-		return this.safeEmitAsPromise('@getstats');
+		return new Promise<RTCStatsReport>((resolve, reject) =>
+		{
+			this.safeEmit(
+				'@getstats',
+				resolve,
+				reject
+			);
+		});
 	}
 
 	/**
@@ -302,8 +328,15 @@ export class Producer extends EnhancedEventEmitter
 
 		if (this._zeroRtpOnPause)
 		{
-			this.safeEmitAsPromise('@replacetrack', null)
-				.catch(() => {});
+			new Promise<void>((resolve, reject) =>
+			{
+				this.safeEmit(
+					'@replacetrack',
+					null,
+					resolve,
+					reject
+				);
+			}).catch(() => {});
 		}
 
 		// Emit observer event.
@@ -333,8 +366,15 @@ export class Producer extends EnhancedEventEmitter
 
 		if (this._zeroRtpOnPause)
 		{
-			this.safeEmitAsPromise('@replacetrack', this._track)
-				.catch(() => {});
+			new Promise<void>((resolve, reject) =>
+			{
+				this.safeEmit(
+					'@replacetrack',
+					this._track,
+					resolve,
+					reject
+				);
+			}).catch(() => {});
 		}
 
 		// Emit observer event.
@@ -375,7 +415,15 @@ export class Producer extends EnhancedEventEmitter
 
 		if (!this._zeroRtpOnPause || !this._paused)
 		{
-			await this.safeEmitAsPromise('@replacetrack', track);
+			await new Promise<void>((resolve, reject) =>
+			{
+				this.safeEmit(
+					'@replacetrack',
+					track,
+					resolve,
+					reject
+				);
+			});
 		}
 
 		// Destroy the previous track.
@@ -413,14 +461,19 @@ export class Producer extends EnhancedEventEmitter
 		if (spatialLayer === this._maxSpatialLayer)
 			return;
 
-		await this.safeEmitAsPromise('@setmaxspatiallayer', spatialLayer);
+		await new Promise<void>((resolve, reject) =>
+		{
+			this.safeEmit(
+				'@setmaxspatiallayer',
+				spatialLayer,
+				resolve,
+				reject
+			);
+		}).catch(() => {});
 
 		this._maxSpatialLayer = spatialLayer;
 	}
 
-	/**
-	 * Sets the DSCP value.
-	 */
 	async setRtpEncodingParameters(
 		params: RTCRtpEncodingParameters
 	): Promise<void>
@@ -430,7 +483,15 @@ export class Producer extends EnhancedEventEmitter
 		else if (typeof params !== 'object')
 			throw new TypeError('invalid params');
 
-		await this.safeEmitAsPromise('@setrtpencodingparameters', params);
+		await new Promise<void>((resolve, reject) =>
+		{
+			this.safeEmit(
+				'@setrtpencodingparameters',
+				params,
+				resolve,
+				reject
+			);
+		});
 	}
 
 	private _onTrackEnded(): void