@livedigital/client 2.24.0 → 2.25.0-add-keyframes-delay.2

package/dist/types/common.d.ts

@@ -20,6 +20,7 @@ export declare type TrackProduceParams = {
     codecOptions?: ProducerCodecOptions;
     preferredCodec?: string;
     transformParams?: TrackTransformParams;
+    keyFrameRequestDelay?: number;
 };
 export declare type TrackTransformParams = {
     width?: number;
@@ -169,6 +170,10 @@ export declare type PayloadOfPublishedMedia = {
     kind: MediaKind;
     label: TrackLabel;
 };
+export declare type SubscribeOptions = {
+    producerId: string;
+    paused?: boolean;
+};
 export declare type PayloadOfUnpublishedMedia = PayloadOfPublishedMedia;
 export declare type ChangePreferredLayersPayload = PreferredLayersParams & {
     consumerId: string;
@@ -299,3 +304,6 @@ export declare type UpdatePeerAppDataPayload = {
     peerId: string;
     appData: Record<string, unknown>;
 };
+export declare type TrackPublishParams = {
+    keyFrameRequestDelay?: number;
+};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "2.24.0",
+  "version": "2.25.0-add-keyframes-delay.2",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"

package/src/engine/Peer.ts

@@ -9,6 +9,7 @@ import {
   Role,
   ProducerSetMaxSpatialLayer,
   PeerInfo,
+  SubscribeOptions,
 } from '../types/common';
 import EnhancedEventEmitter from '../EnhancedEventEmitter';
 import Engine from './index';
@@ -118,7 +119,7 @@ class Peer {
     }));
   }
 
-  public async subscribe(producerId: string): Promise<void> {
+  public async subscribe({ producerId, paused = false }: SubscribeOptions): Promise<void> {
     try {
       const producer = this.producers.get(producerId);
       if (!producer) {
@@ -132,7 +133,7 @@ class Peer {
         return;
       }
 
-      const { consumer } = await this.engine.network.createConsumer({
+      const { consumer, isProducerPaused } = await this.engine.network.createConsumer({
         producerId: producer.id,
         rtpCapabilities: this.engine.media.mediasoupDevice.rtpCapabilities,
         producerPeerId: this.id,
@@ -147,9 +148,13 @@ class Peer {
         engine: this.engine,
         isPaused: true,
         peerEventEmitter: this.observer,
+        isProducerPaused,
       });
 
-      await track.resume();
+      if (!paused) {
+        await track.resume();
+      }
+
       this.tracks.set(track.label, track);
       this.logger.debug(`Subscribed for ${producer.kind}`, { peer: this });
     } catch (error) {
@@ -222,6 +227,7 @@ class Peer {
         return;
       }
 
+      track.setIsTrackProducerPaused(true);
       await track.pause();
     });
 
@@ -231,6 +237,7 @@ class Peer {
         return;
       }
 
+      track.setIsTrackProducerPaused(false);
       await track.resume();
     });
 

package/src/engine/index.ts

@@ -223,6 +223,12 @@ class Engine {
   }
 
   public removePeer(peerId: string): void {
+    const peer = this.peersRepository.get(peerId);
+    if (!peer) {
+      return;
+    }
+
+    peer.tracks.forEach((track) => track.close());
     this.peersRepository.delete(peerId);
   }
 

package/src/engine/media/tracks/BaseTrack.ts

@@ -212,6 +212,7 @@ class BaseTrack {
         codecOptions,
         trackTransformParams,
         preferredCodec,
+        keyFrameRequestDelay,
       },
     } = this.producer;
 
@@ -222,6 +223,7 @@ class BaseTrack {
       codecOptions,
       transformParams: trackTransformParams,
       preferredCodec,
+      keyFrameRequestDelay,
     });
 
     this.logger.debug('restartProducer()', { track: this });
@@ -257,6 +259,7 @@ class BaseTrack {
   }
 
   private async cancelProducerCheckState(): Promise<void> {
+    this.logger.debug('cancelProducerCheckState()', { track: this });
     if (this.#checkStateTimeout) {
       clearTimeout(this.#checkStateTimeout);
     }
@@ -265,7 +268,11 @@ class BaseTrack {
   }
 
   async produce({
-    encodings, codecOptions, preferredCodec, transformParams,
+    encodings,
+    codecOptions,
+    preferredCodec,
+    transformParams,
+    keyFrameRequestDelay,
   }: TrackProduceParams): Promise<void> {
     if (!this.#engine.cahPublish) {
       this.logger.error('produce()', { message: 'Not enough access to produce' });
@@ -285,6 +292,7 @@ class BaseTrack {
         codecOptions,
         preferredCodec,
         codec,
+        keyFrameRequestDelay,
       };
 
       const producer = await this.#engine.network.sendTransport?.produce({
@@ -355,6 +363,7 @@ class BaseTrack {
     }
 
     try {
+      await this.cancelProducerCheckState();
       await this.pauseRemoteProducer(this.producer.id);
       this.producer.pause();
       this.clientEventEmitter.emit(INTERNAL_CLIENT_EVENTS.trackPaused, this);
@@ -375,7 +384,7 @@ class BaseTrack {
       await this.resumeRemoteProducer(this.producer.id);
       this.producer.resume();
       this.clientEventEmitter.emit(INTERNAL_CLIENT_EVENTS.trackResumed, this);
-      this.logger.error('resume()', { track: this });
+      this.logger.debug('resume()', { track: this });
     } catch (error) {
       this.logger.error('resume()', { error, track: this });
       throw new Error('Can`t resume track');

package/src/engine/media/tracks/PeerTrack.ts

@@ -20,6 +20,7 @@ interface PeerTrackConstructor {
   consumer?: PeerConsumer,
   engine: Engine,
   isPaused: boolean,
+  isProducerPaused?: boolean,
   peerEventEmitter: EnhancedEventEmitter,
 }
 
@@ -44,6 +45,8 @@ class PeerTrack {
 
   #closed = false;
 
+  #isTrackProducerPaused?: boolean;
+
   constructor(payload: PeerTrackConstructor) {
     this.#mediaStreamTrack = payload.mediaStreamTrack;
     this.label = payload.label;
@@ -55,6 +58,7 @@ class PeerTrack {
     });
     this.#peerEventEmitter = payload.peerEventEmitter;
     this.#paused = payload.isPaused;
+    this.#isTrackProducerPaused = payload.isProducerPaused;
     this.#peerEventEmitter.safeEmit(PEER_EVENTS.trackStart, this);
   }
 
@@ -131,6 +135,11 @@ class PeerTrack {
       return;
     }
 
+    if (this.#isTrackProducerPaused) {
+      this.#logger.debug('resume()', { message: 'Can not resume track, producer is paused', track: this, peer: this });
+      return;
+    }
+
     try {
       await this.#engine.network.resumeRemoteConsumer(this.consumer.id);
       this.consumer.resume();
@@ -428,6 +437,10 @@ class PeerTrack {
 
     clearTimeout(this.#checkStateTimeout);
   }
+
+  setIsTrackProducerPaused(value: boolean): void {
+    this.#isTrackProducerPaused = value;
+  }
 }
 
 export default PeerTrack;

package/src/engine/media/tracks/VideoTrack.ts

@@ -1,7 +1,9 @@
 import { ProducerCodecOptions } from 'mediasoup-client/lib/Producer';
 import { RtpEncodingParameters } from 'mediasoup-client/lib/RtpParameters';
 import { WEBCAM_SIMULCAST_ENCODINGS } from '../../../constants/simulcastEncodings';
-import { TrackLabel, VideoCodec, VideoEncoderConfig } from '../../../types/common';
+import {
+  TrackLabel, TrackPublishParams, VideoCodec, VideoEncoderConfig,
+} from '../../../types/common';
 import BaseTrack from './BaseTrack';
 import TrackWithCodecOptions from './TrackWithCodecOptions';
 import TrackWithEncodings from './TrackWithEncodings';
@@ -65,12 +67,13 @@ class VideoTrack extends BaseTrack implements TrackWithCodecOptions, TrackWithEn
     return producer.maxSpatialLayer;
   }
 
-  async publish(): Promise<void> {
+  async publish(params: TrackPublishParams = {}): Promise<void> {
     await this.produce({
       encodings: this.getEncodings(),
       preferredCodec: this.getPreferredCodec(),
       transformParams: this.transformParams,
       codecOptions: this.getCodecOptions(),
+      keyFrameRequestDelay: params.keyFrameRequestDelay ?? 0,
     });
 
     this.clientEventEmitter.emit(INTERNAL_CLIENT_EVENTS.trackProduced, this);

package/src/types/common.ts

@@ -27,6 +27,7 @@ export type TrackProduceParams = {
   codecOptions?: ProducerCodecOptions,
   preferredCodec?: string,
   transformParams?: TrackTransformParams,
+  keyFrameRequestDelay?: number,
 };
 
 export type TrackTransformParams = {
@@ -205,6 +206,11 @@ export type PayloadOfPublishedMedia = {
   label: TrackLabel,
 };
 
+export type SubscribeOptions = {
+  producerId: string,
+  paused?: boolean,
+};
+
 export type PayloadOfUnpublishedMedia = PayloadOfPublishedMedia;
 
 export type ChangePreferredLayersPayload = PreferredLayersParams & {
@@ -343,3 +349,7 @@ export type UpdatePeerAppDataPayload = {
   peerId: string,
   appData: Record<string, unknown>,
 };
+
+export type TrackPublishParams = {
+  keyFrameRequestDelay?: number;
+};