Add new rtpObserver.type getter than returns `'activespeaker' | 'au…

…diolevel'`
versatica · Nov 11, 2024 · b882b2c · b882b2c
1 parent 9e2b2bc
commit b882b2c
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 16 deletions.
diff --git a/node/src/ActiveSpeakerObserver.ts b/node/src/ActiveSpeakerObserver.ts
@@ -28,9 +28,6 @@ export class ActiveSpeakerObserverImpl<
 	>
 	implements RtpObserver, ActiveSpeakerObserver
 {
-	/**
-	 * @private
-	 */
 	constructor(
 		options: RtpObserverObserverConstructorOptions<ActiveSpeakerObserverAppData>
 	) {
@@ -43,11 +40,10 @@ export class ActiveSpeakerObserverImpl<
 		this.handleListenerError();
 	}
 
-	/**
-	 * Observer.
-	 *
-	 * @override
-	 */
+	get type(): 'activespeaker' {
+		return 'activespeaker';
+	}
+
 	get observer(): ActiveSpeakerObserverObserver {
 		return super.observer;
 	}

diff --git a/node/src/ActiveSpeakerObserverTypes.ts b/node/src/ActiveSpeakerObserverTypes.ts
@@ -43,6 +43,13 @@ export interface ActiveSpeakerObserver<
 		ActiveSpeakerObserverEvents,
 		ActiveSpeakerObserverObserver
 	> {
+	/**
+	 * RtpObserver type.
+	 *
+	 * @override
+	 */
+	get type(): 'activespeaker';
+
 	/**
 	 * Observer.
 	 *

diff --git a/node/src/AudioLevelObserver.ts b/node/src/AudioLevelObserver.ts
@@ -30,9 +30,6 @@ export class AudioLevelObserverImpl<
 	>
 	implements RtpObserver, AudioLevelObserver
 {
-	/**
-	 * @private
-	 */
 	constructor(
 		options: AudioLevelObserverConstructorOptions<AudioLevelObserverAppData>
 	) {
@@ -45,11 +42,10 @@ export class AudioLevelObserverImpl<
 		this.handleListenerError();
 	}
 
-	/**
-	 * Observer.
-	 *
-	 * @override
-	 */
+	get type(): 'audiolevel' {
+		return 'audiolevel';
+	}
+
 	get observer(): AudioLevelObserverObserver {
 		return super.observer;
 	}

diff --git a/node/src/AudioLevelObserverTypes.ts b/node/src/AudioLevelObserverTypes.ts
@@ -65,6 +65,13 @@ export interface AudioLevelObserver<
 		AudioLevelObserverEvents,
 		AudioLevelObserverObserver
 	> {
+	/**
+	 * RtpObserver type.
+	 *
+	 * @override
+	 */
+	get type(): 'audiolevel';
+
 	/**
 	 * Observer.
 	 *

diff --git a/node/src/RtpObserverTypes.ts b/node/src/RtpObserverTypes.ts
@@ -2,6 +2,11 @@ import type { EnhancedEventEmitter } from './enhancedEvents';
 import type { Producer } from './ProducerTypes';
 import type { AppData } from './types';
 
+/**
+ * RtpObserver type.
+ */
+export type RtpObserverType = 'audiolevel' | 'activespeaker';
+
 export type RtpObserverEvents = {
 	routerclose: [];
 	listenererror: [string, Error];
@@ -35,6 +40,15 @@ export interface RtpObserver<
 	 */
 	get closed(): boolean;
 
+	/**
+	 * RtpObserver type.
+	 *
+	 * @virtual
+	 * @privateRemarks
+	 * - It's marked as virtual getter since each RtpObserver class overrides it.
+	 */
+	get type(): RtpObserverType;
+
 	/**
 	 * Whether the RtpObserver is paused.
 	 */

diff --git a/node/src/test/test-ActiveSpeakerObserver.ts b/node/src/test/test-ActiveSpeakerObserver.ts
@@ -48,6 +48,7 @@ test('router.createActiveSpeakerObserver() succeeds', async () => {
 	expect(onObserverNewRtpObserver).toHaveBeenCalledWith(activeSpeakerObserver);
 	expect(typeof activeSpeakerObserver.id).toBe('string');
 	expect(activeSpeakerObserver.closed).toBe(false);
+	expect(activeSpeakerObserver.type).toBe('activespeaker');
 	expect(activeSpeakerObserver.paused).toBe(false);
 	expect(activeSpeakerObserver.appData).toEqual({});
 

diff --git a/node/src/test/test-AudioLevelObserver.ts b/node/src/test/test-AudioLevelObserver.ts
@@ -48,6 +48,7 @@ test('router.createAudioLevelObserver() succeeds', async () => {
 	expect(onObserverNewRtpObserver).toHaveBeenCalledWith(audioLevelObserver);
 	expect(typeof audioLevelObserver.id).toBe('string');
 	expect(audioLevelObserver.closed).toBe(false);
+	expect(audioLevelObserver.type).toBe('audiolevel');
 	expect(audioLevelObserver.paused).toBe(false);
 	expect(audioLevelObserver.appData).toEqual({});