@livedigital/client 2.0.0 → 2.1.1

package/dist/types/common.d.ts

@@ -21,6 +21,12 @@ export declare type ProducerData = {
     peerId: string;
     label: TrackLabel;
 };
+export declare type ConsumerData = {
+    producerData: ProducerData;
+    peerId: string;
+    appId: string;
+    channelId: string;
+};
 export declare type Role = 'audience' | 'host';
 export declare type PeerResponse = {
     id: string;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"
@@ -43,7 +43,7 @@
   "dependencies": {
     "axios": "^0.21.4",
     "debug": "^4.3.1",
-    "mediasoup-client": "^3.6.42",
+    "mediasoup-client": "^3.6.50",
     "qs": "^6.9.6",
     "serialize-error": "^7.0.1",
     "socket.io-client": "^4.3.0"

package/src/engine/Peer.ts

@@ -14,21 +14,20 @@ import {
   ChangePreferredLayersPayload,
   Role,
 } from '../types/common';
-import Consumer from './media/Consumer';
-import VideoConsumer from './media/VideoConsumer';
 import EnhancedEventEmitter from '../EnhancedEventEmitter';
 import Engine from './index';
 import { MEDIASOUP_EVENTS, PEER_EVENTS } from '../constants/events';
 import Logger from './Logger';
 import PeerProducer from './PeerProducer';
+import PeerConsumer from './PeerConsumer';
 
 interface PeerConstructor {
   id: string;
   channelIds: string[];
   appId: string;
   producers: ProducerData[],
-  videoConsumer?: VideoConsumer;
-  audioConsumer?: Consumer;
+  videoConsumer?: PeerConsumer;
+  audioConsumer?: PeerConsumer;
   engine: Engine;
   soundLevel?: number;
   loginDate: Date;
@@ -60,7 +59,7 @@ class Peer {
 
   private producers: Map<string, PeerProducer> = new Map();
 
-  private consumers: Map<string, Consumer | VideoConsumer> = new Map();
+  private consumers: Map<string, PeerConsumer> = new Map();
 
   private readonly engine: Engine;
 
@@ -130,7 +129,7 @@ class Peer {
 
   public async setMinResolution(consumerId: string): Promise<void> {
     const consumer = this.consumers.get(consumerId);
-    if (!(consumer instanceof VideoConsumer) || consumer.spatialLayers === 0) {
+    if (!consumer?.isVideo || consumer.spatialLayers === 0) {
       return;
     }
 
@@ -139,7 +138,7 @@ class Peer {
 
   public async setMediumResolution(consumerId: string): Promise<void> {
     const consumer = this.consumers.get(consumerId);
-    if (!(consumer instanceof VideoConsumer) || consumer.spatialLayers === 0) {
+    if (!consumer?.isVideo || consumer.spatialLayers === 0) {
       return;
     }
 
@@ -151,7 +150,7 @@ class Peer {
 
   public async setMaxResolution(consumerId: string): Promise<void> {
     const consumer = this.consumers.get(consumerId);
-    if (!(consumer instanceof VideoConsumer) || consumer.spatialLayers === 0) {
+    if (!consumer?.isVideo || consumer.spatialLayers === 0) {
       return;
     }
 
@@ -250,13 +249,7 @@ class Peer {
       const consumer = await transport.consume(remoteConsumer);
       await this.engine.network.socket.request(MEDIASOUP_EVENTS.resumeConsumer, { consumerId: consumer.id });
 
-      if (producer.kind === 'audio') {
-        this.consumers.set(consumer.id, new Consumer(consumer));
-      }
-
-      if (producer.kind === 'video') {
-        this.consumers.set(consumer.id, new VideoConsumer(consumer));
-      }
+      this.consumers.set(consumer.id, new PeerConsumer(consumer));
 
       this.logger.debug(`Subscribed for ${producer.kind}`, { peer: this });
       this.observer.safeEmit(PEER_EVENTS.trackStart, {
@@ -272,7 +265,7 @@ class Peer {
   }
 
   private async changeConsumerPreferredLayers(
-    consumer: VideoConsumer,
+    consumer: PeerConsumer,
     { spatialLayer, temporalLayer }: PreferredLayersParams,
   ): Promise<void> {
     try {
@@ -448,7 +441,7 @@ class Peer {
 
     this.observer.on(MEDIASOUP_EVENTS.consumerChangePreferredLayers, (payload: ChangePreferredLayersPayload) => {
       const consumer = this.consumers.get(payload.consumerId);
-      if (consumer instanceof VideoConsumer) {
+      if (consumer?.isVideo) {
         consumer.setCurrentTemporalLayer(payload.temporalLayer);
         consumer.setCurrentSpatialLayer(payload.spatialLayer);
       }
@@ -476,7 +469,7 @@ class Peer {
     return ConnectionQuality.GOOD;
   }
 
-  public getAllConsumers(): Consumer[] {
+  public getAllConsumers(): PeerConsumer[] {
     return Array.from(this.consumers.values());
   }
 

package/src/engine/PeerConsumer.ts

@@ -0,0 +1,98 @@
+import { parseScalabilityMode } from 'mediasoup-client';
+import { MediaKind } from 'mediasoup-client/lib/RtpParameters';
+import { Consumer as MediasoupConsumer } from 'mediasoup-client/lib/types';
+import { ConsumerData } from '../types/common';
+import Logger from './Logger';
+
+class PeerConsumer {
+  public score = 10;
+
+  public producerScore = 10;
+
+  public spatialLayers = 0;
+
+  public temporalLayers = 0;
+
+  public currentSpatialLayer = 0;
+
+  public currentTemporalLayer = 0;
+
+  readonly id: string;
+
+  readonly kind: MediaKind;
+
+  readonly producerId: string;
+
+  readonly appData: ConsumerData;
+
+  private readonly consumer: MediasoupConsumer;
+
+  private readonly logger: Logger;
+
+  constructor(consumer: MediasoupConsumer) {
+    this.id = consumer.id;
+    this.kind = consumer.kind as MediaKind;
+    this.producerId = consumer.producerId;
+    this.appData = consumer.appData as ConsumerData;
+    this.consumer = consumer;
+    this.logger = new Logger('PeerConsumer');
+  }
+
+  get paused() {
+    return this.consumer.paused;
+  }
+
+  pause() {
+    return this.consumer.pause();
+  }
+
+  resume() {
+    return this.consumer.resume();
+  }
+
+  close() {
+    return this.consumer.close();
+  }
+
+  get isVideo(): boolean {
+    return this.kind === 'video';
+  }
+
+  get isAudio(): boolean {
+    return this.kind === 'audio';
+  }
+
+  parseScalabilityMode(): void {
+    if (this.consumer.rtpParameters.encodings) {
+      const { scalabilityMode } = this.consumer.rtpParameters.encodings[0];
+      const { spatialLayers, temporalLayers } = parseScalabilityMode(scalabilityMode);
+      this.spatialLayers = spatialLayers;
+      this.temporalLayers = temporalLayers;
+      this.logger.debug('parseScalabilityMode()', {
+        scalabilityMode,
+        spatialLayers,
+        temporalLayers,
+      });
+    }
+  }
+
+  setCurrentSpatialLayer(currentSpatialLayer: number): void {
+    if (this.kind !== 'video') {
+      throw new Error('setCurrentSpatialLayer applies to video consumers only');
+    }
+
+    this.currentSpatialLayer = currentSpatialLayer;
+    this.logger.debug('setCurrentSpatialLayer()', { currentSpatialLayer });
+  }
+
+  setCurrentTemporalLayer(currentTemporalLayer: number): void {
+    if (this.kind !== 'video') {
+      throw new Error('setCurrentTemporalLayer applies to video consumers only');
+    }
+
+    this.currentTemporalLayer = currentTemporalLayer;
+    this.logger.debug('setCurrentTemporalLayer()', { currentTemporalLayer });
+  }
+}
+
+export default PeerConsumer;

package/src/engine/network/index.ts

@@ -135,7 +135,7 @@ class Network {
       }
     });
 
-    this.sendTransport.observer.on(MEDIASOUP_EVENTS.transportStateChange, (state: RTCPeerConnectionState) => {
+    this.sendTransport.on(MEDIASOUP_EVENTS.transportStateChange, (state: RTCPeerConnectionState) => {
       this.logger.debug('sendTransport.state', { state });
       if (state === 'failed') {
         if (this.sendTransport) {
@@ -178,7 +178,7 @@ class Network {
       }
     });
 
-    this.receiveTransport.observer.on(MEDIASOUP_EVENTS.transportStateChange, (state: RTCPeerConnectionState) => {
+    this.receiveTransport.on(MEDIASOUP_EVENTS.transportStateChange, (state: RTCPeerConnectionState) => {
       this.logger.debug('receiveTransport.state', { state });
       if (state === 'failed') {
         if (this.receiveTransport) {

package/src/types/common.ts

@@ -30,6 +30,13 @@ export type ProducerData = {
   label: TrackLabel,
 };
 
+export type ConsumerData = {
+  producerData: ProducerData,
+  peerId: string,
+  appId: string,
+  channelId: string,
+};
+
 export type Role = 'audience' | 'host';
 
 export type PeerResponse = {

package/dist/engine/media/Consumer.d.ts

@@ -1,6 +0,0 @@
-import { Consumer as MediasoupConsumer } from 'mediasoup-client/lib/types';
-declare class Consumer extends MediasoupConsumer {
-    score: number;
-    producerScore: number;
-}
-export default Consumer;

package/dist/engine/media/VideoConsumer.d.ts

@@ -1,14 +0,0 @@
-import { Consumer as MediasoupConsumer } from 'mediasoup-client/lib/types';
-import Consumer from './Consumer';
-declare class VideoConsumer extends Consumer {
-    spatialLayers: number;
-    temporalLayers: number;
-    currentSpatialLayer: number;
-    currentTemporalLayer: number;
-    private readonly logger;
-    constructor(consumer: MediasoupConsumer);
-    parseScalabilityMode(): void;
-    setCurrentSpatialLayer(currentSpatialLayer: number): void;
-    setCurrentTemporalLayer(currentTemporalLayer: number): void;
-}
-export default VideoConsumer;

package/src/engine/media/Consumer.ts

@@ -1,9 +0,0 @@
-import { Consumer as MediasoupConsumer } from 'mediasoup-client/lib/types';
-
-class Consumer extends MediasoupConsumer {
-  public score = 10;
-
-  public producerScore = 10;
-}
-
-export default Consumer;

package/src/engine/media/VideoConsumer.ts

@@ -1,48 +0,0 @@
-import { Consumer as MediasoupConsumer } from 'mediasoup-client/lib/types';
-import { parseScalabilityMode } from 'mediasoup-client';
-import Consumer from './Consumer';
-import Logger from '../Logger';
-
-class VideoConsumer extends Consumer {
-  public spatialLayers = 0;
-
-  public temporalLayers = 0;
-
-  public currentSpatialLayer = 0;
-
-  public currentTemporalLayer = 0;
-
-  private readonly logger: Logger;
-
-  constructor(consumer: MediasoupConsumer) {
-    super(consumer);
-    this.logger = new Logger('VideoConsumer');
-    this.parseScalabilityMode();
-  }
-
-  parseScalabilityMode(): void {
-    if (this.rtpParameters.encodings) {
-      const { scalabilityMode } = this.rtpParameters.encodings[0];
-      const { spatialLayers, temporalLayers } = parseScalabilityMode(scalabilityMode);
-      this.spatialLayers = spatialLayers;
-      this.temporalLayers = temporalLayers;
-      this.logger.debug('parseScalabilityMode()', {
-        scalabilityMode,
-        spatialLayers,
-        temporalLayers,
-      });
-    }
-  }
-
-  setCurrentSpatialLayer(currentSpatialLayer: number): void {
-    this.currentSpatialLayer = currentSpatialLayer;
-    this.logger.debug('setCurrentSpatialLayer()', { currentSpatialLayer });
-  }
-
-  setCurrentTemporalLayer(currentTemporalLayer: number): void {
-    this.currentTemporalLayer = currentTemporalLayer;
-    this.logger.debug('setCurrentTemporalLayer()', { currentTemporalLayer });
-  }
-}
-
-export default VideoConsumer;